« blib/lib/Paws/EC2/CreateVolumePermissionModifications.pm
↑ Summary
blib/lib/Paws/EC2/CreateVpcEndpointConnectionNotification.pm »
| 1 | |||
| 2 | package Paws::EC2::CreateVpcEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has PolicyDocument => (is => 'ro', isa => 'Str'); | ||
| 7 | has PrivateDnsEnabled => (is => 'ro', isa => 'Bool'); | ||
| 8 | has RouteTableIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'RouteTableId' ); | ||
| 9 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SecurityGroupId' ); | ||
| 10 | has ServiceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SubnetId' ); | ||
| 12 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 13 | has VpcEndpointType => (is => 'ro', isa => 'Str'); | ||
| 14 | has VpcId => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateVpcEndpoint'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateVpcEndpointResult'); | ||
| 20 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::EC2::CreateVpcEndpoint - Arguments for method CreateVpcEndpoint on L<Paws::EC2> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method CreateVpcEndpoint on the | ||
| 32 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 33 | as arguments to method CreateVpcEndpoint. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateVpcEndpoint. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $ec2 = Paws->service('EC2'); | ||
| 40 | my $CreateVpcEndpointResult = $ec2->CreateVpcEndpoint( | ||
| 41 | ServiceName => 'MyString', | ||
| 42 | VpcId => 'MyVpcId', | ||
| 43 | ClientToken => 'MyString', # OPTIONAL | ||
| 44 | DryRun => 1, # OPTIONAL | ||
| 45 | PolicyDocument => 'MyString', # OPTIONAL | ||
| 46 | PrivateDnsEnabled => 1, # OPTIONAL | ||
| 47 | RouteTableIds => [ 'MyRouteTableId', ... ], # OPTIONAL | ||
| 48 | SecurityGroupIds => [ 'MySecurityGroupId', ... ], # OPTIONAL | ||
| 49 | SubnetIds => [ 'MySubnetId', ... ], # OPTIONAL | ||
| 50 | TagSpecifications => [ | ||
| 51 | { | ||
| 52 | ResourceType => 'client-vpn-endpoint' | ||
| 53 | , # 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 | ||
| 54 | Tags => [ | ||
| 55 | { | ||
| 56 | Key => 'MyString', | ||
| 57 | Value => 'MyString', | ||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | }, | ||
| 62 | ... | ||
| 63 | ], # OPTIONAL | ||
| 64 | VpcEndpointType => 'Interface', # OPTIONAL | ||
| 65 | ); | ||
| 66 | |||
| 67 | # Results: | ||
| 68 | my $ClientToken = $CreateVpcEndpointResult->ClientToken; | ||
| 69 | my $VpcEndpoint = $CreateVpcEndpointResult->VpcEndpoint; | ||
| 70 | |||
| 71 | # Returns a L<Paws::EC2::CreateVpcEndpointResult> object. | ||
| 72 | |||
| 73 | 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. | ||
| 74 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateVpcEndpoint> | ||
| 75 | |||
| 76 | =head1 ATTRIBUTES | ||
| 77 | |||
| 78 | |||
| 79 | =head2 ClientToken => Str | ||
| 80 | |||
| 81 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 82 | idempotency of the request. For more information, see How to Ensure | ||
| 83 | Idempotency | ||
| 84 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 DryRun => Bool | ||
| 89 | |||
| 90 | Checks whether you have the required permissions for the action, | ||
| 91 | without actually making the request, and provides an error response. If | ||
| 92 | you have the required permissions, the error response is | ||
| 93 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 PolicyDocument => Str | ||
| 98 | |||
| 99 | (Interface and gateway endpoints) A policy to attach to the endpoint | ||
| 100 | that controls access to the service. The policy must be in valid JSON | ||
| 101 | format. If this parameter is not specified, we attach a default policy | ||
| 102 | that allows full access to the service. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 PrivateDnsEnabled => Bool | ||
| 107 | |||
| 108 | (Interface endpoint) Indicates whether to associate a private hosted | ||
| 109 | zone with the specified VPC. The private hosted zone contains a record | ||
| 110 | set for the default public DNS name for the service for the Region (for | ||
| 111 | example, C<kinesis.us-east-1.amazonaws.com>), which resolves to the | ||
| 112 | private IP addresses of the endpoint network interfaces in the VPC. | ||
| 113 | This enables you to make requests to the default public DNS name for | ||
| 114 | the service instead of the public DNS names that are automatically | ||
| 115 | generated by the VPC endpoint service. | ||
| 116 | |||
| 117 | To use a private hosted zone, you must set the following VPC attributes | ||
| 118 | to C<true>: C<enableDnsHostnames> and C<enableDnsSupport>. Use | ||
| 119 | ModifyVpcAttribute to set the VPC attributes. | ||
| 120 | |||
| 121 | Default: C<true> | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 RouteTableIds => ArrayRef[Str|Undef] | ||
| 126 | |||
| 127 | (Gateway endpoint) One or more route table IDs. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 132 | |||
| 133 | (Interface endpoint) The ID of one or more security groups to associate | ||
| 134 | with the endpoint network interface. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> ServiceName => Str | ||
| 139 | |||
| 140 | The service name. To get a list of available services, use the | ||
| 141 | DescribeVpcEndpointServices request, or get the name from the service | ||
| 142 | provider. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 147 | |||
| 148 | (Interface and Gateway Load Balancer endpoints) The ID of one or more | ||
| 149 | subnets in which to create an endpoint network interface. For a Gateway | ||
| 150 | Load Balancer endpoint, you can specify one subnet only. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 155 | |||
| 156 | The tags to associate with the endpoint. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 VpcEndpointType => Str | ||
| 161 | |||
| 162 | The type of endpoint. | ||
| 163 | |||
| 164 | Default: Gateway | ||
| 165 | |||
| 166 | Valid values are: C<"Interface">, C<"Gateway">, C<"GatewayLoadBalancer"> | ||
| 167 | |||
| 168 | =head2 B<REQUIRED> VpcId => Str | ||
| 169 | |||
| 170 | The ID of the VPC in which the endpoint will be used. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, documenting arguments for method CreateVpcEndpoint in L<Paws::EC2> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |