DescribeTypeOutput

public struct DescribeTypeOutput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    The Amazon Resource Name (ARN) of the type.

    Declaration

    Swift

    public let arn: String?

  • The ID of the default version of the type. The default version is used when the type version is not specified. To set the default version of a type, use SetTypeDefaultVersion .

    Declaration

    Swift

    public let defaultVersionId: String?

  • The deprecation status of the type. Valid values include: LIVE: The type is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

    Declaration

    Swift

    public let deprecatedStatus: DeprecatedStatus?

  • The description of the registered type.

    Declaration

    Swift

    public let description: String?

  • The URL of a page providing detailed documentation for this type.

    Declaration

    Swift

    public let documentationUrl: String?

  • The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

    Declaration

    Swift

    public let executionRoleArn: String?

  • Whether the specified type version is set as the default version.

    Declaration

    Swift

    public let isDefaultVersion: Bool?

  • When the specified type version was registered.

    Declaration

    Swift

    public let lastUpdated: TimeStamp?

  • Contains logging configuration information for a type.

    Declaration

    Swift

    public let loggingConfig: LoggingConfig?

  • The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include: FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations. IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. NON_PROVISIONABLE: The type does not include all of the following handlers, and therefore cannot actually be provisioned. create read delete

    Declaration

    Swift

    public let provisioningType: ProvisioningType?

  • The schema that defines the type. For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

    Declaration

    Swift

    public let schema: String?

  • The URL of the source code for the type.

    Declaration

    Swift

    public let sourceUrl: String?

  • When the specified type version was registered.

    Declaration

    Swift

    public let timeCreated: TimeStamp?

  • The kind of type. Currently the only valid value is RESOURCE.

    Declaration

    Swift

    public let type: RegistryType?

  • The name of the registered type.

    Declaration

    Swift

    public let typeName: String?

  • The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. PUBLIC: The type is publically visible and usable within any Amazon account.

    Declaration

    Swift

    public let visibility: Visibility?

  • Undocumented

    Declaration

    Swift

    public init(arn: String? = nil, defaultVersionId: String? = nil, deprecatedStatus: DeprecatedStatus? = nil, description: String? = nil, documentationUrl: String? = nil, executionRoleArn: String? = nil, isDefaultVersion: Bool? = nil, lastUpdated: TimeStamp? = nil, loggingConfig: LoggingConfig? = nil, provisioningType: ProvisioningType? = nil, schema: String? = nil, sourceUrl: String? = nil, timeCreated: TimeStamp? = nil, type: RegistryType? = nil, typeName: String? = nil, visibility: Visibility? = nil)