Modifies the options for a transit gateway peering attachment. The peering attachment must be in the available state.
You can allow multipath resilience for your side of an inter-Region transit gateway peering attachment between supported Regions. Multipath resilience isn’t supported for transit gateway peering attachments in the same Region. It takes effect only when both the requester and the accepter allow it. To modify the requester side, send the request in the Region of the requester transit gateway. To modify the accepter side, send the request in the Region of the accepter transit gateway. To check whether multipath resilience is in effect, use DescribeTransitGatewayPeeringAttachments and check multipathResilienceStatus .
See also: AWS API Documentation
modify-transit-gateway-peering-attachment
--transit-gateway-attachment-id <value>
[--options <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>]
[--help]
--transit-gateway-attachment-id (string) [required]
The ID of the transit gateway peering attachment.
--options (structure)
The options to modify for the transit gateway peering attachment.
AllowMultipathResilience -> (boolean)
Specifies whether you allow multipath resilience for your side of the transit gateway peering attachment. Multipath resilience is supported only for inter-Region transit gateway peering attachments between supported Regions. It takes effect only when both the requester and the accepter allow it. If you don’t specify this parameter, the current setting doesn’t change.MultipathResilienceMode -> (string)
The multipath resilience mode. You can specify this parameter only if
AllowMultipathResilienceistrue.The following value is valid:
always-on– Replicates traffic across multiple network paths while multipath resilience is in effect.If
AllowMultipathResilienceistrueand you don’t specify a mode, the default isalways-on.Possible values:
always-on
Shorthand Syntax:
AllowMultipathResilience=boolean,MultipathResilienceMode=string
JSON Syntax:
{
"AllowMultipathResilience": true|false,
"MultipathResilienceMode": "always-on"
}
--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 isDryRunOperation. Otherwise, it isUnauthorizedOperation.
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
TransitGatewayPeeringAttachment -> (structure)
Information about the transit gateway peering attachment.
TransitGatewayAttachmentId -> (string)
The ID of the transit gateway peering attachment.AccepterTransitGatewayAttachmentId -> (string)
The ID of the accepter transit gateway attachment.RequesterTgwInfo -> (structure)
Information about the requester transit gateway.
TransitGatewayId -> (string)
The ID of the transit gateway.CoreNetworkId -> (string)
The ID of the core network where the transit gateway peer is located.OwnerId -> (string)
The ID of the Amazon Web Services account that owns the transit gateway.Region -> (string)
The Region of the transit gateway.AccepterTgwInfo -> (structure)
Information about the accepter transit gateway.
TransitGatewayId -> (string)
The ID of the transit gateway.CoreNetworkId -> (string)
The ID of the core network where the transit gateway peer is located.OwnerId -> (string)
The ID of the Amazon Web Services account that owns the transit gateway.Region -> (string)
The Region of the transit gateway.Options -> (structure)
Details about the transit gateway peering attachment.
DynamicRouting -> (string)
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
Possible values:
enabledisableRequesterAllowMultipathResilience -> (boolean)
Indicates whether the requester allows multipath resilience for the transit gateway peering attachment.RequesterMultipathResilienceMode -> (string)
The multipath resilience mode for the requester. This value is present only when the requester allows multipath resilience.
Possible values:
always-onAccepterAllowMultipathResilience -> (boolean)
Indicates whether the accepter allows multipath resilience for the transit gateway peering attachment.AccepterMultipathResilienceMode -> (string)
The multipath resilience mode for the accepter. This value is present only when the accepter allows multipath resilience.
Possible values:
always-onMultipathResilienceStatus -> (string)
The multipath resilience status of the transit gateway peering attachment. The possible values are:
enabled– Both the requester and the accepter allow multipath resilience.pending– Either the requester or the accepter allows multipath resilience, but not both.disabled– Neither the requester nor the accepter allows multipath resilience.Possible values:
pendingenableddisabledStatus -> (structure)
The status of the transit gateway peering attachment.
Code -> (string)
The status code.Message -> (string)
The status message, if applicable.State -> (string)
The state of the transit gateway peering attachment. Note that the
initiatingstate has been deprecated.Possible values:
initiatinginitiatingRequestpendingAcceptancerollingBackpendingavailablemodifyingdeletingdeletedfailedrejectedrejectingfailingCreationTime -> (timestamp)
The time the transit gateway peering attachment was created.Tags -> (list)
The tags for the transit gateway peering attachment.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value -> (string)
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.