public static interface AssumeRoleWithSamlRequest.Builder extends StsRequest.Builder, CopyableBuilder<AssumeRoleWithSamlRequest.Builder,AssumeRoleWithSamlRequest>
Modifier and Type | Method and Description |
---|---|
AssumeRoleWithSamlRequest.Builder |
durationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.
|
AssumeRoleWithSamlRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
AssumeRoleWithSamlRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
AssumeRoleWithSamlRequest.Builder |
policy(String policy)
An IAM policy in JSON format.
|
AssumeRoleWithSamlRequest.Builder |
principalArn(String principalArn)
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
|
AssumeRoleWithSamlRequest.Builder |
roleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.
|
AssumeRoleWithSamlRequest.Builder |
samlAssertion(String samlAssertion)
The base-64 encoded SAML authentication response provided by the IdP.
|
build
overrideConfiguration
copy
applyMutation, build
AssumeRoleWithSamlRequest.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.
roleArn
- The Amazon Resource Name (ARN) of the role that the caller is assuming.AssumeRoleWithSamlRequest.Builder principalArn(String principalArn)
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
principalArn
- The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.AssumeRoleWithSamlRequest.Builder samlAssertion(String samlAssertion)
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
samlAssertion
- The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
AssumeRoleWithSamlRequest.Builder policy(String policy)
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
policy
- An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
AssumeRoleWithSamlRequest.Builder durationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600
seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the
SAML authentication response's SessionNotOnOrAfter
value. The actual expiration time is
whichever value is shorter.
This is separate from the duration of a console session that you might request using the returned
credentials. The request to the federation endpoint for a console sign-in token takes a
SessionDuration
parameter that specifies the maximum length of the console session, separately
from the DurationSeconds
parameter on this API. For more information, see Enabling
SAML 2.0 Federated Users to Access the AWS Management Console in the IAM User Guide.
durationSeconds
- The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to
3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be
specified in the SAML authentication response's SessionNotOnOrAfter
value. The actual
expiration time is whichever value is shorter.
This is separate from the duration of a console session that you might request using the returned
credentials. The request to the federation endpoint for a console sign-in token takes a
SessionDuration
parameter that specifies the maximum length of the console session,
separately from the DurationSeconds
parameter on this API. For more information, see
Enabling SAML 2.0 Federated Users to Access the AWS Management Console in the IAM User
Guide.
AssumeRoleWithSamlRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.AssumeRoleWithSamlRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.