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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EFSAuthorizationConfig.Builder

Method Summary

Modifier and Type	Method	Description
String	accessPointId()	The Amazon EFS access point ID to use.
static EFSAuthorizationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EFSAuthorizationConfigIAM	iam()	Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
String	iamAsString()	Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EFSAuthorizationConfig.Builder>	serializableBuilderClass()
EFSAuthorizationConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

EFSAuthorizationConfigIAM

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:

EFSAuthorizationConfigIAM

toBuilder

public EFSAuthorizationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EFSAuthorizationConfig.Builder,EFSAuthorizationConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo