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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateCustomerGatewayRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  bgp_asn: 1, # required
  public_ip: "String",
  certificate_arn: "String",
  type: "ipsec.1", # required, accepts ipsec.1
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts 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, 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-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  device_name: "String",
  dry_run: false,
}

Contains the parameters for CreateCustomerGateway.

Instance Attribute Summary collapse

Instance Attribute Details

#bgp_asn ⇒ Integer

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

Default: 65000

Returns:

  • (Integer) —

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

#certificate_arn ⇒ String

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

Returns:

  • (String) —

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

#device_name ⇒ String

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Returns:

  • (String) —

    A name for the customer gateway device.

#dry_run ⇒ Boolean

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) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#public_ip ⇒ String

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

Returns:

  • (String) —

    The Internet-routable IP address for the customer gateway\'s outside interface.

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the customer gateway.

Returns:

#type ⇒ String

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

Possible values:

  • ipsec.1

Returns:

  • (String) —

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