create_vpc_attachment

NetworkManager.Client.create_vpc_attachment(**kwargs)

Creates a VPC attachment on an edge location of a core network.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_attachment(
    CoreNetworkId='string',
    VpcArn='string',
    SubnetArns=[
        'string',
    ],
    Options={
        'Ipv6Support': True|False,
        'ApplianceModeSupport': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • CoreNetworkId (string) --

    [REQUIRED]

    The ID of a core network for the VPC attachment.

  • VpcArn (string) --

    [REQUIRED]

    The ARN of the VPC.

  • SubnetArns (list) --

    [REQUIRED]

    The subnet ARN of the VPC attachment.

    • (string) --
  • Options (dict) --

    Options for the VPC attachment.

    • Ipv6Support (boolean) --

      Indicates whether IPv6 is supported.

    • ApplianceModeSupport (boolean) --

      Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .

  • Tags (list) --

    The key-value tags associated with the request.

    • (dict) --

      Describes a tag.

      • Key (string) --

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value (string) --

        The tag value.

        Constraints: Maximum length of 256 characters.

  • ClientToken (string) --

    The client token associated with the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'VpcAttachment': {
        'Attachment': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'AttachmentId': 'string',
            'OwnerAccountId': 'string',
            'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
            'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ProposedSegmentChange': {
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'AttachmentPolicyRuleNumber': 123,
                'SegmentName': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'SubnetArns': [
            'string',
        ],
        'Options': {
            'Ipv6Support': True|False,
            'ApplianceModeSupport': True|False
        }
    }
}

Response Structure

  • (dict) --

    • VpcAttachment (dict) --

      Provides details about the VPC attachment.

      • Attachment (dict) --

        Provides details about the VPC attachment.

        • CoreNetworkId (string) --

          The ID of a core network.

        • CoreNetworkArn (string) --

          The ARN of a core network.

        • AttachmentId (string) --

          The ID of the attachment.

        • OwnerAccountId (string) --

          The ID of the attachment account owner.

        • AttachmentType (string) --

          The type of attachment.

        • State (string) --

          The state of the attachment.

        • EdgeLocation (string) --

          The Region where the edge is located.

        • ResourceArn (string) --

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber (integer) --

          The policy rule number associated with the attachment.

        • SegmentName (string) --

          The name of the segment attachment.

        • Tags (list) --

          The tags associated with the attachment.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange (dict) --

          The attachment to move from one segment to another.

          • Tags (list) --

            The list of key-value tags that changed for the segment.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The tag key.

                Constraints: Maximum length of 128 characters.

              • Value (string) --

                The tag value.

                Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber (integer) --

            The rule number in the policy document that applies to this change.

          • SegmentName (string) --

            The name of the segment to change.

        • CreatedAt (datetime) --

          The timestamp when the attachment was created.

        • UpdatedAt (datetime) --

          The timestamp when the attachment was last updated.

      • SubnetArns (list) --

        The subnet ARNs.

        • (string) --
      • Options (dict) --

        Provides details about the VPC attachment.

        • Ipv6Support (boolean) --

          Indicates whether IPv6 is supported.

        • ApplianceModeSupport (boolean) --

          Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false .

Exceptions

  • NetworkManager.Client.exceptions.ValidationException
  • NetworkManager.Client.exceptions.AccessDeniedException
  • NetworkManager.Client.exceptions.ResourceNotFoundException
  • NetworkManager.Client.exceptions.ConflictException
  • NetworkManager.Client.exceptions.ThrottlingException
  • NetworkManager.Client.exceptions.InternalServerException