« blib/lib/Paws/EC2/CreateClientVpnEndpointResult.pm
↑ Summary
blib/lib/Paws/EC2/CreateClientVpnRouteResult.pm »
| 1 | |||
| 2 | package Paws::EC2::CreateClientVpnRoute; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has ClientVpnEndpointId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has DestinationCidrBlock => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 9 | has TargetVpcSubnetId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateClientVpnRoute'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateClientVpnRouteResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EC2::CreateClientVpnRoute - Arguments for method CreateClientVpnRoute on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateClientVpnRoute on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateClientVpnRoute. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClientVpnRoute. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | my $CreateClientVpnRouteResult = $ec2->CreateClientVpnRoute( | ||
| 36 | ClientVpnEndpointId => 'MyClientVpnEndpointId', | ||
| 37 | DestinationCidrBlock => 'MyString', | ||
| 38 | TargetVpcSubnetId => 'MySubnetId', | ||
| 39 | ClientToken => 'MyString', # OPTIONAL | ||
| 40 | Description => 'MyString', # OPTIONAL | ||
| 41 | DryRun => 1, # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Status = $CreateClientVpnRouteResult->Status; | ||
| 46 | |||
| 47 | # Returns a L<Paws::EC2::CreateClientVpnRouteResult> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateClientVpnRoute> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ClientToken => Str | ||
| 56 | |||
| 57 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 58 | idempotency of the request. For more information, see How to Ensure | ||
| 59 | Idempotency | ||
| 60 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> ClientVpnEndpointId => Str | ||
| 65 | |||
| 66 | The ID of the Client VPN endpoint to which to add the route. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Description => Str | ||
| 71 | |||
| 72 | A brief description of the route. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> DestinationCidrBlock => Str | ||
| 77 | |||
| 78 | The IPv4 address range, in CIDR notation, of the route destination. For | ||
| 79 | example: | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | To add a route for Internet access, enter C<0.0.0.0/0> | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | To add a route for an on-premises network, enter the AWS Site-to-Site | ||
| 94 | VPN connection's IPv4 CIDR range | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | To add a route for the local network, enter the client CIDR range | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DryRun => Bool | ||
| 106 | |||
| 107 | Checks whether you have the required permissions for the action, | ||
| 108 | without actually making the request, and provides an error response. If | ||
| 109 | you have the required permissions, the error response is | ||
| 110 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> TargetVpcSubnetId => Str | ||
| 115 | |||
| 116 | The ID of the subnet through which you want to route traffic. The | ||
| 117 | specified subnet must be an existing target network of the Client VPN | ||
| 118 | endpoint. | ||
| 119 | |||
| 120 | Alternatively, if you're adding a route for the local network, specify | ||
| 121 | C<local>. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method CreateClientVpnRoute in L<Paws::EC2> | ||
| 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 |