« blib/lib/Paws/Datasync/CreateAgentResponse.pm
↑ Summary
blib/lib/Paws/Datasync/CreateLocationEfsResponse.pm »
| 1 | |||
| 2 | package Paws::Datasync::CreateLocationEfs; | ||
| 3 | use Moose; | ||
| 4 | has Ec2Config => (is => 'ro', isa => 'Paws::Datasync::Ec2Config', required => 1); | ||
| 5 | has EfsFilesystemArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Subdirectory => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Datasync::TagListEntry]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateLocationEfs'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Datasync::CreateLocationEfsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Datasync::CreateLocationEfs - Arguments for method CreateLocationEfs on L<Paws::Datasync> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateLocationEfs on the | ||
| 25 | L<AWS DataSync|Paws::Datasync> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateLocationEfs. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLocationEfs. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $datasync = Paws->service('Datasync'); | ||
| 33 | my $CreateLocationEfsResponse = $datasync->CreateLocationEfs( | ||
| 34 | Ec2Config => { | ||
| 35 | SecurityGroupArns => [ | ||
| 36 | 'MyEc2SecurityGroupArn', ... # max: 128 | ||
| 37 | ], # min: 1, max: 5 | ||
| 38 | SubnetArn => 'MyEc2SubnetArn', # max: 128 | ||
| 39 | |||
| 40 | }, | ||
| 41 | EfsFilesystemArn => 'MyEfsFilesystemArn', | ||
| 42 | Subdirectory => 'MyEfsSubdirectory', # OPTIONAL | ||
| 43 | Tags => [ | ||
| 44 | { | ||
| 45 | Key => 'MyTagKey', # min: 1, max: 256 | ||
| 46 | Value => 'MyTagValue', # min: 1, max: 256; OPTIONAL | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $LocationArn = $CreateLocationEfsResponse->LocationArn; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Datasync::CreateLocationEfsResponse> object. | ||
| 56 | |||
| 57 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datasync/CreateLocationEfs> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Ec2Config => L<Paws::Datasync::Ec2Config> | ||
| 64 | |||
| 65 | The subnet and security group that the Amazon EFS file system uses. The | ||
| 66 | security group that you provide needs to be able to communicate with | ||
| 67 | the security group on the mount target in the subnet specified. | ||
| 68 | |||
| 69 | The exact relationship between security group M (of the mount target) | ||
| 70 | and security group S (which you provide for DataSync to use at this | ||
| 71 | stage) is as follows: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Security group M (which you associate with the mount target) must allow | ||
| 78 | inbound access for the Transmission Control Protocol (TCP) on the NFS | ||
| 79 | port (2049) from security group S. You can enable inbound connections | ||
| 80 | either by IP address (CIDR range) or security group. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Security group S (provided to DataSync to access EFS) should have a | ||
| 85 | rule that enables outbound connections to the NFS port on one of the | ||
| 86 | file systemE<rsquo>s mount targets. You can enable outbound connections | ||
| 87 | either by IP address (CIDR range) or security group. | ||
| 88 | |||
| 89 | For information about security groups and mount targets, see Security | ||
| 90 | Groups for Amazon EC2 Instances and Mount Targets in the I<Amazon EFS | ||
| 91 | User Guide.> | ||
| 92 | |||
| 93 | =back | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> EfsFilesystemArn => Str | ||
| 99 | |||
| 100 | The Amazon Resource Name (ARN) for the Amazon EFS file system. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Subdirectory => Str | ||
| 105 | |||
| 106 | A subdirectory in the locationE<rsquo>s path. This subdirectory in the | ||
| 107 | EFS file system is used to read data from the EFS source location or | ||
| 108 | write data to the EFS destination. By default, AWS DataSync uses the | ||
| 109 | root directory. | ||
| 110 | |||
| 111 | C<Subdirectory> must be specified with forward slashes. For example, | ||
| 112 | C</path/to/folder>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 Tags => ArrayRef[L<Paws::Datasync::TagListEntry>] | ||
| 117 | |||
| 118 | The key-value pair that represents a tag that you want to add to the | ||
| 119 | resource. The value can be an empty string. This value helps you | ||
| 120 | manage, filter, and search for your resources. We recommend that you | ||
| 121 | create a name tag for your location. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method CreateLocationEfs in L<Paws::Datasync> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |