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

description

schema

provisioningType

provisioningTypeAsString

deprecatedStatus

deprecatedStatusAsString

loggingConfig

executionRoleArn

visibility

visibilityAsString

sourceUrl

documentationUrl

lastUpdated

timeCreated

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields