Interface GetScopedCredentialsResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<GetScopedCredentialsResponse.Builder,,GetScopedCredentialsResponse> SdkBuilder<GetScopedCredentialsResponse.Builder,,GetScopedCredentialsResponse> SdkPojo,SdkResponse.Builder,StsResponse.Builder
- Enclosing class:
GetScopedCredentialsResponse
-
Method Summary
Modifier and TypeMethodDescriptioncredentials(Consumer<Credentials.Builder> credentials) The temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security token.credentials(Credentials credentials) The temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security token.scopedPoliciesCount(Integer scopedPoliciesCount) GetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session.sessionInfo(Consumer<ScopedSession.Builder> sessionInfo) Metadata about the resulting scoped session, including its identifier and ARN.sessionInfo(ScopedSession sessionInfo) Metadata about the resulting scoped session, including its identifier and ARN.sessionTokenSize(Integer sessionTokenSize) Sets the value of the SessionTokenSize property for this object.sessionTokenUtilization(Integer sessionTokenUtilization) Sets the value of the SessionTokenUtilization property for this object.sourceIdentity(String sourceIdentity) The source identity of the calling session, carried forward unchanged.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponseMethods inherited from interface software.amazon.awssdk.services.sts.model.StsResponse.Builder
build, responseMetadata, responseMetadata
-
Method Details
-
credentials
The temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security 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 for the scoped down session, which include an access key ID, a secret access key, and a security 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 for the scoped down session, which include an access key ID, a secret access key, and a security token.
This is a convenience method that creates an instance of theThe 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.Builderavoiding the need to create one manually viaCredentials.builder().When the
Consumercompletes,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:
-
sessionInfo
Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.
- Parameters:
sessionInfo- Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionInfo
default GetScopedCredentialsResponse.Builder sessionInfo(Consumer<ScopedSession.Builder> sessionInfo) Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.
This is a convenience method that creates an instance of theScopedSession.Builderavoiding the need to create one manually viaScopedSession.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosessionInfo(ScopedSession).- Parameters:
sessionInfo- a consumer that will call methods onScopedSession.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sessionTokenUtilization
Sets the value of the SessionTokenUtilization property for this object.- Parameters:
sessionTokenUtilization- The new value for the SessionTokenUtilization property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionTokenSize
Sets the value of the SessionTokenSize property for this object.- Parameters:
sessionTokenSize- The new value for the SessionTokenSize property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopedPoliciesCount
GetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3GetScopedCredentialsscope-down policies, a subsequentGetScopedCredentialscall that supplies aPolicy(attempting to append a fourth scope-down policy) is denied.- Parameters:
scopedPoliciesCount-GetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3GetScopedCredentialsscope-down policies, a subsequentGetScopedCredentialscall that supplies aPolicy(attempting to append a fourth scope-down policy) is denied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIdentity
The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.
- Parameters:
sourceIdentity- The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-