Account-based endpoints - AWS SDKs and Tools (original) (raw)
Account-based endpoints help ensure high performance and scalability by using your AWS account ID to route requests for services that support this feature. When you use an AWS SDK and service that support account-based endpoints, the SDK client constructs and uses an account-based endpoint rather than a regional endpoint. If the account ID isn't visible to the SDK client, the client will use the regional endpoint. Account-based endpoints take the form ofhttps://`<account-id>`.ddb.`<region>`.amazonaws.com, where `<account-id>` and`<region>` are your AWS account ID and AWS Region.
Configure this functionality by using the following:
aws_account_id - shared AWS config file setting
AWS_ACCOUNT_ID - environment variable
aws.accountId - JVM system property: Java/Kotlin only
The AWS account ID. Used for account-based endpoint routing. An AWS account ID has a format like 111122223333.
Account-based endpoint routing provides better request performance for some services.
account_id_endpoint_mode - shared AWS config file setting
AWS_ACCOUNT_ID_ENDPOINT_MODE - environment variable
aws.accountIdEndpointMode - JVM system property: Java/Kotlin only
This setting is used to turn off account-based endpoint routing if necessary, and bypass account-based rules.
Default value: preferred
Valid values:
preferred– The endpoint should include account ID if available.disabled– A resolved endpoint doesn't include account ID.required– The endpoint must include account ID. If the account ID isn't available, the SDK throws an error.
Support by AWS SDKs and tools
The following SDKs support the features and settings described in this topic. Any partial exceptions are noted. Any JVM system property settings are supported by the AWS SDK for Java and the AWS SDK for Kotlin only.
Standardized features
Application ID
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.