blib/lib/Paws/EC2/CreateClientVpnEndpoint.pm untested

filter: Statementstmt 0.0% 0 / 28 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 30 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::CreateClientVpnEndpoint;
3 use Moose;
4 has AuthenticationOptions => (is => 'ro', isa => 'ArrayRef[Paws::EC2::ClientVpnAuthenticationRequest]', traits => ['NameInRequest'], request_name => 'Authentication' , required => 1);
5 has ClientCidrBlock => (is => 'ro', isa => 'Str', required => 1);
6 has ClientConnectOptions => (is => 'ro', isa => 'Paws::EC2::ClientConnectOptions');
7 has ClientToken => (is => 'ro', isa => 'Str');
8 has ConnectionLogOptions => (is => 'ro', isa => 'Paws::EC2::ConnectionLogOptions', required => 1);
9 has Description => (is => 'ro', isa => 'Str');
10 has DnsServers => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11 has DryRun => (is => 'ro', isa => 'Bool');
12 has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SecurityGroupId' );
13 has SelfServicePortal => (is => 'ro', isa => 'Str');
14 has ServerCertificateArn => (is => 'ro', isa => 'Str', required => 1);
15 has SplitTunnel => (is => 'ro', isa => 'Bool');
16 has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' );
17 has TransportProtocol => (is => 'ro', isa => 'Str');
18 has VpcId => (is => 'ro', isa => 'Str');
19 has VpnPort => (is => 'ro', isa => 'Int');
20  
21 use MooseX::ClassAttribute;
22  
23 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateClientVpnEndpoint');
24 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateClientVpnEndpointResult');
25 class_has _result_key => (isa => 'Str', is => 'ro');
26 1;
27  
28 ### main pod documentation begin ###
29  
30 =head1 NAME
31  
32 Paws::EC2::CreateClientVpnEndpoint - Arguments for method CreateClientVpnEndpoint on L<Paws::EC2>
33  
34 =head1 DESCRIPTION
35  
36 This class represents the parameters used for calling the method CreateClientVpnEndpoint on the
37 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
38 as arguments to method CreateClientVpnEndpoint.
39  
40 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClientVpnEndpoint.
41  
42 =head1 SYNOPSIS
43  
44 my $ec2 = Paws->service('EC2');
45 my $CreateClientVpnEndpointResult = $ec2->CreateClientVpnEndpoint(
46 AuthenticationOptions => [
47 {
48 ActiveDirectory => {
49 DirectoryId => 'MyString', # OPTIONAL
50 }, # OPTIONAL
51 FederatedAuthentication => {
52 SAMLProviderArn => 'MyString', # OPTIONAL
53 SelfServiceSAMLProviderArn => 'MyString', # OPTIONAL
54 }, # OPTIONAL
55 MutualAuthentication => {
56 ClientRootCertificateChainArn => 'MyString', # OPTIONAL
57 }, # OPTIONAL
58 Type => 'certificate-authentication'
59 , # values: certificate-authentication, directory-service-authentication, federated-authentication; OPTIONAL
60 },
61 ...
62 ],
63 ClientCidrBlock => 'MyString',
64 ConnectionLogOptions => {
65 CloudwatchLogGroup => 'MyString', # OPTIONAL
66 CloudwatchLogStream => 'MyString', # OPTIONAL
67 Enabled => 1, # OPTIONAL
68 },
69 ServerCertificateArn => 'MyString',
70 ClientConnectOptions => {
71 Enabled => 1, # OPTIONAL
72 LambdaFunctionArn => 'MyString', # OPTIONAL
73 }, # OPTIONAL
74 ClientToken => 'MyString', # OPTIONAL
75 Description => 'MyString', # OPTIONAL
76 DnsServers => [
77 'MyString', ... # OPTIONAL
78 ], # OPTIONAL
79 DryRun => 1, # OPTIONAL
80 SecurityGroupIds => [ 'MySecurityGroupId', ... ], # OPTIONAL
81 SelfServicePortal => 'enabled', # OPTIONAL
82 SplitTunnel => 1, # OPTIONAL
83 TagSpecifications => [
84 {
85 ResourceType => 'client-vpn-endpoint'
86 , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL
87 Tags => [
88 {
89 Key => 'MyString', # OPTIONAL
90 Value => 'MyString', # OPTIONAL
91 },
92 ...
93 ], # OPTIONAL
94 },
95 ...
96 ], # OPTIONAL
97 TransportProtocol => 'tcp', # OPTIONAL
98 VpcId => 'MyVpcId', # OPTIONAL
99 VpnPort => 1, # OPTIONAL
100 );
101  
102 # Results:
103 my $ClientVpnEndpointId =
104 $CreateClientVpnEndpointResult->ClientVpnEndpointId;
105 my $DnsName = $CreateClientVpnEndpointResult->DnsName;
106 my $Status = $CreateClientVpnEndpointResult->Status;
107  
108 # Returns a L<Paws::EC2::CreateClientVpnEndpointResult> object.
109  
110 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.
111 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateClientVpnEndpoint>
112  
113 =head1 ATTRIBUTES
114  
115  
116 =head2 B<REQUIRED> AuthenticationOptions => ArrayRef[L<Paws::EC2::ClientVpnAuthenticationRequest>]
117  
118 Information about the authentication method to be used to authenticate
119 clients.
120  
121  
122  
123 =head2 B<REQUIRED> ClientCidrBlock => Str
124  
125 The IPv4 address range, in CIDR notation, from which to assign client
126 IP addresses. The address range cannot overlap with the local CIDR of
127 the VPC in which the associated subnet is located, or the routes that
128 you add manually. The address range cannot be changed after the Client
129 VPN endpoint has been created. The CIDR block should be /22 or greater.
130  
131  
132  
133 =head2 ClientConnectOptions => L<Paws::EC2::ClientConnectOptions>
134  
135 The options for managing connection authorization for new client
136 connections.
137  
138  
139  
140 =head2 ClientToken => Str
141  
142 Unique, case-sensitive identifier that you provide to ensure the
143 idempotency of the request. For more information, see How to Ensure
144 Idempotency
145 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
146  
147  
148  
149 =head2 B<REQUIRED> ConnectionLogOptions => L<Paws::EC2::ConnectionLogOptions>
150  
151 Information about the client connection logging options.
152  
153 If you enable client connection logging, data about client connections
154 is sent to a Cloudwatch Logs log stream. The following information is
155 logged:
156  
157 =over
158  
159 =item *
160  
161 Client connection requests
162  
163 =item *
164  
165 Client connection results (successful and unsuccessful)
166  
167 =item *
168  
169 Reasons for unsuccessful client connection requests
170  
171 =item *
172  
173 Client connection termination time
174  
175 =back
176  
177  
178  
179  
180 =head2 Description => Str
181  
182 A brief description of the Client VPN endpoint.
183  
184  
185  
186 =head2 DnsServers => ArrayRef[Str|Undef]
187  
188 Information about the DNS servers to be used for DNS resolution. A
189 Client VPN endpoint can have up to two DNS servers. If no DNS server is
190 specified, the DNS address configured on the device is used for the DNS
191 server.
192  
193  
194  
195 =head2 DryRun => Bool
196  
197 Checks whether you have the required permissions for the action,
198 without actually making the request, and provides an error response. If
199 you have the required permissions, the error response is
200 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
201  
202  
203  
204 =head2 SecurityGroupIds => ArrayRef[Str|Undef]
205  
206 The IDs of one or more security groups to apply to the target network.
207 You must also specify the ID of the VPC that contains the security
208 groups.
209  
210  
211  
212 =head2 SelfServicePortal => Str
213  
214 Specify whether to enable the self-service portal for the Client VPN
215 endpoint.
216  
217 Default Value: C<enabled>
218  
219 Valid values are: C<"enabled">, C<"disabled">
220  
221 =head2 B<REQUIRED> ServerCertificateArn => Str
222  
223 The ARN of the server certificate. For more information, see the AWS
224 Certificate Manager User Guide
225 (https://docs.aws.amazon.com/acm/latest/userguide/).
226  
227  
228  
229 =head2 SplitTunnel => Bool
230  
231 Indicates whether split-tunnel is enabled on the AWS Client VPN
232 endpoint.
233  
234 By default, split-tunnel on a VPN endpoint is disabled.
235  
236 For information about split-tunnel VPN endpoints, see Split-Tunnel AWS
237 Client VPN Endpoint
238 (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html)
239 in the I<AWS Client VPN Administrator Guide>.
240  
241  
242  
243 =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>]
244  
245 The tags to apply to the Client VPN endpoint during creation.
246  
247  
248  
249 =head2 TransportProtocol => Str
250  
251 The transport protocol to be used by the VPN session.
252  
253 Default value: C<udp>
254  
255 Valid values are: C<"tcp">, C<"udp">
256  
257 =head2 VpcId => Str
258  
259 The ID of the VPC to associate with the Client VPN endpoint. If no
260 security group IDs are specified in the request, the default security
261 group for the VPC is applied.
262  
263  
264  
265 =head2 VpnPort => Int
266  
267 The port number to assign to the Client VPN endpoint for TCP and UDP
268 traffic.
269  
270 Valid Values: C<443> | C<1194>
271  
272 Default Value: C<443>
273  
274  
275  
276  
277 =head1 SEE ALSO
278  
279 This class forms part of L<Paws>, documenting arguments for method CreateClientVpnEndpoint in L<Paws::EC2>
280  
281 =head1 BUGS and CONTRIBUTIONS
282  
283 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
284  
285 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
286  
287 =cut
288