EC2 / Client / associate_vpc_cidr_block

associate_vpc_cidr_block#

EC2.Client.associate_vpc_cidr_block(**kwargs)#

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses ( BYOIP). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

response = client.associate_vpc_cidr_block(
    AmazonProvidedIpv6CidrBlock=True|False,
    CidrBlock='string',
    VpcId='string',
    Ipv6CidrBlockNetworkBorderGroup='string',
    Ipv6Pool='string',
    Ipv6CidrBlock='string',
    Ipv4IpamPoolId='string',
    Ipv4NetmaskLength=123,
    Ipv6IpamPoolId='string',
    Ipv6NetmaskLength=123
)
Parameters:

  • AmazonProvidedIpv6CidrBlock (boolean) – Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

  • CidrBlock (string) – An IPv4 CIDR block to associate with the VPC.

  • VpcId (string) –

    [REQUIRED]

    The ID of the VPC.

  • Ipv6CidrBlockNetworkBorderGroup (string) –

    The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

    You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

    You can have one IPv6 CIDR block association per network border group.

  • Ipv6Pool (string) – The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

  • Ipv6CidrBlock (string) –

    An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

    To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

  • Ipv4IpamPoolId (string) – Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

  • Ipv4NetmaskLength (integer) – The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

  • Ipv6IpamPoolId (string) – Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

  • Ipv6NetmaskLength (integer) – The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'Ipv6CidrBlockAssociation': {
        'AssociationId': 'string',
        'Ipv6CidrBlock': 'string',
        'Ipv6CidrBlockState': {
            'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
            'StatusMessage': 'string'
        },
        'NetworkBorderGroup': 'string',
        'Ipv6Pool': 'string'
    },
    'CidrBlockAssociation': {
        'AssociationId': 'string',
        'CidrBlock': 'string',
        'CidrBlockState': {
            'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
            'StatusMessage': 'string'
        }
    },
    'VpcId': 'string'
}

Response Structure

  • (dict) –

    • Ipv6CidrBlockAssociation (dict) –

      Information about the IPv6 CIDR block association.

      • AssociationId (string) –

        The association ID for the IPv6 CIDR block.

      • Ipv6CidrBlock (string) –

        The IPv6 CIDR block.

      • Ipv6CidrBlockState (dict) –

        Information about the state of the CIDR block.

        • State (string) –

          The state of the CIDR block.

        • StatusMessage (string) –

          A message about the status of the CIDR block, if applicable.

      • NetworkBorderGroup (string) –

        The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

      • Ipv6Pool (string) –

        The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

    • CidrBlockAssociation (dict) –

      Information about the IPv4 CIDR block association.

      • AssociationId (string) –

        The association ID for the IPv4 CIDR block.

      • CidrBlock (string) –

        The IPv4 CIDR block.

      • CidrBlockState (dict) –

        Information about the state of the CIDR block.

        • State (string) –

          The state of the CIDR block.

        • StatusMessage (string) –

          A message about the status of the CIDR block, if applicable.

    • VpcId (string) –

      The ID of the VPC.