blib/lib/Paws/Datasync/CreateAgent.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Datasync::CreateAgent;
3 use Moose;
4 has ActivationKey => (is => 'ro', isa => 'Str', required => 1);
5 has AgentName => (is => 'ro', isa => 'Str');
6 has SecurityGroupArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has SubnetArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Datasync::TagListEntry]');
9 has VpcEndpointId => (is => 'ro', isa => 'Str');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAgent');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Datasync::CreateAgentResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Datasync::CreateAgent - Arguments for method CreateAgent on L<Paws::Datasync>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateAgent on the
27 L<AWS DataSync|Paws::Datasync> service. Use the attributes of this class
28 as arguments to method CreateAgent.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAgent.
31  
32 =head1 SYNOPSIS
33  
34 my $datasync = Paws->service('Datasync');
35 my $CreateAgentResponse = $datasync->CreateAgent(
36 ActivationKey => 'MyActivationKey',
37 AgentName => 'MyTagValue', # OPTIONAL
38 SecurityGroupArns => [
39 'MyEc2SecurityGroupArn', ... # max: 128
40 ], # OPTIONAL
41 SubnetArns => [
42 'MyEc2SubnetArn', ... # max: 128
43 ], # OPTIONAL
44 Tags => [
45 {
46 Key => 'MyTagKey', # min: 1, max: 256
47 Value => 'MyTagValue', # min: 1, max: 256
48 },
49 ...
50 ], # OPTIONAL
51 VpcEndpointId => 'MyVpcEndpointId', # OPTIONAL
52 );
53  
54 # Results:
55 my $AgentArn = $CreateAgentResponse->AgentArn;
56  
57 # Returns a L<Paws::Datasync::CreateAgentResponse> object.
58  
59 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.
60 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datasync/CreateAgent>
61  
62 =head1 ATTRIBUTES
63  
64  
65 =head2 B<REQUIRED> ActivationKey => Str
66  
67 Your agent activation key. You can get the activation key either by
68 sending an HTTP GET request with redirects that enable you to get the
69 agent IP address (port 80). Alternatively, you can get it from the AWS
70 DataSync console.
71  
72 The redirect URL returned in the response provides you the activation
73 key for your agent in the query string parameter C<activationKey>. It
74 might also include other activation-related parameters; however, these
75 are merely defaults. The arguments you pass to this API call determine
76 the actual configuration of your agent.
77  
78 For more information, see Activating an Agent in the I<AWS DataSync
79 User Guide.>
80  
81  
82  
83 =head2 AgentName => Str
84  
85 The name you configured for your agent. This value is a text reference
86 that is used to identify the agent in the console.
87  
88  
89  
90 =head2 SecurityGroupArns => ArrayRef[Str|Undef]
91  
92 The ARNs of the security groups used to protect your data transfer task
93 subnets. See SecurityGroupArns
94 (https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns).
95  
96  
97  
98 =head2 SubnetArns => ArrayRef[Str|Undef]
99  
100 The Amazon Resource Names (ARNs) of the subnets in which DataSync will
101 create elastic network interfaces for each data transfer task. The
102 agent that runs a task must be private. When you start a task that is
103 associated with an agent created in a VPC, or one that has access to an
104 IP address in a VPC, then the task is also private. In this case,
105 DataSync creates four network interfaces for each task in your subnet.
106 For a data transfer to work, the agent must be able to route to all
107 these four network interfaces.
108  
109  
110  
111 =head2 Tags => ArrayRef[L<Paws::Datasync::TagListEntry>]
112  
113 The key-value pair that represents the tag that you want to associate
114 with the agent. The value can be an empty string. This value helps you
115 manage, filter, and search for your agents.
116  
117 Valid characters for key and value are letters, spaces, and numbers
118 representable in UTF-8 format, and the following special characters: +
119 - = . _ : / @.
120  
121  
122  
123 =head2 VpcEndpointId => Str
124  
125 The ID of the VPC (virtual private cloud) endpoint that the agent has
126 access to. This is the client-side VPC endpoint, also called a
127 PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating
128 a VPC Endpoint Service Configuration
129 (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service)
130 in the Amazon VPC User Guide.
131  
132 VPC endpoint ID looks like this: C<vpce-01234d5aff67890e1>.
133  
134  
135  
136  
137 =head1 SEE ALSO
138  
139 This class forms part of L<Paws>, documenting arguments for method CreateAgent in L<Paws::Datasync>
140  
141 =head1 BUGS and CONTRIBUTIONS
142  
143 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
144  
145 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
146  
147 =cut
148