Class: Aws::EC2::Types::CreateVpnConnectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateVpnConnectionRequest data as a hash:

{
  customer_gateway_id: "CustomerGatewayId", # required
  type: "String", # required
  vpn_gateway_id: "VpnGatewayId",
  transit_gateway_id: "TransitGatewayId",
  dry_run: false,
  options: {
    enable_acceleration: false,
    static_routes_only: false,
    tunnel_inside_ip_version: "ipv4", # accepts ipv4, ipv6
    tunnel_options: [
      {
        tunnel_inside_cidr: "String",
        tunnel_inside_ipv_6_cidr: "String",
        pre_shared_key: "String",
        phase_1_lifetime_seconds: 1,
        phase_2_lifetime_seconds: 1,
        rekey_margin_time_seconds: 1,
        rekey_fuzz_percentage: 1,
        replay_window_size: 1,
        dpd_timeout_seconds: 1,
        dpd_timeout_action: "String",
        phase_1_encryption_algorithms: [
          {
            value: "String",
          },
        ],
        phase_2_encryption_algorithms: [
          {
            value: "String",
          },
        ],
        phase_1_integrity_algorithms: [
          {
            value: "String",
          },
        ],
        phase_2_integrity_algorithms: [
          {
            value: "String",
          },
        ],
        phase_1_dh_group_numbers: [
          {
            value: 1,
          },
        ],
        phase_2_dh_group_numbers: [
          {
            value: 1,
          },
        ],
        ike_versions: [
          {
            value: "String",
          },
        ],
        startup_action: "String",
      },
    ],
    local_ipv_4_network_cidr: "String",
    remote_ipv_4_network_cidr: "String",
    local_ipv_6_network_cidr: "String",
    remote_ipv_6_network_cidr: "String",
  },
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-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, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, 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-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Contains the parameters for CreateVpnConnection.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_gateway_idString

The ID of the customer gateway.

Returns:

  • (String)


12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#optionsTypes::VpnConnectionOptionsSpecification

The options for the VPN connection.



12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the VPN connection.

Returns:



12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_idString

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

Returns:

  • (String)


12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of VPN connection (ipsec.1).

Returns:

  • (String)


12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_gateway_idString

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

Returns:

  • (String)


12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12035

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :transit_gateway_id,
  :dry_run,
  :options,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end