Class CreateLocationEfsRequest

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

CreateLocationEfsRequest

  • Method Details

    • subdirectory

      public final String subdirectory()

      Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

      By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

      Returns:
      Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

      By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

    • efsFilesystemArn

      public final String efsFilesystemArn()

      Specifies the ARN for your Amazon EFS file system.

      Returns:
      Specifies the ARN for your Amazon EFS file system.

    • ec2Config

      public final Ec2Config ec2Config()

      Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets.

      Returns:
      Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<TagListEntry> tags()

      Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

    • accessPointArn

      public final String accessPointArn()

      Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

      For more information, see Accessing restricted file systems.

      Returns:
      Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

      For more information, see Accessing restricted file systems.

    • fileSystemAccessRoleArn

      public final String fileSystemAccessRoleArn()

      Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

      For information on creating this role, see Creating a DataSync IAM role for file system access.

      Returns:
      Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

      For information on creating this role, see Creating a DataSync IAM role for file system access.

    • inTransitEncryption

      public final EfsInTransitEncryption inTransitEncryption()

      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

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

      Returns:
      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

      See Also:

    • inTransitEncryptionAsString

      public final String inTransitEncryptionAsString()

      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

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

      Returns:
      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

      See Also:

    • toBuilder

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

    • builder

      public static CreateLocationEfsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.