Amazonka.CloudFormation.DescribeType

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Creating a Request

data DescribeType

See: newDescribeType smart constructor.

Constructors

DescribeType'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the extension.

  Conditional: You must specify either TypeName and Type, or Arn.

• publicVersionNumber :: Maybe Text

  The version number of a public third-party extension.

• publisherId :: Maybe Text

  The publisher ID of the extension publisher.

  Extensions provided by Amazon Web Services are not assigned a publisher ID.

• type' :: Maybe RegistryType

  The kind of extension.

  Conditional: You must specify either TypeName and Type, or Arn.

• typeName :: Maybe Text

  The name of the extension.

  Conditional: You must specify either TypeName and Type, or Arn.

• versionId :: Maybe Text

  The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

  If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Instances

ToHeaders DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

toHeaders :: DescribeType -> [Header]

ToPath DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

toPath :: DescribeType -> ByteString

ToQuery DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

toQuery :: DescribeType -> QueryString

AWSRequest DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type AWSResponse DescribeType

Methods

request :: (Service -> Service) -> DescribeType -> Request DescribeType

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeType)))

Generic DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type Rep DescribeType :: Type -> Type

Methods

from :: DescribeType -> Rep DescribeType x

to :: Rep DescribeType x -> DescribeType

Read DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

readsPrec :: Int -> ReadS DescribeType

readList :: ReadS [DescribeType]

readPrec :: ReadPrec DescribeType

readListPrec :: ReadPrec [DescribeType]

Show DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

showsPrec :: Int -> DescribeType -> ShowS

show :: DescribeType -> String

showList :: [DescribeType] -> ShowS

NFData DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

rnf :: DescribeType -> ()

Eq DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

(==) :: DescribeType -> DescribeType -> Bool

(/=) :: DescribeType -> DescribeType -> Bool

Hashable DescribeType

Defined in Amazonka.CloudFormation.DescribeType

Methods

hashWithSalt :: Int -> DescribeType -> Int

hash :: DescribeType -> Int

type AWSResponse DescribeType

Defined in Amazonka.CloudFormation.DescribeType

type AWSResponse DescribeType = DescribeTypeResponse

type Rep DescribeType

Defined in Amazonka.CloudFormation.DescribeType

