Class GetScopedCredentialsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetScopedCredentialsRequest.Builder,GetScopedCredentialsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final IntegerThe duration, in seconds, of the resulting scoped down credentials.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final IntegerReturns the value of the MinimumSessionTokenSize property for this object.final Stringpolicy()An IAM policy in JSON format that you want to use as a scope down policy.final StringA caller-supplied description of the scoped session.static Class<? extends GetScopedCredentialsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.- Returns:
- 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.
-
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:
- 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.
-
minimumSessionTokenSize
Returns the value of the MinimumSessionTokenSize property for this object.- Returns:
- The value of the MinimumSessionTokenSize property for this object.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetScopedCredentialsRequest.Builder,GetScopedCredentialsRequest> - Specified by:
toBuilderin classStsRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-