Skip to content

Modify Transit Gateway

ec2_modify_transit_gateway R Documentation

Modifies the specified transit gateway

Description

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

Usage

ec2_modify_transit_gateway(TransitGatewayId, Description, Options,
  DryRun)

Arguments

TransitGatewayId

[required] The ID of the transit gateway.

Description

The description for the transit gateway.

Options

The options to modify.

DryRun

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.

Value

A list with the following syntax:

list(
  TransitGateway = list(
    TransitGatewayId = "string",
    TransitGatewayArn = "string",
    State = "pending"|"available"|"modifying"|"deleting"|"deleted",
    OwnerId = "string",
    Description = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    Options = list(
      AmazonSideAsn = 123,
      TransitGatewayCidrBlocks = list(
        "string"
      ),
      AutoAcceptSharedAttachments = "enable"|"disable",
      DefaultRouteTableAssociation = "enable"|"disable",
      AssociationDefaultRouteTableId = "string",
      DefaultRouteTablePropagation = "enable"|"disable",
      PropagationDefaultRouteTableId = "string",
      VpnEcmpSupport = "enable"|"disable",
      DnsSupport = "enable"|"disable",
      SecurityGroupReferencingSupport = "enable"|"disable",
      MulticastSupport = "enable"|"disable"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$modify_transit_gateway(
  TransitGatewayId = "string",
  Description = "string",
  Options = list(
    AddTransitGatewayCidrBlocks = list(
      "string"
    ),
    RemoveTransitGatewayCidrBlocks = list(
      "string"
    ),
    VpnEcmpSupport = "enable"|"disable",
    DnsSupport = "enable"|"disable",
    SecurityGroupReferencingSupport = "enable"|"disable",
    AutoAcceptSharedAttachments = "enable"|"disable",
    DefaultRouteTableAssociation = "enable"|"disable",
    AssociationDefaultRouteTableId = "string",
    DefaultRouteTablePropagation = "enable"|"disable",
    PropagationDefaultRouteTableId = "string",
    AmazonSideAsn = 123
  ),
  DryRun = TRUE|FALSE
)