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

Class: Aws::EC2::Types::CreateCustomerGatewayRequest

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 CreateCustomerGatewayRequest data as a hash:

{
  bgp_asn: 1, # required
  public_ip: "String",
  certificate_arn: "String",
  type: "ipsec.1", # required, accepts ipsec.1
  device_name: "String",
  dry_run: false,
}

Contains the parameters for CreateCustomerGateway.

Instance Attribute Summary collapse

Instance Attribute Details

#bgp_asnInteger

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Returns:

  • (Integer)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  include Aws::Structure
end

#certificate_arnString

The Amazon Resource Name (ARN) for the customer gateway certificate.

Returns:

  • (String)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  include Aws::Structure
end

#device_nameString

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Returns:

  • (String)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  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)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  include Aws::Structure
end

#public_ipString

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

  • (String)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  include Aws::Structure
end

#typeString

The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

  • (String)


4905
4906
4907
4908
4909
4910
4911
4912
4913
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4905

class CreateCustomerGatewayRequest < Struct.new(
  :bgp_asn,
  :public_ip,
  :certificate_arn,
  :type,
  :device_name,
  :dry_run)
  include Aws::Structure
end