list-attachment-nat-configurations¶

Description¶

Returns the NAT configurations of core network attachments. You must specify either a core network ID or an attachment ID. Only the core network owner can list NAT configurations.

Synopsis¶

  list-attachment-nat-configurations
[--core-network-id <value>]
[--attachment-id <value>]
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]
[--cli-error-format <value>]

Options¶

--core-network-id (string)

The ID of a core network. Returns the NAT configurations of attachments in the core network that support NAT.

Constraints:

min: 0

max: 50

pattern: ^core-network-([0-9a-f]{8,17})$

--attachment-id (string)

The ID of an attachment. Returns the NAT configuration of the specified attachment. If you specify both an attachment ID and a core network ID, the attachment ID is used.

Constraints:

min: 0

max: 50

pattern: ^attachment-([0-9a-f]{8,17})$

--filters (map)

The filters to apply to the results. Values for the same filter are joined with OR, and different filters are joined with AND. You can specify up to 10 filter values in total. The following filters are supported:

nat-gateway-support : The state of NAT gateway support on the attachment, for example ENABLED .

nat-system-route-support : Whether system routes are installed for the attachment, true or false .

rule-number : The rule number of a NAT rule.

match-source-cidr : The source CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.

nat-cidr : The NAT CIDR block of a NAT rule. The value must exactly match the CIDR block of the rule.

nat-rule-state : The state of a NAT rule, for example ACTIVATED .

key -> (string)

Constraints:

max: 128

pattern: ^[0-9a-zA-Z\.-]*$

value -> (list)

(string)

Constraints:

max: 255

pattern: ^[0-9a-zA-Z\*\.\\/\?-]*$

Shorthand Syntax:

KeyName1=string,string,KeyName2=string,string

JSON Syntax:

{"string": ["string", ...]
  ...}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 500

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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
off

--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.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

AttachmentNatConfigurations -> (list)

The NAT configurations of the attachments.

Constraints:

min: 0

max: 500

(structure)

Describes the NAT configuration of a core network attachment.

AttachmentId -> (string)

The ID of the attachment.

Constraints:

min: 0

max: 50

pattern: ^attachment-([0-9a-f]{8,17})$

NatGatewaySupport -> (string)

The state of NAT gateway support on the attachment.

Possible values:

ENABLED

ENABLING

DISABLED

DISABLING

PENDING_ATTACHMENT_ACCEPTANCE

NatSystemRouteSupport -> (boolean)

Indicates whether the core network installs system routes for the NAT CIDR blocks of the attachment’s NAT rules.

NatGatewayRules -> (list)

The NAT rules of the attachment.

Constraints:

min: 0

max: 50

(structure)

Describes a NAT rule of an attachment.

RuleNumber -> (integer)

The rule number. Rule numbers identify the rules of an attachment and don’t set the order in which rules are evaluated.

Constraints:

min: 1

max: 32766

MatchSourceCidr -> (string)

The source CIDR block that the rule matches for traffic from the attachment.

Constraints:

min: 1

max: 50

pattern: [\s\S]*

NatCidr -> (string)

The CIDR block that matching source addresses are translated to.

Constraints:

min: 1

max: 50

pattern: [\s\S]*

State -> (string)

The state of the NAT rule. The possible values are the following:

CREATING : The rule is being created.

MODIFYING : The rule is being modified.

DELETING : The rule is being deleted.

ACTIVATING : NAT gateway support is being enabled, and the rule is being applied.

ACTIVATED : NAT gateway support is enabled, and the rule is applied.

DEACTIVATING : NAT gateway support is being disabled, and the rule is being removed from use.

DEACTIVATED : NAT gateway support is disabled, and the rule isn’t applied.

FAILED : The attachment failed to be created, and the rule isn’t applied.

PENDING_ATTACHMENT_ACCEPTANCE : The attachment is pending acceptance. The rule is applied after the attachment is accepted.

Possible values:

CREATING

MODIFYING

DELETING

ACTIVATED

ACTIVATING

DEACTIVATED

DEACTIVATING

FAILED

PENDING_ATTACHMENT_ACCEPTANCE

NextToken -> (string)

The token for the next page of results.

Constraints:

min: 0

max: 2048

pattern: [\s\S]*

Table of Contents

Feedback

User Guide