Package software.amazon.smithy.aws.apigateway.traits

Class ResourcePolicyTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.apigateway.traits.ResourcePolicyTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

public final class ResourcePolicyTrait
extends AbstractTrait

Defines a resource policy for an API Gateway REST API. A resource policy is a JSON policy document attached to an API that controls whether a specified principal (typically an IAM role or group) can invoke the API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourcePolicyTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
ResourcePolicyTrait(Node value)

Method Summary

Modifier and Type	Method	Description
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
Node	getValue()	Gets the resource policy document value.

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

equals, getSourceLocation, hashCode, 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 Details

ID

public static final ShapeId ID

Constructor Details

ResourcePolicyTrait

public ResourcePolicyTrait(Node value)

Method Details

getValue

public Node getValue()

Gets the resource policy document value.

Returns:

Returns the resource policy as a Node.

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.