Package software.amazon.smithy.model.traits

Interface ResourceBinding

All Superinterfaces:
ToNode
All Known Implementing Classes:
ResourceDeletionBinding, ResourceLifecycleBinding
public interface ResourceBinding extends ToNode
Common surface shared by the binding structures of the resource lifecycle traits: every binding names an affected resource and may declare where to find that resource's identifiers.

ResourceLifecycleBinding adds property location for the create, put, read, and update traits; ResourceDeletionBinding omits properties because a resource is deleted by its identifiers alone.

  • Method Details

    • getResource

      ShapeId getResource()
      Returns:
      Gets the shape ID of the affected resource.

    • getIdentifiers

      Map<String,ResourceMemberBinding> getIdentifiers()
      Returns:
      Gets the explicit map of resource identifier name to a locator for its value.

    • getIdentifiersFrom

      Optional<String> getIdentifiersFrom()
      Returns:
      Gets the structural JMESPath from whose members identifiers are inferred by name.