public static interface AssumeRoleResponse.Builder extends StsResponse.Builder, SdkPojo, CopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>
Modifier and Type | Method and Description |
---|---|
AssumeRoleResponse.Builder |
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 |
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.
|
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.
|
AssumeRoleResponse.Builder |
credentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security (or
session) token.
|
AssumeRoleResponse.Builder |
packedPolicySize(Integer packedPolicySize)
A percentage value that indicates the packed size of the session policies and session tags combined passed in
the request.
|
AssumeRoleResponse.Builder |
sourceIdentity(String sourceIdentity)
The source identity specified by the principal that is calling the
AssumeRole operation. |
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
AssumeRoleResponse.Builder credentials(Credentials 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
- 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.
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.
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 via Credentials.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to credentials(Credentials)
.
credentials
- a consumer that will call methods on Credentials.Builder
credentials(Credentials)
AssumeRoleResponse.Builder 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. 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 called AssumeRole
.
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 called AssumeRole
.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
RoleSessionName
that you specified when you called AssumeRole
.
AssumedRoleUser.Builder
avoiding the
need to create one manually via AssumedRoleUser.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to assumedRoleUser(AssumedRoleUser)
.
assumedRoleUser
- a consumer that will call methods on AssumedRoleUser.Builder
assumedRoleUser(AssumedRoleUser)
AssumeRoleResponse.Builder packedPolicySize(Integer 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.
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.AssumeRoleResponse.Builder sourceIdentity(String 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 the aws: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: =,.@-
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 the
aws: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: =,.@-
Copyright © 2023. All rights reserved.