AWS CLI Command Reference

[ aws . vpc-lattice ]

create-resource-gateway

Description

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

See also: AWS API Documentation

Synopsis

  create-resource-gateway
[--client-token <value>]
--name <value>
[--vpc-identifier <value>]
[--subnet-ids <value>]
[--security-group-ids <value>]
[--ip-address-type <value>]
[--ipv4-addresses-per-eni <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.

Constraints:

  • min: 1
  • max: 64
  • pattern: .*[!-~]+.*

--name (string) [required]

The name of the resource gateway.

Constraints:

  • min: 3
  • max: 40
  • pattern: (?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+

--vpc-identifier (string)

The ID of the VPC for the resource gateway.

Constraints:

  • min: 5
  • max: 50
  • pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

--subnet-ids (list)

The IDs of the VPC subnets in which to create the resource gateway.

(string)

Constraints:

  • min: 5
  • max: 200

Syntax:

"string" "string" ...

--security-group-ids (list)

The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.

Constraints:

  • min: 0
  • max: 5

(string)

Constraints:

  • min: 5
  • max: 200
  • pattern: sg-(([0-9a-z]{8})|([0-9a-z]{17}))

Syntax:

"string" "string" ...

--ip-address-type (string)

A resource gateway can have IPv4, IPv6 or dualstack addresses. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource, as described here:

  • IPv4 Assign IPv4 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have IPv4 address ranges, and the resource also has an IPv4 address.
  • IPv6 Assign IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets are IPv6 only subnets, and the resource also has an IPv6 address.
  • Dualstack Assign both IPv4 and IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have both IPv4 and IPv6 address ranges, and the resource either has an IPv4 or IPv6 address.

The IP address type of the resource gateway is independent of the IP address type of the client or the VPC endpoint through which the resource is accessed.

Possible values:

  • IPV4
  • IPV6
  • DUALSTACK

--ipv4-addresses-per-eni (integer)

The number of IPv4 addresses in each ENI for the resource gateway.

Constraints:

  • min: 1
  • max: 62

--tags (map)

The tags for the resource gateway.

Constraints:

  • min: 0
  • max: 200

key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws: .

Constraints:

  • min: 1
  • max: 128

value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a resource gateway

The following create-resource-gateway example creates a resource gateway for the specified subnet.

aws vpc-lattice create-resource-gateway \
    --name my-resource-gateway \
    --vpc-identifier vpc-0bf4c2739bc05a69 \
    --subnet-ids subnet-08e8943905b63a683

Output:

{
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourcegateway/rgw-0bba03f3d56060135",
    "id": "rgw-0bba03f3d56060135",
    "ipAddressType": "IPV4",
    "name": "my-resource-gateway",
    "securityGroupIds": [
        "sg-087ffd596c5fe962c"
    ],
    "status": "ACTIVE",
    "subnetIds": [
        "subnet-08e8943905b63a683"
    ],
    "vpcIdentifier": "vpc-0bf4c2739bc05a694"
}

For more information, see Resource gateways in VPC Lattice in the Amazon VPC Lattice User Guide.

Output

name -> (string)

The name of the resource gateway.

Constraints:

  • min: 3
  • max: 40
  • pattern: (?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+

id -> (string)

The ID of the resource gateway.

Constraints:

  • min: 21
  • max: 21
  • pattern: rgw-[0-9a-z]{17}

arn -> (string)

The Amazon Resource Name (ARN) of the resource gateway.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}

status -> (string)

The status of the resource gateway.

Possible values:

  • ACTIVE
  • CREATE_IN_PROGRESS
  • UPDATE_IN_PROGRESS
  • DELETE_IN_PROGRESS
  • CREATE_FAILED
  • UPDATE_FAILED
  • DELETE_FAILED

vpcIdentifier -> (string)

The ID of the VPC.

Constraints:

  • min: 5
  • max: 50
  • pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

subnetIds -> (list)

The IDs of the resource gateway subnets.

(string)

Constraints:

  • min: 5
  • max: 200

securityGroupIds -> (list)

The IDs of the security groups for the resource gateway.

(string)

Constraints:

  • min: 5
  • max: 200
  • pattern: sg-(([0-9a-z]{8})|([0-9a-z]{17}))

ipAddressType -> (string)

The type of IP address for the resource gateway.

Possible values:

  • IPV4
  • IPV6
  • DUALSTACK

ipv4AddressesPerEni -> (integer)

The number of IPv4 addresses in each ENI for the resource gateway.

Constraints:

  • min: 1
  • max: 62
© Copyright 2025, Amazon Web Services. Created using Sphinx.