Interface AssumeRoleResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<AssumeRoleResponse.Builder,
,AssumeRoleResponse> SdkBuilder<AssumeRoleResponse.Builder,
,AssumeRoleResponse> SdkPojo
,SdkResponse.Builder
,StsResponse.Builder
- Enclosing class:
AssumeRoleResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssumeRoleResponse.Builder
assumedRoleUser
(Consumer<AssumedRoleUser.Builder> assumedRoleUser) The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.assumedRoleUser
(AssumedRoleUser assumedRoleUser) The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.default AssumeRoleResponse.Builder
credentials
(Consumer<Credentials.Builder> credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.credentials
(Credentials credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.packedPolicySize
(Integer packedPolicySize) A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.sourceIdentity
(String sourceIdentity) The source identity specified by the principal that is calling theAssumeRole
operation.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.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.services.sts.model.StsResponse.Builder
build, responseMetadata, responseMetadata
-
Method Details
-
credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
Credentials.Builder
avoiding the need to create one manually viaCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocredentials(Credentials)
.- Parameters:
credentials
- a consumer that will call methods onCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
assumedRoleUser
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Parameters:
assumedRoleUser
- The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include theRoleSessionName
that you specified when you calledAssumeRole
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assumedRoleUser
default AssumeRoleResponse.Builder assumedRoleUser(Consumer<AssumedRoleUser.Builder> assumedRoleUser) The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
This is a convenience method that creates an instance of theRoleSessionName
that you specified when you calledAssumeRole
.AssumedRoleUser.Builder
avoiding the need to create one manually viaAssumedRoleUser.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassumedRoleUser(AssumedRoleUser)
.- Parameters:
assumedRoleUser
- a consumer that will call methods onAssumedRoleUser.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
packedPolicySize
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIdentity
The source identity specified by the principal that is calling the
AssumeRole
operation.You can require users to specify a source identity when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use theaws:SourceIdentity
condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles 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: =,.@-
- Parameters:
sourceIdentity
- The source identity specified by the principal that is calling theAssumeRole
operation.You can require users to specify a source identity when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use theaws:SourceIdentity
condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles 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: =,.@-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-