public static interface AssumeRoleRequest.Builder extends StsRequest.Builder, SdkPojo, CopyableBuilder<AssumeRoleRequest.Builder,AssumeRoleRequest>
Modifier and Type | Method and Description |
---|---|
AssumeRoleRequest.Builder |
durationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.
|
AssumeRoleRequest.Builder |
externalId(String externalId)
A unique identifier that might be required when you assume a role in another account.
|
AssumeRoleRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
AssumeRoleRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
AssumeRoleRequest.Builder |
policy(String policy)
An IAM policy in JSON format that you want to use as an inline session policy.
|
AssumeRoleRequest.Builder |
policyArns(Collection<PolicyDescriptorType> policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session
policies.
|
AssumeRoleRequest.Builder |
policyArns(Consumer<PolicyDescriptorType.Builder>... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session
policies.
|
AssumeRoleRequest.Builder |
policyArns(PolicyDescriptorType... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session
policies.
|
AssumeRoleRequest.Builder |
roleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
|
AssumeRoleRequest.Builder |
roleSessionName(String roleSessionName)
An identifier for the assumed role session.
|
AssumeRoleRequest.Builder |
serialNumber(String serialNumber)
The identification number of the MFA device that is associated with the user who is making the
AssumeRole call. |
AssumeRoleRequest.Builder |
tokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if
the policy includes a condition that tests for MFA).
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
AssumeRoleRequest.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
roleArn
- The Amazon Resource Name (ARN) of the role to assume.AssumeRoleRequest.Builder roleSessionName(String roleSessionName)
An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
roleSessionName
- An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
AssumeRoleRequest.Builder policyArns(Collection<PolicyDescriptorType> 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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize
response element indicates by percentage how close the
policy is 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 AWS 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.
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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize
response element indicates by
percentage how close the policy is 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 AWS 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.
AssumeRoleRequest.Builder policyArns(PolicyDescriptorType... 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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize
response element indicates by percentage how close the
policy is 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 AWS 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.
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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize
response element indicates by
percentage how close the policy is 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 AWS 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.
AssumeRoleRequest.Builder policyArns(Consumer<PolicyDescriptorType.Builder>... 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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize
response element indicates by percentage how close the
policy is 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 AWS 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 that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #policyArns(List)
.policyArns
- a consumer that will call methods on List.Builder
#policyArns(List)
AssumeRoleRequest.Builder policy(String 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 AWS 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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize
response element indicates by percentage how close the
policy is to the upper size limit.
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 AWS 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 plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize
response element indicates by
percentage how close the policy is to the upper size limit.
AssumeRoleRequest.Builder durationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session. The value can range 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 a SessionDuration
parameter that specifies the maximum length of the console session. For
more information, see Creating a URL that Enables 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) 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 a SessionDuration
parameter that specifies the maximum length of the
console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM
User Guide.
AssumeRoleRequest.Builder externalId(String externalId)
A unique identifier that might be required when you assume a role in another account. If the administrator of
the account to which the role belongs provided you with an external ID, then provide that value in the
ExternalId
parameter. This value can be any string, such as a passphrase or account number. A
cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the
trusting account might send an external ID to the administrator of the trusted account. That way, only
someone with the ID can assume the role, rather than everyone in the account. For more information about the
external ID, see How to Use
an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
externalId
- A unique identifier that might be required when you assume a role in another account. If the
administrator of the account to which the role belongs provided you with an external ID, then provide
that value in the ExternalId
parameter. This value can be any string, such as a
passphrase or account number. A cross-account role is usually set up to trust everyone in an account.
Therefore, the administrator of the trusting account might send an external ID to the administrator of
the trusted account. That way, only someone with the ID can assume the role, rather than everyone in
the account. For more information about the external ID, see How
to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM
User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
AssumeRoleRequest.Builder serialNumber(String serialNumber)
The identification number of the MFA device that is associated with the user who is making the
AssumeRole
call. Specify this value if the trust policy of the role being assumed includes a
condition that requires MFA authentication. The value is either the serial number for a hardware device (such
as GAHT12345678
) or an Amazon Resource Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
serialNumber
- The identification number of the MFA device that is associated with the user who is making the
AssumeRole
call. Specify this value if the trust policy of the role being assumed
includes a condition that requires MFA authentication. The value is either the serial number for a
hardware device (such as GAHT12345678
) or an Amazon Resource Name (ARN) for a virtual
device (such as arn:aws:iam::123456789012:mfa/user
).
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
AssumeRoleRequest.Builder tokenCode(String tokenCode)
The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if
the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the
TokenCode
value is missing or expired, the AssumeRole
call returns an
"access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
tokenCode
- The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that
is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and
if the TokenCode
value is missing or expired, the AssumeRole
call returns an
"access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
AssumeRoleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
AssumeRoleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2019. All rights reserved.