![]() |
![]()
| ![]() |
![]()
NAMEPaws::CloudFormation::DescribeTypeOutput ATTRIBUTESArn => StrThe Amazon Resource Name (ARN) of the extension. AutoUpdate => BoolWhether 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 AWS CloudFormation User Guide. ConfigurationSchema => StrA 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html). For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide. DefaultVersionId => StrThe ID of the default version of the extension. The default version is used when the extension version is not specified. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns "null". For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). To set the default version of an extension, use " SetTypeDefaultVersion ". DeprecatedStatus => StrThe deprecation status of the extension version. Valid values include:
For public third-party extensions, CloudFormation returns "null". Valid values are: "LIVE", "DEPRECATED" =head2 Description => Str The description of the extension. DocumentationUrl => StrThe URL of a page providing detailed documentation for this extension. ExecutionRoleArn => StrThe 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). If the registered extension calls any AWS APIs, you must create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) 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 extension with the appropriate credentials. IsActivated => BoolWhether or not 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 => BoolWhether 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. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns "null". LastUpdated => StrWhen the specified extension version was registered. This applies only to:
LatestPublicVersion => StrThe latest version of a public extension that is available for use. This only applies if you specify a public extension, and you do not specify a version. For all other requests, CloudFormation returns "null". LoggingConfig => Paws::CloudFormation::LoggingConfigContains 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 and published by third parties, CloudFormation returns "null". For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). OriginalTypeArn => StrFor public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension. OriginalTypeName => StrFor 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) in the CloudFormation User Guide. ProvisioningType => StrFor resource type extensions, the provisioning behavior of the resource type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include:
Valid values are: "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE" =head2 PublicVersionNumber => Str 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 => StrThe publisher ID of the extension publisher. This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon, CloudFormation returns "null". RequiredActivatedTypes => ArrayRef[Paws::CloudFormation::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 => StrThe schema that defines the extension. For more information on extension schemas, see Resource Provider Schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) in the CloudFormation CLI User Guide. SourceUrl => StrThe URL of the source code for the extension. TimeCreated => StrWhen the specified private extension version was registered or activated in your account. Type => StrThe kind of extension. Valid values are: "RESOURCE", "MODULE" =head2 TypeName => Str 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). TypeTestsStatus => StrThe contract test status of the registered extension version. To return the extension test status of a specifc extension version, you must specify "VersionId". This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.
Valid values are: "PASSED", "FAILED", "IN_PROGRESS", "NOT_TESTED" =head2 TypeTestsStatusDescription => Str The description of the test status. To return the extension test status of a specifc extension version, you must specify "VersionId". This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account. Visibility => StrThe scope at which the extension is visible and usable in CloudFormation operations. Valid values include:
Valid values are: "PUBLIC", "PRIVATE" =head2 _request_id => Str
|