Package software.amazon.smithy.aws.cloudformation.traits

Class CfnResource

java.lang.Object

software.amazon.smithy.aws.cloudformation.traits.CfnResource

All Implemented Interfaces:

ToSmithyBuilder<CfnResource>

public final class CfnResource
extends Object
implements ToSmithyBuilder<CfnResource>

Contains extracted resource information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnResource.Builder

Method Summary

Modifier and Type	Method	Description
static CfnResource.Builder	builder()
List<Set<String>>	getAdditionalIdentifiers()	Get a list of sets of member shape ids, each set can be used to identify the CloudFormation resource in addition to its primary identifier(s).
Set<String>	getCreateOnlyProperties()	Get create-specifiable-only property definitions of the CloudFormation resource.
Set<ShapeId>	getExcludedProperties()	Get members that have been explicitly excluded from the CloudFormation resource.
Set<String>	getPrimaryIdentifiers()	Gets a set of identifier names that represent the primary way to identify a CloudFormation resource.
Map<String,CfnResourceProperty>	getProperties()	Get all property definitions of the CloudFormation resource.
Optional<CfnResourceProperty>	getProperty(String propertyName)	Gets the definition of the specified property of the CloudFormation resource.
Set<String>	getReadOnlyProperties()	Get read-only property definitions of the CloudFormation resource.
Set<String>	getWriteOnlyProperties()	Get write-only property definitions of the CloudFormation resource.
CfnResource.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static CfnResource.Builder builder()

getProperties

public Map<String,CfnResourceProperty> getProperties()

Get all property definitions of the CloudFormation resource.

Properties excluded by the cfnExcludedProperty trait are not returned.

Returns:

Returns all members that map to CloudFormation resource properties.

See Also:

• getExcludedProperties()

getProperty

public Optional<CfnResourceProperty> getProperty(String propertyName)

Gets the definition of the specified property of the CloudFormation resource.

An empty Optional will be returned if the requested property has been excluded by the cfnExcludedProperty trait.

Parameters:

propertyName - Name of the property to retrieve

Returns:

The property definition.

See Also:

• getExcludedProperties()

getCreateOnlyProperties

public Set<String> getCreateOnlyProperties()

Get create-specifiable-only property definitions of the CloudFormation resource. These properties can be specified only during resource creation and can be returned in a read or list request.

Returns:

Returns create-only member names that map to CloudFormation resource properties.

getReadOnlyProperties

public Set<String> getReadOnlyProperties()

Get read-only property definitions of the CloudFormation resource. These properties can be returned by a read or list request, but cannot be set by the user.

Returns:

Returns read-only member names that map to CloudFormation resource properties.

getWriteOnlyProperties

public Set<String> getWriteOnlyProperties()

Get write-only property definitions of the CloudFormation resource. These properties can be specified by the user, but cannot be returned by a read or list request.

Returns:

Returns write-only member names that map to CloudFormation resource properties.

getExcludedProperties

public Set<ShapeId> getExcludedProperties()

Get members that have been explicitly excluded from the CloudFormation resource.

Returns:

Returns members that have been excluded from a CloudFormation resource.

getPrimaryIdentifiers

public Set<String> getPrimaryIdentifiers()

Gets a set of identifier names that represent the primary way to identify a CloudFormation resource. This uniquely identifies an individual instance of the resource type, and can be one or more properties to represent composite-key identifiers.

Returns:

Returns the identifier set primarily used to access a CloudFormation resource.

getAdditionalIdentifiers

public List<Set<String>> getAdditionalIdentifiers()

Get a list of sets of member shape ids, each set can be used to identify the CloudFormation resource in addition to its primary identifier(s).

Returns:

Returns identifier sets used to access a CloudFormation resource.

toBuilder

public CfnResource.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<CfnResource>

Returns:

a builder for type T