@Generated(value="software.amazon.awssdk:codegen") public class AssumeRoleWithSAMLRequest extends STSRequest implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<AssumeRoleWithSAMLRequest.Builder,AssumeRoleWithSAMLRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
AssumeRoleWithSAMLRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AssumeRoleWithSAMLRequest.Builder |
builder() |
Integer |
durationSeconds()
The duration, in seconds, of the role session.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
policy()
An IAM policy in JSON format.
|
String |
principalArn()
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
|
String |
roleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.
|
String |
samlAssertion()
The base-64 encoded SAML authentication response provided by the IdP.
|
static Class<? extends AssumeRoleWithSAMLRequest.Builder> |
serializableBuilderClass() |
AssumeRoleWithSAMLRequest.Builder |
toBuilder() |
String |
toString() |
requestOverrideConfigpublic String roleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.
public String principalArn()
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
public 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.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
public 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.
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.
public 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.
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.
public AssumeRoleWithSAMLRequest.Builder toBuilder()
toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<AssumeRoleWithSAMLRequest.Builder,AssumeRoleWithSAMLRequest>toBuilder in class STSRequestpublic static AssumeRoleWithSAMLRequest.Builder builder()
public static Class<? extends AssumeRoleWithSAMLRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2018. All rights reserved.