Class: Aws::EC2::Types::CreateCarrierGatewayRequest

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

{
  vpc_id: "VpcId", # required
  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",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


5868
5869
5870
5871
5872
5873
5874
5875
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5868

class CreateCarrierGatewayRequest < Struct.new(
  :vpc_id,
  :tag_specifications,
  :dry_run,
  :client_token)
  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)


5868
5869
5870
5871
5872
5873
5874
5875
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5868

class CreateCarrierGatewayRequest < Struct.new(
  :vpc_id,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to associate with the carrier gateway.

Returns:



5868
5869
5870
5871
5872
5873
5874
5875
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5868

class CreateCarrierGatewayRequest < Struct.new(
  :vpc_id,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The ID of the VPC to associate with the carrier gateway.

Returns:

  • (String)


5868
5869
5870
5871
5872
5873
5874
5875
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5868

class CreateCarrierGatewayRequest < Struct.new(
  :vpc_id,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end