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

Class CfnResourceProperty

java.lang.Object

software.amazon.smithy.aws.cloudformation.traits.CfnResourceProperty

All Implemented Interfaces:

software.amazon.smithy.utils.ToSmithyBuilder<CfnResourceProperty>

public final class CfnResourceProperty
extends Object
implements software.amazon.smithy.utils.ToSmithyBuilder<CfnResourceProperty>

Contains extracted resource property information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnResourceProperty.Builder

Method Summary

Modifier and Type	Method	Description
static CfnResourceProperty.Builder	builder()
Set<CfnResourceIndex.Mutability>	getMutabilities()	Gets all of the CloudFormation-specific property mutability options associated with this resource property.
software.amazon.smithy.model.shapes.ShapeId	getShapeId()	Gets the shape ID used to represent this property.
boolean	hasExplicitMutability()	Returns true if the property's mutability was configured explicitly by the use of a trait instead of derived through its lifecycle bindings within a resource.
CfnResourceProperty.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static CfnResourceProperty.Builder builder()

getShapeId

public software.amazon.smithy.model.shapes.ShapeId getShapeId()

Gets the shape ID used to represent this property.

Returns:

Returns the shape ID.

hasExplicitMutability

public boolean hasExplicitMutability()

Returns true if the property's mutability was configured explicitly by the use of a trait instead of derived through its lifecycle bindings within a resource.

Also returns true for identifiers, since their mutability is inherent

Returns:

Returns true if the mutability is explicitly defined by a trait or if property is an identifier

See Also:

• CfnMutabilityTrait

getMutabilities

public Set<CfnResourceIndex.Mutability> getMutabilities()

Gets all of the CloudFormation-specific property mutability options associated with this resource property.

Returns:

Returns the mutabilities.

toBuilder

public CfnResourceProperty.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<CfnResourceProperty>