Struct aws_sdk_iam::client::fluent_builders::SetSecurityTokenServicePreferences

pub struct SetSecurityTokenServicePreferences { /* private fields */ }

Fluent builder constructing a request to SetSecurityTokenServicePreferences.

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region in the IAM User Guide.

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

Implementations

impl SetSecurityTokenServicePreferences

pub async fn send(
    self
) -> Result<SetSecurityTokenServicePreferencesOutput, SdkError<SetSecurityTokenServicePreferencesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn global_endpoint_token_version(
    self,
    input: GlobalEndpointTokenVersion
) -> Self

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services 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 Amazon Web Services Region in the IAM User Guide.

pub fn set_global_endpoint_token_version(
    self,
    input: Option<GlobalEndpointTokenVersion>
) -> Self

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services 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 Amazon Web Services Region in the IAM User Guide.

Trait Implementations

impl Clone for SetSecurityTokenServicePreferences

fn clone(&self) -> SetSecurityTokenServicePreferences

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetSecurityTokenServicePreferences

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.