[ aws . ec2 ]

create-transit-gateway-policy-table-entry

Description

Creates an entry in a transit gateway policy table to route matching traffic to a specified route table.

See also: AWS API Documentation

Synopsis

  create-transit-gateway-policy-table-entry
--transit-gateway-policy-table-id <value>
--policy-rule-number <value>
[--policy-rule <value>]
--target-route-table-id <value>
[--dry-run | --no-dry-run]
[--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

--transit-gateway-policy-table-id (string) [required]

The ID of the transit gateway policy table.

--policy-rule-number (string) [required]

The rule number for the policy table entry. Lower rule numbers are evaluated first and take precedence.

--policy-rule (structure)

The matching criteria for the policy table entry.

SourceCidrBlock -> (string)

The source CIDR block for the policy rule.

SourcePortRange -> (string)

The source port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be * .

DestinationCidrBlock -> (string)

The destination CIDR block for the policy rule.

DestinationPortRange -> (string)

The destination port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be * .

Protocol -> (string)

The protocol for the policy rule. Valid values are 1 (ICMP), 6 (TCP), 17 (UDP), 47 (GRE), or * for all protocols.

MetaData -> (structure)

The metadata key-value pair for the policy rule.

MetaDataKey -> (string)

The key of the metadata pair for the policy rule.

MetaDataValue -> (string)

The value of the metadata pair for the policy rule.

Shorthand Syntax:

SourceCidrBlock=string,SourcePortRange=string,DestinationCidrBlock=string,DestinationPortRange=string,Protocol=string,MetaData={MetaDataKey=string,MetaDataValue=string}

JSON Syntax:

{
  "SourceCidrBlock": "string",
  "SourcePortRange": "string",
  "DestinationCidrBlock": "string",
  "DestinationPortRange": "string",
  "Protocol": "string",
  "MetaData": {
    "MetaDataKey": "string",
    "MetaDataValue": "string"
  }
}

--target-route-table-id (string) [required]

The ID of the transit gateway route table to use for traffic matching this rule.

--dry-run | --no-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 .

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

TransitGatewayPolicyTableEntry -> (structure)

Describes a transit gateway policy table entry

PolicyRuleNumber -> (string)

The rule number for the transit gateway policy table entry.

PolicyRule -> (structure)

The policy rule associated with the transit gateway policy table.

SourceCidrBlock -> (string)

The source CIDR block for the transit gateway policy rule.

SourcePortRange -> (string)

The source port or port range for the transit gateway policy rule.

DestinationCidrBlock -> (string)

The destination CIDR block for the transit gateway policy rule.

DestinationPortRange -> (string)

The destination port or port range for the transit gateway policy rule.

Protocol -> (string)

The protocol used by the transit gateway policy rule.

MetaData -> (structure)

The meta data tags used for the transit gateway policy rule.

MetaDataKey -> (string)

The key name for the transit gateway policy rule meta data tag.

MetaDataValue -> (string)

The value of the key for the transit gateway policy rule meta data tag.

TargetRouteTableId -> (string)

The ID of the target route table.

State -> (string)

The state of the transit gateway policy table entry.

Possible values:

• active
• deleted