public static interface DescribeTypeResponse.Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>
| Modifier and Type | Method and Description |
|---|---|
DescribeTypeResponse.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the extension.
|
DescribeTypeResponse.Builder |
autoUpdate(Boolean autoUpdate)
Whether CloudFormation automatically updates the extension in this account and region when a new minor
version is published by the extension publisher.
|
DescribeTypeResponse.Builder |
configurationSchema(String configurationSchema)
A JSON string that represent the current configuration data for the extension in this account and region.
|
DescribeTypeResponse.Builder |
defaultVersionId(String defaultVersionId)
The ID of the default version of the extension.
|
DescribeTypeResponse.Builder |
deprecatedStatus(DeprecatedStatus deprecatedStatus)
The deprecation status of the extension version.
|
DescribeTypeResponse.Builder |
deprecatedStatus(String deprecatedStatus)
The deprecation status of the extension version.
|
DescribeTypeResponse.Builder |
description(String description)
The description of the extension.
|
DescribeTypeResponse.Builder |
documentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this extension.
|
DescribeTypeResponse.Builder |
executionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.
|
DescribeTypeResponse.Builder |
isActivated(Boolean isActivated)
Whether or not the extension is activated in the account and region.
|
DescribeTypeResponse.Builder |
isDefaultVersion(Boolean isDefaultVersion)
Whether the specified extension version is set as the default version.
|
DescribeTypeResponse.Builder |
lastUpdated(Instant lastUpdated)
When the specified extension version was registered.
|
DescribeTypeResponse.Builder |
latestPublicVersion(String latestPublicVersion)
The latest version of a public extension that is available for use.
|
default DescribeTypeResponse.Builder |
loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
Contains logging configuration information for private extensions.
|
DescribeTypeResponse.Builder |
loggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for private extensions.
|
DescribeTypeResponse.Builder |
originalTypeArn(String originalTypeArn)
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of
the public extension.
|
DescribeTypeResponse.Builder |
originalTypeName(String originalTypeName)
For public extensions that have been activated for this account and region, the type name of the public
extension.
|
DescribeTypeResponse.Builder |
provisioningType(ProvisioningType provisioningType)
For resource type extensions, the provisioning behavior of the resource type.
|
DescribeTypeResponse.Builder |
provisioningType(String provisioningType)
For resource type extensions, the provisioning behavior of the resource type.
|
DescribeTypeResponse.Builder |
publicVersionNumber(String publicVersionNumber)
The version number of a public third-party extension.
|
DescribeTypeResponse.Builder |
publisherId(String publisherId)
The publisher ID of the extension publisher.
|
DescribeTypeResponse.Builder |
requiredActivatedTypes(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.
|
DescribeTypeResponse.Builder |
requiredActivatedTypes(Consumer<RequiredActivatedType.Builder>... 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.
|
DescribeTypeResponse.Builder |
requiredActivatedTypes(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.
|
DescribeTypeResponse.Builder |
schema(String schema)
The schema that defines the extension.
|
DescribeTypeResponse.Builder |
sourceUrl(String sourceUrl)
The URL of the source code for the extension.
|
DescribeTypeResponse.Builder |
timeCreated(Instant timeCreated)
When the specified private extension version was registered or activated in your account.
|
DescribeTypeResponse.Builder |
type(RegistryType type)
The kind of extension.
|
DescribeTypeResponse.Builder |
type(String type)
The kind of extension.
|
DescribeTypeResponse.Builder |
typeName(String typeName)
The name of the extension.
|
DescribeTypeResponse.Builder |
typeTestsStatus(String typeTestsStatus)
The contract test status of the registered extension version.
|
DescribeTypeResponse.Builder |
typeTestsStatus(TypeTestsStatus typeTestsStatus)
The contract test status of the registered extension version.
|
DescribeTypeResponse.Builder |
typeTestsStatusDescription(String typeTestsStatusDescription)
The description of the test status.
|
DescribeTypeResponse.Builder |
visibility(String visibility)
The scope at which the extension is visible and usable in CloudFormation operations.
|
DescribeTypeResponse.Builder |
visibility(Visibility visibility)
The scope at which the extension is visible and usable in CloudFormation operations.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeTypeResponse.Builder arn(String arn)
The Amazon Resource Name (ARN) of the extension.
arn - The Amazon Resource Name (ARN) of the extension.DescribeTypeResponse.Builder type(String type)
The kind of extension.
type - The kind of extension.RegistryType,
RegistryTypeDescribeTypeResponse.Builder type(RegistryType type)
The kind of extension.
type - The kind of extension.RegistryType,
RegistryTypeDescribeTypeResponse.Builder typeName(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.
DescribeTypeResponse.Builder defaultVersionId(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 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 and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion .
DescribeTypeResponse.Builder isDefaultVersion(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. For public third-party extensions, whether or not 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. For public third-party extensions, whether or not they are activated in your account,
CloudFormation returns null.
DescribeTypeResponse.Builder typeTestsStatus(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 or not 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 or not 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,
TypeTestsStatusDescribeTypeResponse.Builder typeTestsStatus(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 or not 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 or not 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,
TypeTestsStatusDescribeTypeResponse.Builder typeTestsStatusDescription(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 or not 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 or not they are activated in your account.
DescribeTypeResponse.Builder description(String description)
The description of the extension.
description - The description of the extension.DescribeTypeResponse.Builder schema(String schema)
The schema that defines the extension.
For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
schema - The schema that defines the extension.
For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
DescribeTypeResponse.Builder provisioningType(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,
ProvisioningTypeDescribeTypeResponse.Builder provisioningType(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,
ProvisioningTypeDescribeTypeResponse.Builder deprecatedStatus(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,
DeprecatedStatusDescribeTypeResponse.Builder deprecatedStatus(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,
DeprecatedStatusDescribeTypeResponse.Builder loggingConfig(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 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
and published by third parties, CloudFormation returns null. For more information, see
RegisterType.default DescribeTypeResponse.Builder loggingConfig(Consumer<LoggingConfig.Builder> 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 and published by
third parties, CloudFormation returns null. For more information, see RegisterType.
LoggingConfig.Builder avoiding the need to
create one manually via LoggingConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to loggingConfig(LoggingConfig).loggingConfig - a consumer that will call methods on LoggingConfig.BuilderloggingConfig(LoggingConfig)DescribeTypeResponse.Builder requiredActivatedTypes(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.DescribeTypeResponse.Builder requiredActivatedTypes(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.DescribeTypeResponse.Builder requiredActivatedTypes(Consumer<RequiredActivatedType.Builder>... 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.
This is a convenience that creates an instance of theList.Builder avoiding
the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called
immediately and its result is passed to #requiredActivatedTypes(List) .requiredActivatedTypes - a consumer that will call methods on List.Builder #requiredActivatedTypes(List) DescribeTypeResponse.Builder executionRoleArn(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.
DescribeTypeResponse.Builder visibility(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 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 account.
Visibility,
VisibilityDescribeTypeResponse.Builder visibility(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 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 account.
Visibility,
VisibilityDescribeTypeResponse.Builder sourceUrl(String sourceUrl)
The URL of the source code for the extension.
sourceUrl - The URL of the source code for the extension.DescribeTypeResponse.Builder documentationUrl(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.DescribeTypeResponse.Builder lastUpdated(Instant 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.
DescribeTypeResponse.Builder timeCreated(Instant 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.DescribeTypeResponse.Builder configurationSchema(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.
DescribeTypeResponse.Builder publisherId(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.
DescribeTypeResponse.Builder originalTypeName(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.
DescribeTypeResponse.Builder originalTypeArn(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.DescribeTypeResponse.Builder publicVersionNumber(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.
DescribeTypeResponse.Builder latestPublicVersion(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.
DescribeTypeResponse.Builder isActivated(Boolean isActivated)
Whether 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.
isActivated - Whether 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.
DescribeTypeResponse.Builder autoUpdate(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.Copyright © 2022. All rights reserved.