@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeTypeResult() |
Modifier and Type | Method and Description |
---|---|
DescribeTypeResult |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the extension.
|
Boolean |
getAutoUpdate()
Whether CloudFormation automatically updates the extension in this account and Region when a new minor
version is published by the extension publisher.
|
String |
getConfigurationSchema()
A JSON string that represent the current configuration data for the extension in this account and Region.
|
String |
getDefaultVersionId()
The ID of the default version of the extension.
|
String |
getDeprecatedStatus()
The deprecation status of the extension version.
|
String |
getDescription()
The description of the extension.
|
String |
getDocumentationUrl()
The URL of a page providing detailed documentation for this extension.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.
|
Boolean |
getIsActivated()
Whether the extension is activated in the account and Region.
|
Boolean |
getIsDefaultVersion()
Whether the specified extension version is set as the default version.
|
Date |
getLastUpdated()
When the specified extension version was registered.
|
String |
getLatestPublicVersion()
The latest version of a public extension that is available for use.
|
LoggingConfig |
getLoggingConfig()
Contains logging configuration information for private extensions.
|
String |
getOriginalTypeArn()
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the
public extension.
|
String |
getOriginalTypeName()
For public extensions that have been activated for this account and Region, the type name of the public
extension.
|
String |
getProvisioningType()
For resource type extensions, the provisioning behavior of the resource type.
|
String |
getPublicVersionNumber()
The version number of a public third-party extension.
|
String |
getPublisherId()
The publisher ID of the extension publisher.
|
List<RequiredActivatedType> |
getRequiredActivatedTypes()
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.
|
String |
getSchema()
The schema that defines the extension.
|
String |
getSourceUrl()
The URL of the source code for the extension.
|
Date |
getTimeCreated()
When the specified private extension version was registered or activated in your account.
|
String |
getType()
The kind of extension.
|
String |
getTypeName()
The name of the extension.
|
String |
getTypeTestsStatus()
The contract test status of the registered extension version.
|
String |
getTypeTestsStatusDescription()
The description of the test status.
|
String |
getVisibility()
The scope at which the extension is visible and usable in CloudFormation operations.
|
int |
hashCode() |
Boolean |
isActivated()
Whether the extension is activated in the account and Region.
|
Boolean |
isAutoUpdate()
Whether CloudFormation automatically updates the extension in this account and Region when a new minor
version is published by the extension publisher.
|
Boolean |
isDefaultVersion()
Whether the specified extension version is set as the default version.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the extension.
|
void |
setAutoUpdate(Boolean autoUpdate)
Whether CloudFormation automatically updates the extension in this account and Region when a new minor
version is published by the extension publisher.
|
void |
setConfigurationSchema(String configurationSchema)
A JSON string that represent the current configuration data for the extension in this account and Region.
|
void |
setDefaultVersionId(String defaultVersionId)
The ID of the default version of the extension.
|
void |
setDeprecatedStatus(String deprecatedStatus)
The deprecation status of the extension version.
|
void |
setDescription(String description)
The description of the extension.
|
void |
setDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this extension.
|
void |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.
|
void |
setIsActivated(Boolean isActivated)
Whether the extension is activated in the account and Region.
|
void |
setIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified extension version is set as the default version.
|
void |
setLastUpdated(Date lastUpdated)
When the specified extension version was registered.
|
void |
setLatestPublicVersion(String latestPublicVersion)
The latest version of a public extension that is available for use.
|
void |
setLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for private extensions.
|
void |
setOriginalTypeArn(String originalTypeArn)
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the
public extension.
|
void |
setOriginalTypeName(String originalTypeName)
For public extensions that have been activated for this account and Region, the type name of the public
extension.
|
void |
setProvisioningType(String provisioningType)
For resource type extensions, the provisioning behavior of the resource type.
|
void |
setPublicVersionNumber(String publicVersionNumber)
The version number of a public third-party extension.
|
void |
setPublisherId(String publisherId)
The publisher ID of the extension publisher.
|
void |
setRequiredActivatedTypes(Collection<RequiredActivatedType> 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.
|
void |
setSchema(String schema)
The schema that defines the extension.
|
void |
setSourceUrl(String sourceUrl)
The URL of the source code for the extension.
|
void |
setTimeCreated(Date timeCreated)
When the specified private extension version was registered or activated in your account.
|
void |
setType(String type)
The kind of extension.
|
void |
setTypeName(String typeName)
The name of the extension.
|
void |
setTypeTestsStatus(String typeTestsStatus)
The contract test status of the registered extension version.
|
void |
setTypeTestsStatusDescription(String typeTestsStatusDescription)
The description of the test status.
|
void |
setVisibility(String visibility)
The scope at which the extension is visible and usable in CloudFormation operations.
|
String |
toString()
Returns a string representation of this object.
|
DescribeTypeResult |
withArn(String arn)
The Amazon Resource Name (ARN) of the extension.
|
DescribeTypeResult |
withAutoUpdate(Boolean autoUpdate)
Whether CloudFormation automatically updates the extension in this account and Region when a new minor
version is published by the extension publisher.
|
DescribeTypeResult |
withConfigurationSchema(String configurationSchema)
A JSON string that represent the current configuration data for the extension in this account and Region.
|
DescribeTypeResult |
withDefaultVersionId(String defaultVersionId)
The ID of the default version of the extension.
|
DescribeTypeResult |
withDeprecatedStatus(DeprecatedStatus deprecatedStatus)
The deprecation status of the extension version.
|
DescribeTypeResult |
withDeprecatedStatus(String deprecatedStatus)
The deprecation status of the extension version.
|
DescribeTypeResult |
withDescription(String description)
The description of the extension.
|
DescribeTypeResult |
withDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this extension.
|
DescribeTypeResult |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.
|
DescribeTypeResult |
withIsActivated(Boolean isActivated)
Whether the extension is activated in the account and Region.
|
DescribeTypeResult |
withIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified extension version is set as the default version.
|
DescribeTypeResult |
withLastUpdated(Date lastUpdated)
When the specified extension version was registered.
|
DescribeTypeResult |
withLatestPublicVersion(String latestPublicVersion)
The latest version of a public extension that is available for use.
|
DescribeTypeResult |
withLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for private extensions.
|
DescribeTypeResult |
withOriginalTypeArn(String originalTypeArn)
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the
public extension.
|
DescribeTypeResult |
withOriginalTypeName(String originalTypeName)
For public extensions that have been activated for this account and Region, the type name of the public
extension.
|
DescribeTypeResult |
withProvisioningType(ProvisioningType provisioningType)
For resource type extensions, the provisioning behavior of the resource type.
|
DescribeTypeResult |
withProvisioningType(String provisioningType)
For resource type extensions, the provisioning behavior of the resource type.
|
DescribeTypeResult |
withPublicVersionNumber(String publicVersionNumber)
The version number of a public third-party extension.
|
DescribeTypeResult |
withPublisherId(String publisherId)
The publisher ID of the extension publisher.
|
DescribeTypeResult |
withRequiredActivatedTypes(Collection<RequiredActivatedType> 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.
|
DescribeTypeResult |
withRequiredActivatedTypes(RequiredActivatedType... 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.
|
DescribeTypeResult |
withSchema(String schema)
The schema that defines the extension.
|
DescribeTypeResult |
withSourceUrl(String sourceUrl)
The URL of the source code for the extension.
|
DescribeTypeResult |
withTimeCreated(Date timeCreated)
When the specified private extension version was registered or activated in your account.
|
DescribeTypeResult |
withType(RegistryType type)
The kind of extension.
|
DescribeTypeResult |
withType(String type)
The kind of extension.
|
DescribeTypeResult |
withTypeName(String typeName)
The name of the extension.
|
DescribeTypeResult |
withTypeTestsStatus(String typeTestsStatus)
The contract test status of the registered extension version.
|
DescribeTypeResult |
withTypeTestsStatus(TypeTestsStatus typeTestsStatus)
The contract test status of the registered extension version.
|
DescribeTypeResult |
withTypeTestsStatusDescription(String typeTestsStatusDescription)
The description of the test status.
|
DescribeTypeResult |
withVisibility(String visibility)
The scope at which the extension is visible and usable in CloudFormation operations.
|
DescribeTypeResult |
withVisibility(Visibility visibility)
The scope at which the extension is visible and usable in CloudFormation operations.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setArn(String arn)
The Amazon Resource Name (ARN) of the extension.
arn
- The Amazon Resource Name (ARN) of the extension.public String getArn()
The Amazon Resource Name (ARN) of the extension.
public DescribeTypeResult withArn(String arn)
The Amazon Resource Name (ARN) of the extension.
arn
- The Amazon Resource Name (ARN) of the extension.public void setType(String type)
The kind of extension.
type
- The kind of extension.RegistryType
public String getType()
The kind of extension.
RegistryType
public DescribeTypeResult withType(String type)
The kind of extension.
type
- The kind of extension.RegistryType
public DescribeTypeResult withType(RegistryType type)
The kind of extension.
type
- The kind of extension.RegistryType
public void setTypeName(String 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.
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.
public String getTypeName()
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.
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.
public DescribeTypeResult withTypeName(String 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.
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.
public void setDefaultVersionId(String 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.
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.
public String getDefaultVersionId()
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.
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.
public DescribeTypeResult withDefaultVersionId(String 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.
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.
public void setIsDefaultVersion(Boolean 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
.
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
.
public Boolean getIsDefaultVersion()
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
.
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
.
public DescribeTypeResult withIsDefaultVersion(Boolean 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
.
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
.
public Boolean 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
.
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
.
public void setTypeTestsStatus(String 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.
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.
TypeTestsStatus
public String getTypeTestsStatus()
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.
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.
TypeTestsStatus
public DescribeTypeResult withTypeTestsStatus(String 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.
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.
TypeTestsStatus
public DescribeTypeResult withTypeTestsStatus(TypeTestsStatus 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.
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.
TypeTestsStatus
public void setTypeTestsStatusDescription(String 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.
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.
public String getTypeTestsStatusDescription()
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.
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.
public DescribeTypeResult withTypeTestsStatusDescription(String 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.
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.
public void setDescription(String description)
The description of the extension.
description
- The description of the extension.public String getDescription()
The description of the extension.
public DescribeTypeResult withDescription(String description)
The description of the extension.
description
- The description of the extension.public void setSchema(String schema)
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
schema
- The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public String getSchema()
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public DescribeTypeResult withSchema(String schema)
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
schema
- The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public void setProvisioningType(String 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
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
ProvisioningType
public String getProvisioningType()
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
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
ProvisioningType
public DescribeTypeResult withProvisioningType(String 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
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
ProvisioningType
public DescribeTypeResult withProvisioningType(ProvisioningType 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
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
ProvisioningType
public void setDeprecatedStatus(String 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
.
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
.
DeprecatedStatus
public String getDeprecatedStatus()
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
.
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
.
DeprecatedStatus
public DescribeTypeResult withDeprecatedStatus(String 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
.
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
.
DeprecatedStatus
public DescribeTypeResult withDeprecatedStatus(DeprecatedStatus 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
.
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
.
DeprecatedStatus
public void setLoggingConfig(LoggingConfig 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.
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.public LoggingConfig getLoggingConfig()
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.
null
. For more information,
see
RegisterType.public DescribeTypeResult withLoggingConfig(LoggingConfig 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.
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.public List<RequiredActivatedType> getRequiredActivatedTypes()
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.
public void setRequiredActivatedTypes(Collection<RequiredActivatedType> 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.
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.public DescribeTypeResult withRequiredActivatedTypes(RequiredActivatedType... 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.
NOTE: This method appends the values to the existing list (if any). Use
setRequiredActivatedTypes(java.util.Collection)
or
withRequiredActivatedTypes(java.util.Collection)
if you want to override the existing values.
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.public DescribeTypeResult withRequiredActivatedTypes(Collection<RequiredActivatedType> 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.
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.public void setExecutionRoleArn(String 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.
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.
public String getExecutionRoleArn()
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.
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.
public DescribeTypeResult withExecutionRoleArn(String 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.
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.
public void setVisibility(String 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.
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.
Visibility
public String getVisibility()
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.
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.
Visibility
public DescribeTypeResult withVisibility(String 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.
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.
Visibility
public DescribeTypeResult withVisibility(Visibility 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.
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.
Visibility
public void setSourceUrl(String sourceUrl)
The URL of the source code for the extension.
sourceUrl
- The URL of the source code for the extension.public String getSourceUrl()
The URL of the source code for the extension.
public DescribeTypeResult withSourceUrl(String sourceUrl)
The URL of the source code for the extension.
sourceUrl
- The URL of the source code for the extension.public void setDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this extension.
documentationUrl
- The URL of a page providing detailed documentation for this extension.public String getDocumentationUrl()
The URL of a page providing detailed documentation for this extension.
public DescribeTypeResult withDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this extension.
documentationUrl
- The URL of a page providing detailed documentation for this extension.public void setLastUpdated(Date 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.
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.
public Date getLastUpdated()
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.
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.
public DescribeTypeResult withLastUpdated(Date 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.
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.
public void setTimeCreated(Date timeCreated)
When the specified private extension version was registered or activated in your account.
timeCreated
- When the specified private extension version was registered or activated in your account.public Date getTimeCreated()
When the specified private extension version was registered or activated in your account.
public DescribeTypeResult withTimeCreated(Date timeCreated)
When the specified private extension version was registered or activated in your account.
timeCreated
- When the specified private extension version was registered or activated in your account.public void setConfigurationSchema(String 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.
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.
public String getConfigurationSchema()
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.
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.
public DescribeTypeResult withConfigurationSchema(String 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.
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.
public void setPublisherId(String 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
.
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
.
public String getPublisherId()
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
.
This applies only to public third-party extensions. For private registered extensions, and extensions
provided by Amazon Web Services, CloudFormation returns null
.
public DescribeTypeResult withPublisherId(String 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
.
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
.
public void setOriginalTypeName(String 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.
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.
public String getOriginalTypeName()
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.
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.
public DescribeTypeResult withOriginalTypeName(String 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.
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.
public void setOriginalTypeArn(String originalTypeArn)
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.
originalTypeArn
- For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN)
of the public extension.public String getOriginalTypeArn()
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.
public DescribeTypeResult withOriginalTypeArn(String originalTypeArn)
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.
originalTypeArn
- For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN)
of the public extension.public void setPublicVersionNumber(String 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
.
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
.
public String getPublicVersionNumber()
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
.
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
.
public DescribeTypeResult withPublicVersionNumber(String 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
.
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
.
public void setLatestPublicVersion(String 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
.
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
.
public String getLatestPublicVersion()
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
.
This only applies if you specify a public extension, and you don't specify a version. For all other
requests, CloudFormation returns null
.
public DescribeTypeResult withLatestPublicVersion(String 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
.
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
.
public void setIsActivated(Boolean 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
.
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
.
public Boolean getIsActivated()
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
.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns
null
.
public DescribeTypeResult withIsActivated(Boolean 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
.
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
.
public Boolean 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
.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns
null
.
public void setAutoUpdate(Boolean 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.
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.public Boolean getAutoUpdate()
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.
public DescribeTypeResult withAutoUpdate(Boolean 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.
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.public Boolean isAutoUpdate()
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.
public String toString()
toString
in class Object
Object.toString()
public DescribeTypeResult clone()