Neptune Subnet API - Amazon Neptune

Neptune Subnet API

Structures:

Actions:

Subnet (structure)

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups (action) action.

Fields

  • SubnetAvailabilityZone – An AvailabilityZone object.

    Specifies the EC2 Availability Zone that the subnet is in.

  • SubnetIdentifier – UTF-8 string.

    Specifies the identifier of the subnet.

  • SubnetStatus – UTF-8 string.

    Specifies the status of the subnet.

DBSubnetGroup (structure)

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups (action) action.

Fields

  • DBSubnetGroupArn – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB subnet group.

  • DBSubnetGroupDescription – UTF-8 string.

    Provides the description of the DB subnet group.

  • DBSubnetGroupName – UTF-8 string.

    The name of the DB subnet group.

  • SubnetGroupStatus – UTF-8 string.

    Provides the status of the DB subnet group.

  • Subnets – An array of Subnet Subnet objects.

    Contains a list of Subnet (structure) elements.

  • VpcId – UTF-8 string.

    Provides the VpcId of the DB subnet group.

DBSubnetGroup is used as the response element for:

CreateDBSubnetGroup (action)

        The AWS CLI name for this API is: create-db-subnet-group,  and the Python name is: create_db_subnet_group.

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

Request

  • DBSubnetGroupDescription  (in the CLI: --db-subnet-group-description,  or in Python: db_subnet_group_description) – Required: UTF-8 string.

    The description for the DB subnet group.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – Required: UTF-8 string.

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

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    Example: mySubnetgroup

  • SubnetIds  (in the CLI: --subnet-ids,  or in Python: subnet_ids) – Required: An array of SubnetIdentifier— UTF-8 strings.

    The EC2 Subnet IDs for the DB subnet group.

  • Tags  (in the CLI: --tags,  or in Python: tags) – An array of Tag Tag objects.

    The tags to be assigned to the new DB subnet group.

Response

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups (action) action.

  • DBSubnetGroupArn  (in the CLI: --db-subnet-group-arn,  or in Python: db_subnet_group_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB subnet group.

  • DBSubnetGroupDescription  (in the CLI: --db-subnet-group-description,  or in Python: db_subnet_group_description) – UTF-8 string.

    Provides the description of the DB subnet group.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    The name of the DB subnet group.

  • SubnetGroupStatus  (in the CLI: --subnet-group-status,  or in Python: subnet_group_status) – UTF-8 string.

    Provides the status of the DB subnet group.

  • Subnets  (in the CLI: --subnets,  or in Python: subnets) – An array of Subnet Subnet objects.

    Contains a list of Subnet (structure) elements.

  • VpcId  (in the CLI: --vpc-id,  or in Python: vpc_id) – UTF-8 string.

    Provides the VpcId of the DB subnet group.

DeleteDBSubnetGroup (action)

        The AWS CLI name for this API is: delete-db-subnet-group,  and the Python name is: delete_db_subnet_group.

Deletes a DB subnet group.

Note

The specified database subnet group must not be associated with any DB instances.

Request

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – Required: UTF-8 string.

    The name of the database subnet group to delete.

    Note

    You can't delete the default subnet group.

    Constraints:

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

Response

  • No Response parameters.

ModifyDBSubnetGroup (action)

        The AWS CLI name for this API is: modify-db-subnet-group,  and the Python name is: modify_db_subnet_group.

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

Request

  • DBSubnetGroupDescription  (in the CLI: --db-subnet-group-description,  or in Python: db_subnet_group_description) – UTF-8 string.

    The description for the DB subnet group.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – Required: UTF-8 string.

    The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

  • SubnetIds  (in the CLI: --subnet-ids,  or in Python: subnet_ids) – Required: An array of SubnetIdentifier— UTF-8 strings.

    The EC2 subnet IDs for the DB subnet group.

Response

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups (action) action.

  • DBSubnetGroupArn  (in the CLI: --db-subnet-group-arn,  or in Python: db_subnet_group_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB subnet group.

  • DBSubnetGroupDescription  (in the CLI: --db-subnet-group-description,  or in Python: db_subnet_group_description) – UTF-8 string.

    Provides the description of the DB subnet group.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    The name of the DB subnet group.

  • SubnetGroupStatus  (in the CLI: --subnet-group-status,  or in Python: subnet_group_status) – UTF-8 string.

    Provides the status of the DB subnet group.

  • Subnets  (in the CLI: --subnets,  or in Python: subnets) – An array of Subnet Subnet objects.

    Contains a list of Subnet (structure) elements.

  • VpcId  (in the CLI: --vpc-id,  or in Python: vpc_id) – UTF-8 string.

    Provides the VpcId of the DB subnet group.

DescribeDBSubnetGroups (action)

        The AWS CLI name for this API is: describe-db-subnet-groups,  and the Python name is: describe_db_subnet_groups.

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Request

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    The name of the DB subnet group to return details for.

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Response

  • DBSubnetGroups  (in the CLI: --db-subnet-groups,  or in Python: db_subnet_groups) – An array of DBSubnetGroup DBSubnetGroup objects.

    A list of DBSubnetGroup (structure) instances.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.