DescribeTypeResponse.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsResponse.Builder, Buildable, CloudFormationResponse.Builder, CopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>, SdkBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeTypeResponse
```
public static interface DescribeTypeResponse.Builder
extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DescribeTypeResponse.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) of the type.
`DescribeTypeResponse.Builder`	`defaultVersionId(String defaultVersionId)` The ID of the default version of the type.
`DescribeTypeResponse.Builder`	`deprecatedStatus(DeprecatedStatus deprecatedStatus)` The deprecation status of the type.
`DescribeTypeResponse.Builder`	`deprecatedStatus(String deprecatedStatus)` The deprecation status of the type.
`DescribeTypeResponse.Builder`	`description(String description)` The description of the registered type.
`DescribeTypeResponse.Builder`	`documentationUrl(String documentationUrl)` The URL of a page providing detailed documentation for this type.
`DescribeTypeResponse.Builder`	`executionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the IAM execution role used to register the type.
`DescribeTypeResponse.Builder`	`lastUpdated(Instant lastUpdated)` When the specified type version was registered.
`default DescribeTypeResponse.Builder`	`loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)` Contains logging configuration information for a type.
`DescribeTypeResponse.Builder`	`loggingConfig(LoggingConfig loggingConfig)` Contains logging configuration information for a type.
`DescribeTypeResponse.Builder`	`provisioningType(ProvisioningType provisioningType)` The provisioning behavior of the type.
`DescribeTypeResponse.Builder`	`provisioningType(String provisioningType)` The provisioning behavior of the type.
`DescribeTypeResponse.Builder`	`schema(String schema)` The schema that defines the type.
`DescribeTypeResponse.Builder`	`sourceUrl(String sourceUrl)` The URL of the source code for the type.
`DescribeTypeResponse.Builder`	`timeCreated(Instant timeCreated)` When the specified type version was registered.
`DescribeTypeResponse.Builder`	`type(RegistryType type)` The kind of type.
`DescribeTypeResponse.Builder`	`type(String type)` The kind of type.
`DescribeTypeResponse.Builder`	`typeName(String typeName)` The name of the registered type.
`DescribeTypeResponse.Builder`	`visibility(String visibility)` The scope at which the type is visible and usable in CloudFormation operations.
`DescribeTypeResponse.Builder`	`visibility(Visibility visibility)` The scope at which the type is visible and usable in CloudFormation operations.

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse.Builder
build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - arn
```
DescribeTypeResponse.Builder arn(String arn)
```
    The Amazon Resource Name (ARN) of the type.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - type
```
DescribeTypeResponse.Builder type(String type)
```
    The kind of type.
    
    Currently the only valid value is RESOURCE.
    
    Parameters:
    
    type - The kind of type.
    
    Currently the only valid value is RESOURCE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RegistryType, RegistryType
  - type
```
DescribeTypeResponse.Builder type(RegistryType type)
```
    The kind of type.
    
    Currently the only valid value is RESOURCE.
    
    Parameters:
    
    type - The kind of type.
    
    Currently the only valid value is RESOURCE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RegistryType, RegistryType
  - typeName
```
DescribeTypeResponse.Builder typeName(String typeName)
```
    The name of the registered type.
    
    Parameters:
    
    typeName - The name of the registered type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - defaultVersionId
```
DescribeTypeResponse.Builder defaultVersionId(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 .
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
DescribeTypeResponse.Builder description(String description)
```
    The description of the registered type.
    
    Parameters:
    
    description - The description of the registered type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schema
```
DescribeTypeResponse.Builder schema(String schema)
```
    The schema that defines the type.
    
    For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
    
    Parameters:
    
    schema - The schema that defines the type.
    
    For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - provisioningType
```
DescribeTypeResponse.Builder provisioningType(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisioningType, ProvisioningType
  - provisioningType
```
DescribeTypeResponse.Builder provisioningType(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProvisioningType, ProvisioningType
  - deprecatedStatus
```
DescribeTypeResponse.Builder deprecatedStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeprecatedStatus, DeprecatedStatus
  - deprecatedStatus
```
DescribeTypeResponse.Builder deprecatedStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeprecatedStatus, DeprecatedStatus
  - loggingConfig
```
DescribeTypeResponse.Builder loggingConfig(LoggingConfig loggingConfig)
```
    Contains logging configuration information for a type.
    
    Parameters:
    
    loggingConfig - Contains logging configuration information for a type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - loggingConfig
```
default DescribeTypeResponse.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
```
    Contains logging configuration information for a type.
    This is a convenience that creates an instance of the 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).
    
    Parameters:
    
    loggingConfig - a consumer that will call methods on LoggingConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    loggingConfig(LoggingConfig)
  - executionRoleArn
```
DescribeTypeResponse.Builder executionRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - visibility
```
DescribeTypeResponse.Builder visibility(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility, Visibility
  - visibility
```
DescribeTypeResponse.Builder visibility(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility, Visibility
  - sourceUrl
```
DescribeTypeResponse.Builder sourceUrl(String sourceUrl)
```
    The URL of the source code for the type.
    
    Parameters:
    
    sourceUrl - The URL of the source code for the type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentationUrl
```
DescribeTypeResponse.Builder documentationUrl(String documentationUrl)
```
    The URL of a page providing detailed documentation for this type.
    
    Parameters:
    
    documentationUrl - The URL of a page providing detailed documentation for this type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastUpdated
```
DescribeTypeResponse.Builder lastUpdated(Instant lastUpdated)
```
    When the specified type version was registered.
    
    Parameters:
    
    lastUpdated - When the specified type version was registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeCreated
```
DescribeTypeResponse.Builder timeCreated(Instant timeCreated)
```
    When the specified type version was registered.
    
    Parameters:
    
    timeCreated - When the specified type version was registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface DescribeTypeResponse.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

arn

type

type

typeName

defaultVersionId

description

schema

provisioningType

provisioningType

deprecatedStatus

deprecatedStatus

loggingConfig

loggingConfig

executionRoleArn

visibility

visibility

sourceUrl

documentationUrl

lastUpdated

timeCreated