Class AssumeRoleResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.sts.model.StsResponse
-
- software.amazon.awssdk.services.sts.model.AssumeRoleResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>
@Generated("software.amazon.awssdk:codegen") public final class AssumeRoleResponse extends StsResponse implements ToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>
Contains the response to a successful AssumeRole request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AssumeRoleResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.static AssumeRoleResponse.Builder
builder()
Credentials
credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
packedPolicySize()
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.List<SdkField<?>>
sdkFields()
static Class<? extends AssumeRoleResponse.Builder>
serializableBuilderClass()
String
sourceIdentity()
The source identity specified by the principal that is calling theAssumeRole
operation.AssumeRoleResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.sts.model.StsResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
credentials
public final 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.
- Returns:
- 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.
-
assumedRoleUser
public final 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 calledAssumeRole
.- Returns:
- 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
.
-
packedPolicySize
public final 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.
- Returns:
- 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.
-
sourceIdentity
public final 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 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:
- 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: =,.@-
-
toBuilder
public AssumeRoleResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static AssumeRoleResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends AssumeRoleResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-