« blib/lib/Paws/EC2/AuthorizationRule.pm
↑ Summary
blib/lib/Paws/EC2/AuthorizeClientVpnIngressResult.pm »
| 1 | |||
| 2 | package Paws::EC2::AuthorizeClientVpnIngress; | ||
| 3 | use Moose; | ||
| 4 | has AccessGroupId => (is => 'ro', isa => 'Str'); | ||
| 5 | has AuthorizeAllGroups => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has ClientVpnEndpointId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Description => (is => 'ro', isa => 'Str'); | ||
| 9 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 10 | has TargetNetworkCidr => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AuthorizeClientVpnIngress'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::AuthorizeClientVpnIngressResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::EC2::AuthorizeClientVpnIngress - Arguments for method AuthorizeClientVpnIngress on L<Paws::EC2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method AuthorizeClientVpnIngress on the | ||
| 28 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 29 | as arguments to method AuthorizeClientVpnIngress. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AuthorizeClientVpnIngress. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ec2 = Paws->service('EC2'); | ||
| 36 | my $AuthorizeClientVpnIngressResult = $ec2->AuthorizeClientVpnIngress( | ||
| 37 | ClientVpnEndpointId => 'MyClientVpnEndpointId', | ||
| 38 | TargetNetworkCidr => 'MyString', | ||
| 39 | AccessGroupId => 'MyString', # OPTIONAL | ||
| 40 | AuthorizeAllGroups => 1, # OPTIONAL | ||
| 41 | ClientToken => 'MyString', # OPTIONAL | ||
| 42 | Description => 'MyString', # OPTIONAL | ||
| 43 | DryRun => 1, # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Status = $AuthorizeClientVpnIngressResult->Status; | ||
| 48 | |||
| 49 | # Returns a L<Paws::EC2::AuthorizeClientVpnIngressResult> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/AuthorizeClientVpnIngress> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 AccessGroupId => Str | ||
| 58 | |||
| 59 | The ID of the group to grant access to, for example, the Active | ||
| 60 | Directory group or identity provider (IdP) group. Required if | ||
| 61 | C<AuthorizeAllGroups> is C<false> or not specified. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 AuthorizeAllGroups => Bool | ||
| 66 | |||
| 67 | Indicates whether to grant access to all clients. Specify C<true> to | ||
| 68 | grant all clients who successfully establish a VPN connection access to | ||
| 69 | the network. Must be set to C<true> if C<AccessGroupId> is not | ||
| 70 | specified. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ClientToken => Str | ||
| 75 | |||
| 76 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 77 | idempotency of the request. For more information, see How to Ensure | ||
| 78 | Idempotency | ||
| 79 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> ClientVpnEndpointId => Str | ||
| 84 | |||
| 85 | The ID of the Client VPN endpoint. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Description => Str | ||
| 90 | |||
| 91 | A brief description of the authorization rule. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 DryRun => Bool | ||
| 96 | |||
| 97 | Checks whether you have the required permissions for the action, | ||
| 98 | without actually making the request, and provides an error response. If | ||
| 99 | you have the required permissions, the error response is | ||
| 100 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> TargetNetworkCidr => Str | ||
| 105 | |||
| 106 | The IPv4 address range, in CIDR notation, of the network for which | ||
| 107 | access is being authorized. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method AuthorizeClientVpnIngress in L<Paws::EC2> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |