EC2 / Client / modify_transit_gateway_vpc_attachment

modify_transit_gateway_vpc_attachment

EC2.Client.modify_transit_gateway_vpc_attachment(**kwargs)

Modifies the specified VPC attachment.

See also: AWS API Documentation

Request Syntax

response = client.modify_transit_gateway_vpc_attachment(
    TransitGatewayAttachmentId='string',
    AddSubnetIds=[
        'string',
    ],
    RemoveSubnetIds=[
        'string',
    ],
    Options={
        'DnsSupport': 'enable'|'disable',
        'SecurityGroupReferencingSupport': 'enable'|'disable',
        'Ipv6Support': 'enable'|'disable',
        'ApplianceModeSupport': 'enable'|'disable'
    },
    DryRun=True|False
)

Parameters:

• TransitGatewayAttachmentId (string) –

  [REQUIRED]

  The ID of the attachment.

• AddSubnetIds (list) –

  The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

  • (string) –

• RemoveSubnetIds (list) –

  The IDs of one or more subnets to remove.

  • (string) –

• Options (dict) –

  The new VPC attachment options.

  • DnsSupport (string) –

    Enable or disable DNS support. The default is enable.

  • SecurityGroupReferencingSupport (string) –

    Note

    This parameter is in preview and may not be available for your account.

    Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

  • Ipv6Support (string) –

    Enable or disable IPv6 support. The default is enable.

  • ApplianceModeSupport (string) –

    Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.

• DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayVpcAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'TransitGatewayId': 'string',
        'VpcId': 'string',
        'VpcOwnerId': 'string',
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'SubnetIds': [
            'string',
        ],
        'CreationTime': datetime(2015, 1, 1),
        'Options': {
            'DnsSupport': 'enable'|'disable',
            'SecurityGroupReferencingSupport': 'enable'|'disable',
            'Ipv6Support': 'enable'|'disable',
            'ApplianceModeSupport': 'enable'|'disable'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • TransitGatewayVpcAttachment (dict) –

    Information about the modified attachment.

    • TransitGatewayAttachmentId (string) –

      The ID of the attachment.

    • TransitGatewayId (string) –

      The ID of the transit gateway.

    • VpcId (string) –

      The ID of the VPC.

    • VpcOwnerId (string) –

      The ID of the Amazon Web Services account that owns the VPC.

    • State (string) –

      The state of the VPC attachment. Note that the initiating state has been deprecated.

    • SubnetIds (list) –

      The IDs of the subnets.

      • (string) –

    • CreationTime (datetime) –

      The creation time.

    • Options (dict) –

      The VPC attachment options.

      • DnsSupport (string) –

        Indicates whether DNS support is enabled.

      • SecurityGroupReferencingSupport (string) –

        Note

        This parameter is in preview and may not be available for your account.

        Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

      • Ipv6Support (string) –

        Indicates whether IPv6 support is disabled.

      • ApplianceModeSupport (string) –

        Indicates whether appliance mode support is enabled.

    • Tags (list) –

      The tags for the VPC attachment.

      • (dict) –

        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.