type Rep DescribeType = D1 ('MetaData "DescribeType" "Amazonka.CloudFormation.DescribeType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeType :: DescribeType

Create a value of DescribeType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeType, describeType_arn - The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

DescribeType, describeType_publicVersionNumber - The version number of a public third-party extension.

DescribeType, describeType_publisherId - The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

DescribeType, describeType_type - The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

DescribeType, describeType_typeName - The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

DescribeType, describeType_versionId - The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Request Lenses

describeType_arn :: Lens' DescribeType (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

describeType_publicVersionNumber :: Lens' DescribeType (Maybe Text)

The version number of a public third-party extension.

describeType_publisherId :: Lens' DescribeType (Maybe Text)

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

describeType_type :: Lens' DescribeType (Maybe RegistryType)

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

describeType_typeName :: Lens' DescribeType (Maybe Text)

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

describeType_versionId :: Lens' DescribeType (Maybe Text)

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Destructuring the Response

data DescribeTypeResponse

See: newDescribeTypeResponse smart constructor.

Constructors

DescribeTypeResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the extension.

• autoUpdate :: Maybe Bool

  Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

• configurationSchema :: Maybe Text

  A JSON string that represent the current configuration data for the extension in this account and region.

  To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

• defaultVersionId :: Maybe Text

  The ID of the default version of the extension. The default version is used when the extension version isn't specified.

  This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

  To set the default version of an extension, use SetTypeDefaultVersion .

• deprecatedStatus :: Maybe DeprecatedStatus

  The deprecation status of the extension version.

  Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

  For public third-party extensions, CloudFormation returns null.

• description :: Maybe Text

  The description of the extension.

• documentationUrl :: Maybe Text

  The URL of a page providing detailed documentation for this extension.

• executionRoleArn :: Maybe Text

  The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

  If the registered extension calls any Amazon Web Services APIs, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

• isActivated :: Maybe Bool

  Whether the extension is activated in the account and region.

  This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

• isDefaultVersion :: Maybe Bool

  Whether the specified extension version is set as the default version.

  This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

• lastUpdated :: Maybe ISO8601

  When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType.
  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
• latestPublicVersion :: Maybe Text

  The latest version of a public extension that is available for use.

  This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

• loggingConfig :: Maybe LoggingConfig

  Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

• originalTypeArn :: Maybe Text

  For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

• originalTypeName :: Maybe Text

  For public extensions that have been activated for this account and region, the type name of the public extension.

  If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

• provisioningType :: Maybe ProvisioningType

  For resource type extensions, the provisioning behavior of the resource type. 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 resource type includes an update handler to process updates to the type during stack update operations.
  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

    • create
    • read
    • delete
• publicVersionNumber :: Maybe Text

  The version number of a public third-party extension.

  This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

• publisherId :: Maybe Text

  The publisher ID of the extension publisher.

  This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

• requiredActivatedTypes :: Maybe [RequiredActivatedType]

  For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

• schema :: Maybe Text

  The schema that defines the extension.

  For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

• sourceUrl :: Maybe Text

  The URL of the source code for the extension.

• timeCreated :: Maybe ISO8601

  When the specified private extension version was registered or activated in your account.

• type' :: Maybe RegistryType

  The kind of extension.

• typeName :: Maybe Text

  The name of the extension.

  If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

• typeTestsStatus :: Maybe TypeTestsStatus

  The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

  This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

    An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.

  • FAILED: The extension has failed one or more contract tests.
  • IN_PROGRESS: Contract tests are currently being performed on the extension.
  • NOT_TESTED: Contract tests haven't been performed on the extension.
• typeTestsStatusDescription :: Maybe Text

  The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

  This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

• visibility :: Maybe Visibility

  The scope at which the extension is visible and usable in CloudFormation operations.

  Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.
  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

Associated Types

type Rep DescribeTypeResponse :: Type -> Type

Methods

from :: DescribeTypeResponse -> Rep DescribeTypeResponse x

to :: Rep DescribeTypeResponse x -> DescribeTypeResponse

Read DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

Methods

readsPrec :: Int -> ReadS DescribeTypeResponse

readList :: ReadS [DescribeTypeResponse]

readPrec :: ReadPrec DescribeTypeResponse

readListPrec :: ReadPrec [DescribeTypeResponse]

Show DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

Methods

showsPrec :: Int -> DescribeTypeResponse -> ShowS

show :: DescribeTypeResponse -> String

showList :: [DescribeTypeResponse] -> ShowS

NFData DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

Methods

rnf :: DescribeTypeResponse -> ()

Eq DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

Methods

(==) :: DescribeTypeResponse -> DescribeTypeResponse -> Bool

(/=) :: DescribeTypeResponse -> DescribeTypeResponse -> Bool

type Rep DescribeTypeResponse

Defined in Amazonka.CloudFormation.DescribeType

type Rep DescribeTypeResponse = D1 ('MetaData "DescribeTypeResponse" "Amazonka.CloudFormation.DescribeType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeTypeResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "autoUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "configurationSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "defaultVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deprecatedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecatedStatus))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "isActivated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "isDefaultVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "latestPublicVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :*: S1 ('MetaSel ('Just "originalTypeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "originalTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "provisioningType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningType)) :*: S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "requiredActivatedTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequiredActivatedType]))) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "timeCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "typeTestsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TypeTestsStatus)) :*: S1 ('MetaSel ('Just "typeTestsStatusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Visibility)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeTypeResponse

Arguments

:: Int

$sel:httpStatus:DescribeTypeResponse'

-> DescribeTypeResponse

Create a value of DescribeTypeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeType, describeTypeResponse_arn - The Amazon Resource Name (ARN) of the extension.

$sel:autoUpdate:DescribeTypeResponse', describeTypeResponse_autoUpdate - Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

$sel:configurationSchema:DescribeTypeResponse', describeTypeResponse_configurationSchema - A JSON string that represent the current configuration data for the extension in this account and region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

DescribeTypeResponse, describeTypeResponse_defaultVersionId - The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

$sel:deprecatedStatus:DescribeTypeResponse', describeTypeResponse_deprecatedStatus - The deprecation status of the extension version.

Valid values include:

• LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
• DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

DescribeTypeResponse, describeTypeResponse_description - The description of the extension.

$sel:documentationUrl:DescribeTypeResponse', describeTypeResponse_documentationUrl - The URL of a page providing detailed documentation for this extension.

$sel:executionRoleArn:DescribeTypeResponse', describeTypeResponse_executionRoleArn - The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

DescribeTypeResponse, describeTypeResponse_isActivated - Whether the extension is activated in the account and region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

DescribeTypeResponse, describeTypeResponse_isDefaultVersion - Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

DescribeTypeResponse, describeTypeResponse_lastUpdated - When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.
• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

DescribeTypeResponse, describeTypeResponse_latestPublicVersion - The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

$sel:loggingConfig:DescribeTypeResponse', describeTypeResponse_loggingConfig - Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

$sel:originalTypeArn:DescribeTypeResponse', describeTypeResponse_originalTypeArn - For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

DescribeTypeResponse, describeTypeResponse_originalTypeName - For public extensions that have been activated for this account and region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

$sel:provisioningType:DescribeTypeResponse', describeTypeResponse_provisioningType - For resource type extensions, the provisioning behavior of the resource type. 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 resource type includes an update handler to process updates to the type during stack update operations.
• IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create
  • read
  • delete

DescribeType, describeTypeResponse_publicVersionNumber - The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

DescribeType, describeTypeResponse_publisherId - The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

$sel:requiredActivatedTypes:DescribeTypeResponse', describeTypeResponse_requiredActivatedTypes - For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

$sel:schema:DescribeTypeResponse', describeTypeResponse_schema - The schema that defines the extension.

For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

$sel:sourceUrl:DescribeTypeResponse', describeTypeResponse_sourceUrl - The URL of the source code for the extension.

DescribeTypeResponse, describeTypeResponse_timeCreated - When the specified private extension version was registered or activated in your account.

DescribeType, describeTypeResponse_type - The kind of extension.

DescribeType, describeTypeResponse_typeName - The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

$sel:typeTestsStatus:DescribeTypeResponse', describeTypeResponse_typeTestsStatus - The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

• PASSED: The extension has passed all its contract tests.

  An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.

• FAILED: The extension has failed one or more contract tests.
• IN_PROGRESS: Contract tests are currently being performed on the extension.
• NOT_TESTED: Contract tests haven't been performed on the extension.

$sel:typeTestsStatusDescription:DescribeTypeResponse', describeTypeResponse_typeTestsStatusDescription - The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

$sel:visibility:DescribeTypeResponse', describeTypeResponse_visibility - The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.
• PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

$sel:httpStatus:DescribeTypeResponse', describeTypeResponse_httpStatus - The response's http status code.

Response Lenses

describeTypeResponse_arn :: Lens' DescribeTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the extension.

describeTypeResponse_autoUpdate :: Lens' DescribeTypeResponse (Maybe Bool)

Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

describeTypeResponse_configurationSchema :: Lens' DescribeTypeResponse (Maybe Text)

A JSON string that represent the current configuration data for the extension in this account and region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

describeTypeResponse_defaultVersionId :: Lens' DescribeTypeResponse (Maybe Text)

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion .

describeTypeResponse_deprecatedStatus :: Lens' DescribeTypeResponse (Maybe DeprecatedStatus)

The deprecation status of the extension version.

Valid values include:

• LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
• DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

describeTypeResponse_description :: Lens' DescribeTypeResponse (Maybe Text)

The description of the extension.

describeTypeResponse_documentationUrl :: Lens' DescribeTypeResponse (Maybe Text)

The URL of a page providing detailed documentation for this extension.

describeTypeResponse_executionRoleArn :: Lens' DescribeTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

describeTypeResponse_isActivated :: Lens' DescribeTypeResponse (Maybe Bool)

Whether the extension is activated in the account and region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

describeTypeResponse_isDefaultVersion :: Lens' DescribeTypeResponse (Maybe Bool)

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

describeTypeResponse_lastUpdated :: Lens' DescribeTypeResponse (Maybe UTCTime)

When the specified extension version was registered. This applies only to:

• Private extensions you have registered in your account. For more information, see RegisterType.
• Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

describeTypeResponse_latestPublicVersion :: Lens' DescribeTypeResponse (Maybe Text)

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

describeTypeResponse_loggingConfig :: Lens' DescribeTypeResponse (Maybe LoggingConfig)

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

describeTypeResponse_originalTypeArn :: Lens' DescribeTypeResponse (Maybe Text)

For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

describeTypeResponse_originalTypeName :: Lens' DescribeTypeResponse (Maybe Text)

For public extensions that have been activated for this account and region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

describeTypeResponse_provisioningType :: Lens' DescribeTypeResponse (Maybe ProvisioningType)

For resource type extensions, the provisioning behavior of the resource type. 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 resource type includes an update handler to process updates to the type during stack update operations.
• IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

• NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

  • create
  • read
  • delete

describeTypeResponse_publicVersionNumber :: Lens' DescribeTypeResponse (Maybe Text)

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

describeTypeResponse_publisherId :: Lens' DescribeTypeResponse (Maybe Text)

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

describeTypeResponse_requiredActivatedTypes :: Lens' DescribeTypeResponse (Maybe [RequiredActivatedType])

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

describeTypeResponse_schema :: Lens' DescribeTypeResponse (Maybe Text)

The schema that defines the extension.

For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

describeTypeResponse_sourceUrl :: Lens' DescribeTypeResponse (Maybe Text)

The URL of the source code for the extension.

describeTypeResponse_timeCreated :: Lens' DescribeTypeResponse (Maybe UTCTime)

When the specified private extension version was registered or activated in your account.

describeTypeResponse_type :: Lens' DescribeTypeResponse (Maybe RegistryType)

The kind of extension.

describeTypeResponse_typeName :: Lens' DescribeTypeResponse (Maybe Text)

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

describeTypeResponse_typeTestsStatus :: Lens' DescribeTypeResponse (Maybe TypeTestsStatus)

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

• PASSED: The extension has passed all its contract tests.

  An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.

• FAILED: The extension has failed one or more contract tests.
• IN_PROGRESS: Contract tests are currently being performed on the extension.
• NOT_TESTED: Contract tests haven't been performed on the extension.

describeTypeResponse_typeTestsStatusDescription :: Lens' DescribeTypeResponse (Maybe Text)

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

describeTypeResponse_visibility :: Lens' DescribeTypeResponse (Maybe Visibility)

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.
• PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

describeTypeResponse_httpStatus :: Lens' DescribeTypeResponse Int

The response's http status code.