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. 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 thearnNamespace
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 thesdkId
in lower case plus the serviceversion
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.
- Alphabetic
- By Inheritance
- Service
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Service(sdkId: String, arnNamespace: Option[ArnNamespace] = None, cloudFormationName: Option[CloudFormationName] = None, cloudTrailEventSource: Option[String] = None, docId: Option[String] = None, endpointPrefix: Option[String] = None)
- 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 thearnNamespace
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 thesdkId
in lower case plus the serviceversion
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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val arnNamespace: Option[ArnNamespace]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val cloudFormationName: Option[CloudFormationName]
- val cloudTrailEventSource: Option[String]
- val docId: Option[String]
- val endpointPrefix: Option[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val sdkId: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()