NAME
Paws::EC2::CreateClientVpnEndpoint - Arguments for method CreateClientVpnEndpoint on Paws::EC2
DESCRIPTION
This class represents the parameters used for calling the method CreateClientVpnEndpoint on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method CreateClientVpnEndpoint.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClientVpnEndpoint.
SYNOPSIS
my $ec2 = Paws->service('EC2');
my $CreateClientVpnEndpointResult = $ec2->CreateClientVpnEndpoint(
AuthenticationOptions => [
{
ActiveDirectory => {
DirectoryId => 'MyString', # OPTIONAL
}, # OPTIONAL
FederatedAuthentication => {
SAMLProviderArn => 'MyString', # OPTIONAL
SelfServiceSAMLProviderArn => 'MyString', # OPTIONAL
}, # OPTIONAL
MutualAuthentication => {
ClientRootCertificateChainArn => 'MyString', # OPTIONAL
}, # OPTIONAL
Type => 'certificate-authentication'
, # values: certificate-authentication, directory-service-authentication, federated-authentication; OPTIONAL
},
...
],
ClientCidrBlock => 'MyString',
ConnectionLogOptions => {
CloudwatchLogGroup => 'MyString', # OPTIONAL
CloudwatchLogStream => 'MyString', # OPTIONAL
Enabled => 1, # OPTIONAL
},
ServerCertificateArn => 'MyString',
ClientConnectOptions => {
Enabled => 1, # OPTIONAL
LambdaFunctionArn => 'MyString', # OPTIONAL
}, # OPTIONAL
ClientToken => 'MyString', # OPTIONAL
Description => 'MyString', # OPTIONAL
DnsServers => [
'MyString', ... # OPTIONAL
], # OPTIONAL
DryRun => 1, # OPTIONAL
SecurityGroupIds => [ 'MySecurityGroupId', ... ], # OPTIONAL
SelfServicePortal => 'enabled', # OPTIONAL
SplitTunnel => 1, # OPTIONAL
TagSpecifications => [
{
ResourceType => 'client-vpn-endpoint'
, # 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
Tags => [
{
Key => 'MyString', # OPTIONAL
Value => 'MyString', # OPTIONAL
},
...
], # OPTIONAL
},
...
], # OPTIONAL
TransportProtocol => 'tcp', # OPTIONAL
VpcId => 'MyVpcId', # OPTIONAL
VpnPort => 1, # OPTIONAL
);
# Results:
my $ClientVpnEndpointId =
$CreateClientVpnEndpointResult->ClientVpnEndpointId;
my $DnsName = $CreateClientVpnEndpointResult->DnsName;
my $Status = $CreateClientVpnEndpointResult->Status;
# Returns a L<Paws::EC2::CreateClientVpnEndpointResult> object.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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateClientVpnEndpoint
ATTRIBUTES
REQUIRED AuthenticationOptions => ArrayRef[Paws::EC2::ClientVpnAuthenticationRequest]
Information about the authentication method to be used to authenticate clients.
REQUIRED ClientCidrBlock => Str
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.
ClientConnectOptions => Paws::EC2::ClientConnectOptions
The options for managing connection authorization for new client connections.
ClientToken => Str
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
REQUIRED ConnectionLogOptions => Paws::EC2::ConnectionLogOptions
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Description => Str
A brief description of the Client VPN endpoint.
DnsServers => ArrayRef[Str|Undef]
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
DryRun => Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
SecurityGroupIds => ArrayRef[Str|Undef]
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
SelfServicePortal => Str
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
Valid values are: "enabled", "disabled"
REQUIRED ServerCertificateArn => Str
The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/).
SplitTunnel => Bool
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the AWS Client VPN Administrator Guide.
TagSpecifications => ArrayRef[Paws::EC2::TagSpecification]
The tags to apply to the Client VPN endpoint during creation.
TransportProtocol => Str
The transport protocol to be used by the VPN session.
Default value: udp
Valid values are: "tcp", "udp"
VpcId => Str
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
VpnPort => Int
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateClientVpnEndpoint in Paws::EC2
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues