Package software.amazon.smithy.aws.traits

Class ArnTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.traits.ArnTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<ArnTrait>

public final class ArnTrait
extends AbstractTrait
implements ToSmithyBuilder<ArnTrait>

Configures the ARN template of a resource shape, relative to the service to which a resource is bound.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArnTrait.Builder	Builder for ArnTrait.
static class	ArnTrait.Provider
static class	ArnTrait.ResourceDelimiter

Field Summary

Fields

Modifier and Type	Field	Description
static ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static ArnTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
boolean	equals(java.lang.Object other)
java.util.List<java.lang.String>	getLabels()
java.util.Optional<ArnTrait.ResourceDelimiter>	getResourceDelimiter()
java.lang.String	getTemplate()
int	hashCode()
boolean	isAbsolute()
boolean	isNoAccount()
boolean	isNoRegion()
boolean	isReusable()
ArnTrait.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

getSourceLocation, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Detail

ID

public static final ShapeId ID

Method Detail

builder

public static ArnTrait.Builder builder()

Returns:

Returns a builder used to create ArnTrait.

isNoAccount

public boolean isNoAccount()

Returns:

Returns the noAccount setting.

isNoRegion

public boolean isNoRegion()

Returns:

Returns the noRegion setting.

isAbsolute

public boolean isAbsolute()

Returns:

Returns whether or not the ARN is absolute.

getTemplate

public java.lang.String getTemplate()

Returns:

Gets the template of the ARN.

getLabels

public java.util.List<java.lang.String> getLabels()

Returns:

Returns the label placeholder variable names.

getResourceDelimiter

public java.util.Optional<ArnTrait.ResourceDelimiter> getResourceDelimiter()

Returns:

Returns the resource delimiter for absolute ARNs.

isReusable

public boolean isReusable()

Returns:

Returns if the ARN may be reused for different instances of a resource.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public ArnTrait.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<ArnTrait>

Returns:

a builder for type T

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class AbstractTrait

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTrait