iam_set_security_token_service_preferences: Sets the specified version of the global endpoint token as...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

Sets the specified version of the global endpoint token as the token version used for the AWS account.

Usage

1
iam_set_security_token_service_preferences(GlobalEndpointTokenVersion)

Arguments

GlobalEndpointTokenVersion

[required] The version of the global endpoint token. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide.

Details

By default, AWS Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. AWS recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see AWS Regions and Endpoints in the AWS General Reference.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide.

To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

Request syntax

1
2
3
svc$set_security_token_service_preferences(
  GlobalEndpointTokenVersion = "v1Token"|"v2Token"
)

Examples

1
2
3
4
5
# The following command sets the STS global endpoint token to version 2.
# Version 2 tokens are valid in all Regions.
svc$set_security_token_service_preferences(
  GlobalEndpointTokenVersion = "v2Token"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.