DAX / Client / create_subnet_group

create_subnet_group#

DAX.Client.create_subnet_group(**kwargs)#

Creates a new subnet group.

See also: AWS API Documentation

Request Syntax

response = client.create_subnet_group(
    SubnetGroupName='string',
    Description='string',
    SubnetIds=[
        'string',
    ]
)
Parameters:
  • SubnetGroupName (string) –

    [REQUIRED]

    A name for the subnet group. This value is stored as a lowercase string.

  • Description (string) – A description for the subnet group

  • SubnetIds (list) –

    [REQUIRED]

    A list of VPC subnet IDs for the subnet group.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SubnetGroup': {
        'SubnetGroupName': 'string',
        'Description': 'string',
        'VpcId': 'string',
        'Subnets': [
            {
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • SubnetGroup (dict) –

      Represents the output of a CreateSubnetGroup operation.

      • SubnetGroupName (string) –

        The name of the subnet group.

      • Description (string) –

        The description of the subnet group.

      • VpcId (string) –

        The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

      • Subnets (list) –

        A list of subnets associated with the subnet group.

        • (dict) –

          Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

          • SubnetIdentifier (string) –

            The system-assigned identifier for the subnet.

          • SubnetAvailabilityZone (string) –

            The Availability Zone (AZ) for the subnet.

Exceptions

  • DAX.Client.exceptions.SubnetGroupAlreadyExistsFault

  • DAX.Client.exceptions.SubnetGroupQuotaExceededFault

  • DAX.Client.exceptions.SubnetQuotaExceededFault

  • DAX.Client.exceptions.InvalidSubnet

  • DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault