CloudFront / Client / create_anycast_ip_list

create_anycast_ip_list

CloudFront.Client.create_anycast_ip_list(**kwargs)

Creates an Anycast static IP list.

See also: AWS API Documentation

Request Syntax

response = client.create_anycast_ip_list(
    Name='string',
    IpCount=123,
    Tags={
        'Items': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    IpAddressType='ipv4'|'ipv6'|'dualstack',
    IpamCidrConfigs=[
        {
            'Cidr': 'string',
            'IpamPoolArn': 'string',
            'AnycastIp': 'string',
            'Status': 'provisioned'|'failed-provision'|'provisioning'|'deprovisioned'|'failed-deprovision'|'deprovisioning'|'advertised'|'failed-advertise'|'advertising'|'withdrawn'|'failed-withdraw'|'withdrawing'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    Name of the Anycast static IP list.

  • IpCount (integer) –

    [REQUIRED]

    The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.

  • Tags (dict) –

    A complex type that contains zero or more Tag elements.

    • Items (list) –

      A complex type that contains Tag elements.

      • (dict) –

        A complex type that contains Tag key and Tag value.

        • Key (string) – [REQUIRED]

          A string that contains Tag key.

          The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

        • Value (string) –

          A string that contains an optional Tag value.

          The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

  • IpAddressType (string) –

    The IP address type for the Anycast static IP list. You can specify one of the following options:

    • ipv4 only

    • ipv6 only

    • dualstack - Allocate a list of both IPv4 and IPv6 addresses

  • IpamCidrConfigs (list) –

    A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for creating the Anycast static IP list.

    • (dict) –

      Configuration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

      • Cidr (string) – [REQUIRED]

        The CIDR that specifies the IP address range for this IPAM configuration.

      • IpamPoolArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.

      • AnycastIp (string) –

        The specified Anycast IP address allocated from the IPAM pool for this CIDR configuration.

      • Status (string) –

        The current status of the IPAM CIDR configuration.

Return type:

dict

Returns:

Response Syntax

{
    'AnycastIpList': {
        'Id': 'string',
        'Name': 'string',
        'Status': 'string',
        'Arn': 'string',
        'IpAddressType': 'ipv4'|'ipv6'|'dualstack',
        'IpamConfig': {
            'Quantity': 123,
            'IpamCidrConfigs': [
                {
                    'Cidr': 'string',
                    'IpamPoolArn': 'string',
                    'AnycastIp': 'string',
                    'Status': 'provisioned'|'failed-provision'|'provisioning'|'deprovisioned'|'failed-deprovision'|'deprovisioning'|'advertised'|'failed-advertise'|'advertising'|'withdrawn'|'failed-withdraw'|'withdrawing'
                },
            ]
        },
        'AnycastIps': [
            'string',
        ],
        'IpCount': 123,
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • AnycastIpList (dict) –

      A response structure that includes the version identifier (ETag) and the created AnycastIpList structure.

      • Id (string) –

        The ID of the Anycast static IP list.

      • Name (string) –

        The name of the Anycast static IP list.

      • Status (string) –

        The status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the Anycast static IP list.

      • IpAddressType (string) –

        The IP address type for the Anycast static IP list.

      • IpamConfig (dict) –

        The IPAM configuration for the Anycast static IP list, that contains the quantity and list of IPAM CIDR configurations.

        • Quantity (integer) –

          The number of IPAM CIDR configurations in the IpamCidrConfigs list.

        • IpamCidrConfigs (list) –

          A list of IPAM CIDR configurations that define the IP address ranges, IPAM pools, and associated Anycast IP addresses.

          • (dict) –

            Configuration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

            • Cidr (string) –

              The CIDR that specifies the IP address range for this IPAM configuration.

            • IpamPoolArn (string) –

              The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.

            • AnycastIp (string) –

              The specified Anycast IP address allocated from the IPAM pool for this CIDR configuration.

            • Status (string) –

              The current status of the IPAM CIDR configuration.

      • AnycastIps (list) –

        The static IP addresses that are allocated to the Anycast static IP list.

        • (string) –

      • IpCount (integer) –

        The number of IP addresses in the Anycast static IP list.

      • LastModifiedTime (datetime) –

        The last time the Anycast static IP list was modified.

    • ETag (string) –

      The version identifier for the current version of the Anycast static IP list.

Exceptions