Class GetScopedCredentialsRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScopedCredentialsRequest.Builder,GetScopedCredentialsRequest>

@Generated("software.amazon.awssdk:codegen") public final class GetScopedCredentialsRequest extends StsRequest implements ToCopyableBuilder<GetScopedCredentialsRequest.Builder,GetScopedCredentialsRequest>
  • Method Details

    • policy

      public final String 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 Policy or DurationSeconds. 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 Policy or DurationSeconds. 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

      public final Integer 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

      public final Integer minimumSessionTokenSize()
      Returns the value of the MinimumSessionTokenSize property for this object.
      Returns:
      The value of the MinimumSessionTokenSize property for this object.
    • scopedSessionDescription

      public final String 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: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetScopedCredentialsRequest.Builder,GetScopedCredentialsRequest>
      Specified by:
      toBuilder in class StsRequest
      Returns:
      a builder for type T
    • builder

      public static GetScopedCredentialsRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends GetScopedCredentialsRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.