@Generated(value="software.amazon.awssdk:codegen") public final class DescribeTypeResponse extends CloudFormationResponse implements ToCopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeTypeResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the extension.
|
Boolean |
autoUpdate()
Whether CloudFormation automatically updates the extension in this account and region when a new minor
version is published by the extension publisher.
|
static DescribeTypeResponse.Builder |
builder() |
String |
configurationSchema()
A JSON string that represent the current configuration data for the extension in this account and region.
|
String |
defaultVersionId()
The ID of the default version of the extension.
|
DeprecatedStatus |
deprecatedStatus()
The deprecation status of the extension version.
|
String |
deprecatedStatusAsString()
The deprecation status of the extension version.
|
String |
description()
The description of the extension.
|
String |
documentationUrl()
The URL of a page providing detailed documentation for this extension.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
executionRoleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasRequiredActivatedTypes()
For responses, this returns true if the service returned a value for the RequiredActivatedTypes property.
|
Boolean |
isActivated()
Whether the extension is activated in the account and region.
|
Boolean |
isDefaultVersion()
Whether the specified extension version is set as the default version.
|
Instant |
lastUpdated()
When the specified extension version was registered.
|
String |
latestPublicVersion()
The latest version of a public extension that is available for use.
|
LoggingConfig |
loggingConfig()
Contains logging configuration information for private extensions.
|
String |
originalTypeArn()
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the
public extension.
|
String |
originalTypeName()
For public extensions that have been activated for this account and region, the type name of the public
extension.
|
ProvisioningType |
provisioningType()
For resource type extensions, the provisioning behavior of the resource type.
|
String |
provisioningTypeAsString()
For resource type extensions, the provisioning behavior of the resource type.
|
String |
publicVersionNumber()
The version number of a public third-party extension.
|
String |
publisherId()
The publisher ID of the extension publisher.
|
List<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.
|
String |
schema()
The schema that defines the extension.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeTypeResponse.Builder> |
serializableBuilderClass() |
String |
sourceUrl()
The URL of the source code for the extension.
|
Instant |
timeCreated()
When the specified private extension version was registered or activated in your account.
|
DescribeTypeResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
RegistryType |
type()
The kind of extension.
|
String |
typeAsString()
The kind of extension.
|
String |
typeName()
The name of the extension.
|
TypeTestsStatus |
typeTestsStatus()
The contract test status of the registered extension version.
|
String |
typeTestsStatusAsString()
The contract test status of the registered extension version.
|
String |
typeTestsStatusDescription()
The description of the test status.
|
Visibility |
visibility()
The scope at which the extension is visible and usable in CloudFormation operations.
|
String |
visibilityAsString()
The scope at which the extension is visible and usable in CloudFormation operations.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The Amazon Resource Name (ARN) of the extension.
public final RegistryType type()
The kind of extension.
If the service returns an enum value that is not available in the current SDK version, type will return
RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
RegistryTypepublic final String typeAsString()
The kind of extension.
If the service returns an enum value that is not available in the current SDK version, type will return
RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
RegistryTypepublic final 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.
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 final 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 .
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 final 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 final 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.
If the service returns an enum value that is not available in the current SDK version, typeTestsStatus
will return TypeTestsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from typeTestsStatusAsString().
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.
TypeTestsStatuspublic final String typeTestsStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, typeTestsStatus
will return TypeTestsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from typeTestsStatusAsString().
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.
TypeTestsStatuspublic final 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.
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 final String description()
The description of the extension.
public final String schema()
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 final 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
If the service returns an enum value that is not available in the current SDK version, provisioningType
will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from provisioningTypeAsString().
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
ProvisioningTypepublic final String provisioningTypeAsString()
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
If the service returns an enum value that is not available in the current SDK version, provisioningType
will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from provisioningTypeAsString().
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
ProvisioningTypepublic final 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.
If the service returns an enum value that is not available in the current SDK version, deprecatedStatus
will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from deprecatedStatusAsString().
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.
DeprecatedStatuspublic final String deprecatedStatusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, deprecatedStatus
will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from deprecatedStatusAsString().
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.
DeprecatedStatuspublic final 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.
null. For more information,
see
RegisterType.public final boolean hasRequiredActivatedTypes()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRequiredActivatedTypes() method.
public final 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.
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 final 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.
If the service returns an enum value that is not available in the current SDK version, visibility will
return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
visibilityAsString().
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.
Visibilitypublic final String visibilityAsString()
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.
If the service returns an enum value that is not available in the current SDK version, visibility will
return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
visibilityAsString().
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.
Visibilitypublic final String sourceUrl()
The URL of the source code for the extension.
public final String documentationUrl()
The URL of a page providing detailed documentation for this extension.
public final 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.
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 final Instant timeCreated()
When the specified private extension version was registered or activated in your account.
public final 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.
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 final 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.
This applies only to public third-party extensions. For private registered extensions, and extensions
provided by Amazon Web Services, CloudFormation returns null.
public final 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.
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 final String originalTypeArn()
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.
public final 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.
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 final 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.
This only applies if you specify a public extension, and you don't specify a version. For all other
requests, CloudFormation returns null.
public final 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 final 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.
public DescribeTypeResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>toBuilder in class AwsResponsepublic static DescribeTypeResponse.Builder builder()
public static Class<? extends DescribeTypeResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2022. All rights reserved.