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.
Attributes
- 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 thearnNamespace
plus.amazonaws.com
.- 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.- 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.- Companion:
- object
- Graph
- Supertypes