Interface AssumeRoleWithSamlRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AssumeRoleWithSamlRequest.Builder,
,AssumeRoleWithSamlRequest> SdkBuilder<AssumeRoleWithSamlRequest.Builder,
,AssumeRoleWithSamlRequest> SdkPojo
,SdkRequest.Builder
,StsRequest.Builder
- Enclosing class:
AssumeRoleWithSamlRequest
-
Method Summary
Modifier and TypeMethodDescriptiondurationSeconds
(Integer durationSeconds) The duration, in seconds, of the role session.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.An IAM policy in JSON format that you want to use as an inline session policy.policyArns
(Collection<PolicyDescriptorType> policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.policyArns
(Consumer<PolicyDescriptorType.Builder>... policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.policyArns
(PolicyDescriptorType... policyArns) The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.principalArn
(String principalArn) The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.The Amazon Resource Name (ARN) of the role that the caller is assuming.samlAssertion
(String samlAssertion) The base64 encoded SAML authentication response provided by the IdP.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.sts.model.StsRequest.Builder
build
-
Method Details
-
roleArn
The Amazon Resource Name (ARN) of the role that the caller is assuming.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the role that the caller is assuming.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
principalArn
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
- Parameters:
principalArn
- The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
samlAssertion
The base64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
- Parameters:
samlAssertion
- The base64 encoded SAML authentication response provided by the IdP.For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
- Parameters:
policyArns
- The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
- Parameters:
policyArns
- The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyArns
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
This is a convenience method that creates an instance of thePolicyDescriptorType.Builder
avoiding the need to create one manually viaPolicyDescriptorType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topolicyArns(List<PolicyDescriptorType>)
.- Parameters:
policyArns
- a consumer that will call methods onPolicyDescriptorType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
policy
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.- Parameters:
policy
- An IAM policy in JSON format that you want to use as an inline session policy.This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize
response element indicates by percentage how close the policies and tags for your request are to the upper size limit.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
durationSeconds
The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the
DurationSeconds
parameter, or until the time specified in the SAML authentication response'sSessionNotOnOrAfter
value, whichever is shorter. You can provide aDurationSeconds
value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.By default, the value is set to
3600
seconds.The
DurationSeconds
parameter 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 aSessionDuration
parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console in the IAM User Guide.- Parameters:
durationSeconds
- The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for theDurationSeconds
parameter, or until the time specified in the SAML authentication response'sSessionNotOnOrAfter
value, whichever is shorter. You can provide aDurationSeconds
value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.By default, the value is set to
3600
seconds.The
DurationSeconds
parameter 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 aSessionDuration
parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console in the IAM User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AssumeRoleWithSamlRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AssumeRoleWithSamlRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-