Package software.amazon.awssdk.services.batch.model

Class EFSAuthorizationConfig

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

The authorization configuration details for the Amazon EFS file system.

See Also:

  • Method Details

    • accessPointId

      public final String accessPointId()

      The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

      Returns:
      The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

    • iam

      public final EFSAuthorizationConfigIAM iam()

      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

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

      Returns:
      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.
      See Also:

    • iamAsString

      public final String iamAsString()

      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

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

      Returns:
      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.
      See Also:

    • toBuilder

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

    • builder

      public static EFSAuthorizationConfig.Builder builder()

    • serializableBuilderClass

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