You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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: "String", # required
  type: "String", # required
  vpn_gateway_id: "String", # required
  dry_run: false,
  options: {
    static_routes_only: false,
  },
}

Contains the parameters for CreateVpnConnection.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_gateway_idString

The ID of the customer gateway.

Returns:

  • (String)


4210
4211
4212
4213
4214
4215
4216
4217
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4210

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :dry_run,
  :options)
  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)


4210
4211
4212
4213
4214
4215
4216
4217
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4210

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :dry_run,
  :options)
  include Aws::Structure
end

#optionsTypes::VpnConnectionOptionsSpecification

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false



4210
4211
4212
4213
4214
4215
4216
4217
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4210

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :dry_run,
  :options)
  include Aws::Structure
end

#typeString

The type of VPN connection (ipsec.1).

Returns:

  • (String)


4210
4211
4212
4213
4214
4215
4216
4217
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4210

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :dry_run,
  :options)
  include Aws::Structure
end

#vpn_gateway_idString

The ID of the virtual private gateway.

Returns:

  • (String)


4210
4211
4212
4213
4214
4215
4216
4217
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4210

class CreateVpnConnectionRequest < Struct.new(
  :customer_gateway_id,
  :type,
  :vpn_gateway_id,
  :dry_run,
  :options)
  include Aws::Structure
end