Class SetSecurityTokenServicePreferencesRequest

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

  • Method Details

    • globalEndpointTokenVersion

      public final GlobalEndpointTokenVersion globalEndpointTokenVersion()

      The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

      For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

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

      Returns:
      The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

      For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

      See Also:

    • globalEndpointTokenVersionAsString

      public final String globalEndpointTokenVersionAsString()

      The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

      For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

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

      Returns:
      The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

      For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

      See Also:

    • toBuilder

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

    • builder

      public static SetSecurityTokenServicePreferencesRequest.Builder builder()

    • serializableBuilderClass

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