Interface GetScopedCredentialsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<GetScopedCredentialsRequest.Builder,,GetScopedCredentialsRequest> SdkBuilder<GetScopedCredentialsRequest.Builder,,GetScopedCredentialsRequest> SdkPojo,SdkRequest.Builder,StsRequest.Builder
- Enclosing class:
GetScopedCredentialsRequest
-
Method Summary
Modifier and TypeMethodDescriptiondurationSeconds(Integer durationSeconds) The duration, in seconds, of the resulting scoped down credentials.minimumSessionTokenSize(Integer minimumSessionTokenSize) Sets the value of the MinimumSessionTokenSize property for this object.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.An IAM policy in JSON format that you want to use as a scope down policy.scopedSessionDescription(String scopedSessionDescription) A caller-supplied description of the scoped session.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods 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.services.sts.model.StsRequest.Builder
build
-
Method Details
-
policy
An IAM policy in JSON format that you want to use as a scope down policy.
A request must provide at least one of
PolicyorDurationSeconds. Both parameters are optional individually, but you must specify at least one of them.The resulting session's permissions are the intersection of the calling session's existing permissions and this scope down policy. You cannot use this scope down policy to grant more permissions than the calling session already has.
The plaintext of the scope down policy cannot exceed 2,048 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.
An internal conversion compresses the inline scope down policy into a packed binary format that has a separate limit. If the packed policy exceeds this limit, the request fails with
PackedPolicyTooLarge.If the document is not valid IAM policy JSON, the request fails with
MalformedPolicyDocument.- Parameters:
policy- An IAM policy in JSON format that you want to use as a scope down policy.A request must provide at least one of
PolicyorDurationSeconds. Both parameters are optional individually, but you must specify at least one of them.The resulting session's permissions are the intersection of the calling session's existing permissions and this scope down policy. You cannot use this scope down policy to grant more permissions than the calling session already has.
The plaintext of the scope down policy cannot exceed 2,048 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.
An internal conversion compresses the inline scope down policy into a packed binary format that has a separate limit. If the packed policy exceeds this limit, the request fails with
PackedPolicyTooLarge.If the document is not valid IAM policy JSON, the request fails with
MalformedPolicyDocument.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
durationSeconds
The duration, in seconds, of the resulting scoped down credentials. The value can range from 1 second to 129,600 seconds (36 hours).
If you do not specify this value, the scoped down credentials will inherit the calling session's expiration time.
- Parameters:
durationSeconds- The duration, in seconds, of the resulting scoped down credentials. The value can range from 1 second to 129,600 seconds (36 hours).If you do not specify this value, the scoped down credentials will inherit the calling session's expiration time.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minimumSessionTokenSize
Sets the value of the MinimumSessionTokenSize property for this object.- Parameters:
minimumSessionTokenSize- The new value for the MinimumSessionTokenSize property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopedSessionDescription
A caller-supplied description of the scoped session. The value cannot exceed 256 characters. This description is logged to CloudTrail for the request, so you can use it to record the purpose of the scoped session.
- Parameters:
scopedSessionDescription- A caller-supplied description of the scoped session. The value cannot exceed 256 characters. This description is logged to CloudTrail for the request, so you can use it to record the purpose of the scoped session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetScopedCredentialsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetScopedCredentialsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-