DescribeTypeResponse (AWS Java SDK :: Services :: AWS CloudFormation 2.16.31 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
    - - software.amazon.awssdk.services.cloudformation.model.DescribeTypeResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeTypeResponse
extends CloudFormationResponse
implements ToCopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeTypeResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeTypeResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the extension.
`static DescribeTypeResponse.Builder`	`builder()`
`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 registered 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`	`isDefaultVersion()` Whether the specified extension version is set as the default version.
`Instant`	`lastUpdated()` When the specified extension version was registered.
`LoggingConfig`	`loggingConfig()` Contains logging configuration information for an extension.
`ProvisioningType`	`provisioningType()` The provisioning behavior of the extension.
`String`	`provisioningTypeAsString()` The provisioning behavior of the extension.
`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 extension version was registered.
`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 registered extension.
`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.

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the extension.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the extension.
  - type
```
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().
    
    Returns:
    
    The kind of extension.
    
    See Also:
    
    RegistryType
  - typeAsString
```
public 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().
    
    Returns:
    
    The kind of extension.
    
    See Also:
    
    RegistryType
  - typeName
```
public final String typeName()
```
    The name of the registered extension.
    
    Returns:
    
    The name of the registered extension.
  - defaultVersionId
```
public final String defaultVersionId()
```
    The ID of the default version of the extension. The default version is used when the extension version is not specified.
    
    To set the default version of an extension, use SetTypeDefaultVersion .
    
    Returns:
    
    The ID of the default version of the extension. The default version is used when the extension version is not specified.
    
    To set the default version of an extension, use SetTypeDefaultVersion .
  - isDefaultVersion
```
public final Boolean isDefaultVersion()
```
    Whether the specified extension version is set as the default version.
    
    Returns:
    
    Whether the specified extension version is set as the default version.
  - description
```
public final String description()
```
    The description of the registered extension.
    
    Returns:
    
    The description of the registered extension.
  - schema
```
public final String schema()
```
    The schema that defines the extension.
    
    For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
    
    Returns:
    
    The schema that defines the extension.
    
    For more information on extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
  - provisioningType
```
public final ProvisioningType provisioningType()
```
    The provisioning behavior of the extension. AWS 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 extension includes an update handler to process updates to the extension during stack update operations.
    - IMMUTABLE: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The extension does not include all of the following handlers, and therefore cannot 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().
    Returns:
    The provisioning behavior of the extension. AWS 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 extension includes an update handler to process updates to the extension during stack update operations.
    
    IMMUTABLE: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The extension does not include all of the following handlers, and therefore cannot actually be provisioned.
    
    create
    
    read
    
    delete
    See Also:
    
    ProvisioningType
  - provisioningTypeAsString
```
public final String provisioningTypeAsString()
```
    The provisioning behavior of the extension. AWS 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 extension includes an update handler to process updates to the extension during stack update operations.
    - IMMUTABLE: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.
    - NON_PROVISIONABLE: The extension does not include all of the following handlers, and therefore cannot 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().
    Returns:
    The provisioning behavior of the extension. AWS 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 extension includes an update handler to process updates to the extension during stack update operations.
    
    IMMUTABLE: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.
    
    NON_PROVISIONABLE: The extension does not include all of the following handlers, and therefore cannot actually be provisioned.
    
    create
    
    read
    
    delete
    See Also:
    
    ProvisioningType
  - deprecatedStatus
```
public final DeprecatedStatus deprecatedStatus()
```
    The deprecation status of the extension version.
    
    Valid values include:
    - LIVE: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    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().
    Returns:
    The deprecation status of the extension version.
    
    Valid values include:
    
    LIVE: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    See Also:
    
    DeprecatedStatus
  - deprecatedStatusAsString
```
public final String deprecatedStatusAsString()
```
    The deprecation status of the extension version.
    
    Valid values include:
    - LIVE: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    - DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    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().
    Returns:
    The deprecation status of the extension version.
    
    Valid values include:
    
    LIVE: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    
    DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    See Also:
    
    DeprecatedStatus
  - loggingConfig
```
public final LoggingConfig loggingConfig()
```
    Contains logging configuration information for an extension.
    
    Returns:
    
    Contains logging configuration information for an extension.
  - executionRoleArn
```
public final String executionRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
  - visibility
```
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. Currently, AWS CloudFormation marks any types you register as PRIVATE.
    - PUBLIC: The extension is publically visible and usable within any Amazon 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().
    Returns:
    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. Currently, AWS CloudFormation marks any types you register as PRIVATE.
    
    PUBLIC: The extension is publically visible and usable within any Amazon account.
    See Also:
    
    Visibility
  - visibilityAsString
```
public 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. Currently, AWS CloudFormation marks any types you register as PRIVATE.
    - PUBLIC: The extension is publically visible and usable within any Amazon 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().
    Returns:
    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. Currently, AWS CloudFormation marks any types you register as PRIVATE.
    
    PUBLIC: The extension is publically visible and usable within any Amazon account.
    See Also:
    
    Visibility
  - sourceUrl
```
public final String sourceUrl()
```
    The URL of the source code for the extension.
    
    Returns:
    
    The URL of the source code for the extension.
  - documentationUrl
```
public final String documentationUrl()
```
    The URL of a page providing detailed documentation for this extension.
    
    Returns:
    
    The URL of a page providing detailed documentation for this extension.
  - lastUpdated
```
public final Instant lastUpdated()
```
    When the specified extension version was registered.
    
    Returns:
    
    When the specified extension version was registered.
  - timeCreated
```
public final Instant timeCreated()
```
    When the specified extension version was registered.
    
    Returns:
    
    When the specified extension version was registered.
  - toBuilder
```
public DescribeTypeResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeTypeResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeTypeResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeTypeResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

type

typeAsString

typeName

defaultVersionId

isDefaultVersion

description

schema

provisioningType

provisioningTypeAsString

deprecatedStatus

deprecatedStatusAsString

loggingConfig

executionRoleArn

visibility

visibilityAsString

sourceUrl

documentationUrl

lastUpdated

timeCreated

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields