@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
| Constructor and Description |
|---|
DescribeTypeResult() |
| Modifier and Type | Method and Description |
|---|---|
DescribeTypeResult |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the type.
|
String |
getDefaultVersionId()
The ID of the default version of the type.
|
String |
getDeprecatedStatus()
The deprecation status of the type.
|
String |
getDescription()
The description of the registered type.
|
String |
getDocumentationUrl()
The URL of a page providing detailed documentation for this type.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the IAM execution role used to register the type.
|
Boolean |
getIsDefaultVersion()
Whether the specified type version is set as the default version.
|
Date |
getLastUpdated()
When the specified type version was registered.
|
LoggingConfig |
getLoggingConfig()
Contains logging configuration information for a type.
|
String |
getProvisioningType()
The provisioning behavior of the type.
|
String |
getSchema()
The schema that defines the type.
|
String |
getSourceUrl()
The URL of the source code for the type.
|
Date |
getTimeCreated()
When the specified type version was registered.
|
String |
getType()
The kind of type.
|
String |
getTypeName()
The name of the registered type.
|
String |
getVisibility()
The scope at which the type is visible and usable in CloudFormation operations.
|
int |
hashCode() |
Boolean |
isDefaultVersion()
Whether the specified type version is set as the default version.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the type.
|
void |
setDefaultVersionId(String defaultVersionId)
The ID of the default version of the type.
|
void |
setDeprecatedStatus(String deprecatedStatus)
The deprecation status of the type.
|
void |
setDescription(String description)
The description of the registered type.
|
void |
setDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this type.
|
void |
setExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to register the type.
|
void |
setIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified type version is set as the default version.
|
void |
setLastUpdated(Date lastUpdated)
When the specified type version was registered.
|
void |
setLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for a type.
|
void |
setProvisioningType(String provisioningType)
The provisioning behavior of the type.
|
void |
setSchema(String schema)
The schema that defines the type.
|
void |
setSourceUrl(String sourceUrl)
The URL of the source code for the type.
|
void |
setTimeCreated(Date timeCreated)
When the specified type version was registered.
|
void |
setType(String type)
The kind of type.
|
void |
setTypeName(String typeName)
The name of the registered type.
|
void |
setVisibility(String visibility)
The scope at which the type is visible and usable in CloudFormation operations.
|
String |
toString()
Returns a string representation of this object.
|
DescribeTypeResult |
withArn(String arn)
The Amazon Resource Name (ARN) of the type.
|
DescribeTypeResult |
withDefaultVersionId(String defaultVersionId)
The ID of the default version of the type.
|
DescribeTypeResult |
withDeprecatedStatus(DeprecatedStatus deprecatedStatus)
The deprecation status of the type.
|
DescribeTypeResult |
withDeprecatedStatus(String deprecatedStatus)
The deprecation status of the type.
|
DescribeTypeResult |
withDescription(String description)
The description of the registered type.
|
DescribeTypeResult |
withDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this type.
|
DescribeTypeResult |
withExecutionRoleArn(String executionRoleArn)
The Amazon Resource Name (ARN) of the IAM execution role used to register the type.
|
DescribeTypeResult |
withIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified type version is set as the default version.
|
DescribeTypeResult |
withLastUpdated(Date lastUpdated)
When the specified type version was registered.
|
DescribeTypeResult |
withLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for a type.
|
DescribeTypeResult |
withProvisioningType(ProvisioningType provisioningType)
The provisioning behavior of the type.
|
DescribeTypeResult |
withProvisioningType(String provisioningType)
The provisioning behavior of the type.
|
DescribeTypeResult |
withSchema(String schema)
The schema that defines the type.
|
DescribeTypeResult |
withSourceUrl(String sourceUrl)
The URL of the source code for the type.
|
DescribeTypeResult |
withTimeCreated(Date timeCreated)
When the specified type version was registered.
|
DescribeTypeResult |
withType(RegistryType type)
The kind of type.
|
DescribeTypeResult |
withType(String type)
The kind of type.
|
DescribeTypeResult |
withTypeName(String typeName)
The name of the registered type.
|
DescribeTypeResult |
withVisibility(String visibility)
The scope at which the type is visible and usable in CloudFormation operations.
|
DescribeTypeResult |
withVisibility(Visibility visibility)
The scope at which the type is visible and usable in CloudFormation operations.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadatapublic void setArn(String arn)
The Amazon Resource Name (ARN) of the type.
arn - The Amazon Resource Name (ARN) of the type.public String getArn()
The Amazon Resource Name (ARN) of the type.
public DescribeTypeResult withArn(String arn)
The Amazon Resource Name (ARN) of the type.
arn - The Amazon Resource Name (ARN) of the type.public void setType(String type)
The kind of type.
Currently the only valid value is RESOURCE.
type - The kind of type.
Currently the only valid value is RESOURCE.
RegistryTypepublic String getType()
The kind of type.
Currently the only valid value is RESOURCE.
Currently the only valid value is RESOURCE.
RegistryTypepublic DescribeTypeResult withType(String type)
The kind of type.
Currently the only valid value is RESOURCE.
type - The kind of type.
Currently the only valid value is RESOURCE.
RegistryTypepublic DescribeTypeResult withType(RegistryType type)
The kind of type.
Currently the only valid value is RESOURCE.
type - The kind of type.
Currently the only valid value is RESOURCE.
RegistryTypepublic void setTypeName(String typeName)
The name of the registered type.
typeName - The name of the registered type.public String getTypeName()
The name of the registered type.
public DescribeTypeResult withTypeName(String typeName)
The name of the registered type.
typeName - The name of the registered type.public void setDefaultVersionId(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 .
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 .
public String getDefaultVersionId()
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 .
To set the default version of a type, use SetTypeDefaultVersion .
public DescribeTypeResult withDefaultVersionId(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 .
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 .
public void setIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified type version is set as the default version.
isDefaultVersion - Whether the specified type version is set as the default version.public Boolean getIsDefaultVersion()
Whether the specified type version is set as the default version.
public DescribeTypeResult withIsDefaultVersion(Boolean isDefaultVersion)
Whether the specified type version is set as the default version.
isDefaultVersion - Whether the specified type version is set as the default version.public Boolean isDefaultVersion()
Whether the specified type version is set as the default version.
public void setDescription(String description)
The description of the registered type.
description - The description of the registered type.public String getDescription()
The description of the registered type.
public DescribeTypeResult withDescription(String description)
The description of the registered type.
description - The description of the registered type.public void setSchema(String schema)
The schema that defines the type.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
schema - The schema that defines the type.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public String getSchema()
The schema that defines the type.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public DescribeTypeResult withSchema(String schema)
The schema that defines the type.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
schema - The schema that defines the type.
For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
public void setProvisioningType(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
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
ProvisioningTypepublic String getProvisioningType()
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
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
ProvisioningTypepublic DescribeTypeResult withProvisioningType(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
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
ProvisioningTypepublic DescribeTypeResult withProvisioningType(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
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
ProvisioningTypepublic void setDeprecatedStatus(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.
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.
DeprecatedStatuspublic String getDeprecatedStatus()
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.
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.
DeprecatedStatuspublic DescribeTypeResult withDeprecatedStatus(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.
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.
DeprecatedStatuspublic DescribeTypeResult withDeprecatedStatus(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.
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.
DeprecatedStatuspublic void setLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for a type.
loggingConfig - Contains logging configuration information for a type.public LoggingConfig getLoggingConfig()
Contains logging configuration information for a type.
public DescribeTypeResult withLoggingConfig(LoggingConfig loggingConfig)
Contains logging configuration information for a type.
loggingConfig - Contains logging configuration information for a type.public void setExecutionRoleArn(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.
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.public String getExecutionRoleArn()
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.
public DescribeTypeResult withExecutionRoleArn(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.
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.public void setVisibility(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.
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.
Visibilitypublic String getVisibility()
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.
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.
Visibilitypublic DescribeTypeResult withVisibility(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.
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.
Visibilitypublic DescribeTypeResult withVisibility(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.
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.
Visibilitypublic void setSourceUrl(String sourceUrl)
The URL of the source code for the type.
sourceUrl - The URL of the source code for the type.public String getSourceUrl()
The URL of the source code for the type.
public DescribeTypeResult withSourceUrl(String sourceUrl)
The URL of the source code for the type.
sourceUrl - The URL of the source code for the type.public void setDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this type.
documentationUrl - The URL of a page providing detailed documentation for this type.public String getDocumentationUrl()
The URL of a page providing detailed documentation for this type.
public DescribeTypeResult withDocumentationUrl(String documentationUrl)
The URL of a page providing detailed documentation for this type.
documentationUrl - The URL of a page providing detailed documentation for this type.public void setLastUpdated(Date lastUpdated)
When the specified type version was registered.
lastUpdated - When the specified type version was registered.public Date getLastUpdated()
When the specified type version was registered.
public DescribeTypeResult withLastUpdated(Date lastUpdated)
When the specified type version was registered.
lastUpdated - When the specified type version was registered.public void setTimeCreated(Date timeCreated)
When the specified type version was registered.
timeCreated - When the specified type version was registered.public Date getTimeCreated()
When the specified type version was registered.
public DescribeTypeResult withTimeCreated(Date timeCreated)
When the specified type version was registered.
timeCreated - When the specified type version was registered.public String toString()
toString in class ObjectObject.toString()public DescribeTypeResult clone()
Copyright © 2021. All rights reserved.