Type Members

1.  final case class Arn(template: String, absolute: Option[Boolean] = None, noRegion: Option[Boolean] = None, noAccount: Option[Boolean] = None) extends Product with Serializable

   Specifies an ARN template for the resource.

   Specifies an ARN template for the resource.

   template

   Defines the ARN template. The provided string contains URI-template style label placeholders that contain the name of one of the identifiers defined in the identifiers property of the resource. These labels can be substituted at runtime with the actual identifiers of the resource. Every identifier name of the resource MUST have corresponding label of the same name. Note that percent-encoding **is not** performed on these placeholder values; they are to be replaced literally. For relative ARN templates that have not set absolute to true, the template string contains only the resource part of the ARN (for example, foo/{MyResourceId}). Relative ARNs MUST NOT start with "/".

   absolute

   Set to true to indicate that the ARN template contains a fully-formed ARN that does not need to be merged with the service. This type of ARN MUST be used when the identifier of a resource is an ARN or is based on the ARN identifier of a parent resource.

   noRegion

   Set to true to specify that the ARN does not contain a region. If not set, or if set to false, the resolved ARN will contain a placeholder for the region. This can only be set to true if absolute is not set or is false.

   noAccount

   Set to true to specify that the ARN does not contain an account ID. If not set, or if set to false, the resolved ARN will contain a placeholder for the customer account ID. This can only be set to true if absolute is not set or is false.

2.  type ArnNamespace = api.ArnNamespace.Type

   A string representing a service's ARN namespace.

3.  final case class ArnReference(_type: Option[String] = None, resource: Option[String] = None, service: Option[String] = None) extends Product with Serializable

   Marks a string as containing an ARN.

   Marks a string as containing an ARN.

   resource

   An absolute shape ID that references the Smithy resource type contained in the ARN (e.g., com.foo#SomeResource). The targeted resource is not required to be found in the model, allowing for external shapes to be referenced without needing to take on an additional dependency. If the shape is found in the model, it MUST target a resource shape, and the resource MUST be found within the closure of the referenced service shape.

   service

   The Smithy service absolute shape ID that is referenced by the ARN. The targeted service is not required to be found in the model, allowing for external shapes to be referenced without needing to take on an additional dependency.

4.  final case class ClientDiscoveredEndpoint(required: Boolean) extends Product with Serializable

   Indicates that the target operation should use the client's endpoint discovery logic.

   Indicates that the target operation should use the client's endpoint discovery logic.

   required

   This field denotes whether or not this operation requires the use of a specific endpoint. If this field is false, the standard regional endpoint for a service can handle this request. The client will start sending requests to the standard regional endpoint while working to discover a more specific endpoint.

5.  final case class ClientEndpointDiscovery(operation: ShapeId, error: Option[ShapeId] = None) extends Product with Serializable

   Configures endpoint discovery for the service.

   Configures endpoint discovery for the service.

   operation

   Indicates the operation that clients should use to discover endpoints for the service.

   error

   Indicates the error that tells clients that the endpoint they are using is no longer valid. This error MUST be bound to any operation bound to the service which is marked with the aws.api#clientDiscoveredEndpoint trait.

6.  final case class ClientEndpointDiscoveryId() extends Product with Serializable

   Indicates members of the operation input which should be use to discover endpoints.

7.  type CloudFormationName = api.CloudFormationName.Type

   A string representing a CloudFormation service name.

8.  final case class ControlPlane() extends Product with Serializable

   Defines a service, resource, or operation as operating on the control plane.

9.  sealed abstract class Data extends Value

   Designates the target as containing data of a known classification level.

10.  final case class DataPlane() extends Product with Serializable

    Defines a service, resource, or operation as operating on the data plane.

11.  final case class Service(sdkId: String, arnNamespace: Option[ArnNamespace] = None, cloudFormationName: Option[CloudFormationName] = None, cloudTrailEventSource: Option[String] = None, docId: Option[String] = None, endpointPrefix: Option[String] = None) extends Product with Serializable

    An AWS service is defined using the aws.api#service trait.

    An AWS service is defined using the aws.api#service trait. This trait provides information about the service like the name used to generate AWS SDK client classes and the namespace used in ARNs.

    sdkId

    The sdkId property is a required string value that specifies the AWS SDK service ID (e.g., "API Gateway"). This value is used for generating client names in SDKs and for linking between services.

    arnNamespace

    The arnNamespace property is a string value that defines the ARN service namespace of the service (e.g., "apigateway"). This value is used in ARNs assigned to resources in the service. If not set, this value defaults to the lowercase name of the service shape.

    cloudFormationName

    The cloudFormationName property is a string value that specifies the AWS CloudFormation service name (e.g., ApiGateway). When not set, this value defaults to the name of the service shape. This value is part of the CloudFormation resource type name that is automatically assigned to resources in the service (e.g., AWS::<NAME>::resourceName).

    cloudTrailEventSource

    The cloudTrailEventSource property is a string value that defines the AWS customer-facing eventSource property contained in CloudTrail event records emitted by the service. If not specified, this value defaults to the arnNamespace plus .amazonaws.com.

    docId

    The docId property is a string value that defines the identifier used to implemention linking between service and SDK documentation for AWS services. If not specified, this value defaults to the sdkId in lower case plus the service version property, separated by dashes.

    endpointPrefix

    The endpointPrefix property is a string value that identifies which endpoint in a given region should be used to connect to the service. For example, most services in the AWS standard partition have endpoints which follow the format: {endpointPrefix}.{region}.amazonaws.com. A service with the endpoint prefix example in the region us-west-2 might have the endpoint example.us-west-2.amazonaws.com. This value is not unique across services and is subject to change. Therefore, it MUST NOT be used for client naming or for any other purpose that requires a static, unique identifier. sdkId should be used for those purposes. Additionally, this value can be used to attempt to resolve endpoints.

12.  final case class TagEnabled(disableDefaultOperations: Option[Boolean] = None) extends Product with Serializable

    Annotates a service as having tagging on 1 or more resources and associated APIs to perform CRUD operations on those tags

    Annotates a service as having tagging on 1 or more resources and associated APIs to perform CRUD operations on those tags

    disableDefaultOperations

    The disableDefaultOperations property is a boolean value that specifies if the service does not have the standard tag operations supporting all resources on the service. Default value is false

13.  type TagOperationReference = api.TagOperationReference.Type

    Points to an operation designated for a tagging APi

14.  final case class Taggable(property: Option[String] = None, apiConfig: Option[TaggableApiConfig] = None, disableSystemTags: Option[Boolean] = None) extends Product with Serializable

    Indicates a resource supports CRUD operations for tags.

    Indicates a resource supports CRUD operations for tags. Either through resource lifecycle or instance operations or tagging operations on the service.

    property

    The property property is a string value that identifies which resource property represents tags for the resource.

    apiConfig

    Specifies configuration for resource specific tagging APIs if the resource has them.

    disableSystemTags

    Flag indicating if the resource is not able to carry AWS system level. Used by service principals. Default value is false

15.  final case class TaggableApiConfig(tagApi: TagOperationReference, untagApi: TagOperationReference, listTagsApi: TagOperationReference) extends Product with Serializable

    Structure representing the configuration of resource specific tagging APIs

    Structure representing the configuration of resource specific tagging APIs

    tagApi

    The tagApi property is a string value that references a non-instance or create operation that creates or updates tags on the resource.

    untagApi

    The untagApi property is a string value that references a non-instance operation that removes tags on the resource.

    listTagsApi

    The listTagsApi property is a string value that references a non- instance operation which gets the current tags on the resource.