AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This is the response object from the DescribeType operation.
Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z
public class DescribeTypeResponse : AmazonWebServiceResponse
The DescribeTypeResponse type exposes the following members
Name | Description | |
---|---|---|
![]() |
DescribeTypeResponse() |
Name | Type | Description | |
---|---|---|---|
![]() |
Arn | System.String |
Gets and sets the property Arn. The Amazon Resource Name (ARN) of the extension. |
![]() |
AutoUpdate | System.Boolean |
Gets and sets the property 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. |
![]() |
ConfigurationSchema | System.String |
Gets and sets the property 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. |
![]() |
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
DefaultVersionId | System.String |
Gets and sets the property 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 To set the default version of an extension, use SetTypeDefaultVersion. |
![]() |
DeprecatedStatus | Amazon.CloudFormation.DeprecatedStatus |
Gets and sets the property DeprecatedStatus. The deprecation status of the extension version. Valid values include:
For public third-party extensions, CloudFormation returns |
![]() |
Description | System.String |
Gets and sets the property Description. The description of the extension. |
![]() |
DocumentationUrl | System.String |
Gets and sets the property DocumentationUrl. The URL of a page providing detailed documentation for this extension. |
![]() |
ExecutionRoleArn | System.String |
Gets and sets the property 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 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. |
![]() |
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
IsActivated | System.Boolean |
Gets and sets the property 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 |
![]() |
IsDefaultVersion | System.Boolean |
Gets and sets the property 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 |
![]() |
LastUpdated | System.DateTime |
Gets and sets the property LastUpdated. When the specified extension version was registered. This applies only to:
|
![]() |
LatestPublicVersion | System.String |
Gets and sets the property 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 |
![]() |
LoggingConfig | Amazon.CloudFormation.Model.LoggingConfig |
Gets and sets the property 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 |
![]() |
OriginalTypeArn | System.String |
Gets and sets the property OriginalTypeArn. For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension. |
![]() |
OriginalTypeName | System.String |
Gets and sets the property OriginalTypeName. For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a |
![]() |
ProvisioningType | Amazon.CloudFormation.ProvisioningType |
Gets and sets the property 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:
|
![]() |
PublicVersionNumber | System.String |
Gets and sets the property 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 |
![]() |
PublisherId | System.String |
Gets and sets the property 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 |
![]() |
RequiredActivatedTypes | System.Collections.Generic.List<Amazon.CloudFormation.Model.RequiredActivatedType> |
Gets and sets the property 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. |
![]() |
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
![]() |
Schema | System.String |
Gets and sets the property Schema. The schema that defines the extension. For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide. |
![]() |
SourceUrl | System.String |
Gets and sets the property SourceUrl. The URL of the source code for the extension. |
![]() |
TimeCreated | System.DateTime |
Gets and sets the property TimeCreated. When the specified private extension version was registered or activated in your account. |
![]() |
Type | Amazon.CloudFormation.RegistryType |
Gets and sets the property Type. The kind of extension. |
![]() |
TypeName | System.String |
Gets and sets the property 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. |
![]() |
TypeTestsStatus | Amazon.CloudFormation.TypeTestsStatus |
Gets and sets the property TypeTestsStatus.
The contract test status of the registered extension version. To return the extension
test status of a specific extension version, you must specify This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
|
![]() |
TypeTestsStatusDescription | System.String |
Gets and sets the property TypeTestsStatusDescription.
The description of the test status. To return the extension test status of a specific
extension version, you must specify 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 | Amazon.CloudFormation.Visibility |
Gets and sets the property Visibility. The scope at which the extension is visible and usable in CloudFormation operations. Valid values include:
|
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5