You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::CreateLocationEfsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateLocationEfsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  subdirectory: "EfsSubdirectory",
  efs_filesystem_arn: "EfsFilesystemArn", # required
  ec2_config: { # required
    subnet_arn: "Ec2SubnetArn", # required
    security_group_arns: ["Ec2SecurityGroupArn"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

CreateLocationEfsRequest

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ec2_config ⇒ Types::Ec2Config

The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

  • Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.

  • Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.

    For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.

Returns:

  • (Types::Ec2Config) —

    The subnet and security group that the Amazon EFS file system uses.

#efs_filesystem_arn ⇒ String

The Amazon Resource Name (ARN) for the Amazon EFS file system.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the Amazon EFS file system.

#subdirectory ⇒ String

A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

Returns:

  • (String) —

    A subdirectory in the location’s path.

#tags ⇒ Array<Types::TagListEntry>

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.

Returns:

  • (Array<Types::TagListEntry>) —

    The key-value pair that represents a tag that you want to add to the resource.