Skip to content

Resource Traits

Juli Tera edited this page Apr 19, 2024 · 3 revisions

This wiki contains a mapping between Smithy Resource traits and generated Ruby code.

Resource traits will not be supported at this time.

nestedProperties trait

Allows the binding of resource properties to occur within a nested structure deeper than the lifecycle operation's input or output shape.

See Smithy Documentation for details.

notProperty trait

Indicates that a top-level input or output shape member is not bound to a resource property.

See Smithy Documentation for details.

noReplace trait

Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.

See Smithy Documentation for details.

property trait

Binds a top-level input or output structure member to a resource property with a different name.

See Smithy Documentation for details.

references trait

Defines a design-time reference to Resource shapes. Resource references allow tooling to understand the relationships between resources and how to dereference the location of a resource.

See Smithy Documentation for details.

resourceIdentifier trait

Indicates that the targeted structure member provides an identifier for a resource.

See Smithy Documentation for details.