Class GetRoleCredentialsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.accountaccessruntime.model.AccountAccessRuntimeRequest
software.amazon.awssdk.services.accountaccessruntime.model.GetRoleCredentialsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRoleCredentialsRequest.Builder,GetRoleCredentialsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetRoleCredentialsRequest extends AccountAccessRuntimeRequest implements ToCopyableBuilder<GetRoleCredentialsRequest.Builder,GetRoleCredentialsRequest>

  • Method Details

    • tenantId

      public final String tenantId()

      The identifier of the tenant that the request applies to. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

      Returns:
      The identifier of the tenant that the request applies to. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.

      Returns:
      The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.

    • accessType

      public final AccessType accessType()

      The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.

      If the service returns an enum value that is not available in the current SDK version, accessType will return AccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessTypeAsString().

      Returns:
      The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.
      See Also:

    • accessTypeAsString

      public final String accessTypeAsString()

      The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.

      If the service returns an enum value that is not available in the current SDK version, accessType will return AccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessTypeAsString().

      Returns:
      The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.
      See Also:

    • sessionName

      public final String sessionName()

      An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.

      Returns:
      An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.

    • sessionDuration

      public final Integer sessionDuration()

      The duration, in seconds, that the returned credentials remain valid. If you don't specify a value, the service uses the default session duration. The maximum value can't exceed the maximum session duration configured for the role.

      Returns:
      The duration, in seconds, that the returned credentials remain valid. If you don't specify a value, the service uses the default session duration. The maximum value can't exceed the maximum session duration configured for the role.

    • toBuilder

      public GetRoleCredentialsRequest.Builder 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<GetRoleCredentialsRequest.Builder,GetRoleCredentialsRequest>
      Specified by:
      toBuilder in class AccountAccessRuntimeRequest
      Returns:
      a builder for type T

    • builder

      public static GetRoleCredentialsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetRoleCredentialsRequest.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.