Class ObjectStorageFederatedIdentityConfig

java.lang.Object
software.amazon.awssdk.services.datasync.model.ObjectStorageFederatedIdentityConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ObjectStorageFederatedIdentityConfig.Builder,ObjectStorageFederatedIdentityConfig>
@Generated("software.amazon.awssdk:codegen") public final class ObjectStorageFederatedIdentityConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ObjectStorageFederatedIdentityConfig.Builder,ObjectStorageFederatedIdentityConfig>

Specifies federated identity parameters that allow DataSync to obtain OpenID Connect token for access to customer object storage. The token allows for temporary, short-term access to the storage. DataSync automatically refreshes the token to assure uninterrupted access to the storage.

Federated identity parameters are an alternative to the AccessKey/SecretKey credentials that are expected to be valid long-term (e.g. at least for the duration of DataSync task execution). Do not specify federated identity and the key parameters for the same object storage location.

See Also:

  • Method Details

    • awsIamRole

      public final String awsIamRole()

      Specifies the ARN for an Amazon Web Services role that allows DataSync to invoke STS GetWebIdentityToken API on behalf of the customer account and to obtain Amazon Web Services STS JWT (web token).

      Returns:
      Specifies the ARN for an Amazon Web Services role that allows DataSync to invoke STS GetWebIdentityToken API on behalf of the customer account and to obtain Amazon Web Services STS JWT (web token).

    • externalIdentity

      public final ObjectStorageExternalIdentityConfig externalIdentity()

      Specifies cloud-provider-specific external identity parameters used when exchanging the Amazon Web Services web token for an OpenID Connect token at the object storage provider.

      Returns:
      Specifies cloud-provider-specific external identity parameters used when exchanging the Amazon Web Services web token for an OpenID Connect token at the object storage provider.

    • toBuilder

      public ObjectStorageFederatedIdentityConfig.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<ObjectStorageFederatedIdentityConfig.Builder,ObjectStorageFederatedIdentityConfig>
      Returns:
      a builder for type T

    • builder

      public static ObjectStorageFederatedIdentityConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ObjectStorageFederatedIdentityConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • 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)

    • 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.