Class EFSVolumeConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EFSVolumeConfiguration.Builder,
EFSVolumeConfiguration>
This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal EFSAuthorizationConfig
The authorization configuration details for the Amazon EFS file system.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon EFS file system ID to use.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The directory within the Amazon EFS file system to mount as the root directory inside the host.static Class
<? extends EFSVolumeConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final EFSTransitEncryption
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.final String
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.final Integer
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fileSystemId
The Amazon EFS file system ID to use.
- Returns:
- The Amazon EFS file system ID to use.
-
rootDirectory
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying
/
has the same effect as omitting this parameter. The maximum length is 4,096 characters.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
, which enforces the path set on the Amazon EFS access point.- Returns:
- The directory within the Amazon EFS file system to mount as the root directory inside the host. If this
parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying
/
has the same effect as omitting this parameter. The maximum length is 4,096 characters.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
, which enforces the path set on the Amazon EFS access point.
-
transitEncryption
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.If the service returns an enum value that is not available in the current SDK version,
transitEncryption
will returnEFSTransitEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransitEncryptionAsString()
.- Returns:
- Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - See Also:
-
transitEncryptionAsString
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.If the service returns an enum value that is not available in the current SDK version,
transitEncryption
will returnEFSTransitEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransitEncryptionAsString()
.- Returns:
- Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - See Also:
-
transitEncryptionPort
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
- Returns:
- The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
authorizationConfig
The authorization configuration details for the Amazon EFS file system.
- Returns:
- The authorization configuration details for the Amazon EFS file system.
-
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 interfaceToCopyableBuilder<EFSVolumeConfiguration.Builder,
EFSVolumeConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-