subnet_groups

Creates, updates, deletes, gets or lists a subnet_groups resource.

Overview

Name	subnet_groups
Type	Resource
Id	aws.dax.subnet_groups

Fields

The following fields are returned by SELECT queries:

describe_subnet_groups

Name	Datatype	Description
description	string	The description of the subnet group.
subnet_group_name	string	The name of the subnet group.
subnets	array	A list of subnets associated with the subnet group.
supported_network_types	array	The network types supported by this subnet. Returns an array of strings that can include ipv4, ipv6, or both, indicating whether the subnet group supports IPv4 only, IPv6 only, or dual-stack deployments.
vpc_id	string	The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_subnet_groups	select	region		Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
create_subnet_group	insert	region, SubnetGroupName, SubnetIds		Creates a new subnet group.
update_subnet_group	update	region, SubnetGroupName		Modifies an existing subnet group.
delete_subnet_group	delete	region		Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_subnet_groups

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

SELECT
description,
subnet_group_name,
subnets,
supported_network_types,
vpc_id
FROM aws.dax.subnet_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_subnet_group

Creates a new subnet group.

INSERT INTO aws.dax.subnet_groups (
SubnetGroupName,
Description,
SubnetIds,
region
)
SELECT 
'{{ SubnetGroupName }}' /* required */,
'{{ Description }}',
'{{ SubnetIds }}' /* required */,
'{{ region }}'
RETURNING
subnet_group
;

Manifest

# Description fields are for documentation purposes
- name: subnet_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the subnet_groups resource.
  - name: SubnetGroupName
    value: "{{ SubnetGroupName }}"
    description: |
      A name for the subnet group. This value is stored as a lowercase string.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the subnet group
  - name: SubnetIds
    value:
      - "{{ SubnetIds }}"
    description: |
      A list of VPC subnet IDs for the subnet group.

UPDATE examples

update_subnet_group

Modifies an existing subnet group.

UPDATE aws.dax.subnet_groups
SET 
SubnetGroupName = '{{ SubnetGroupName }}',
Description = '{{ Description }}',
SubnetIds = '{{ SubnetIds }}'
WHERE 
region = '{{ region }}' --required
AND SubnetGroupName = '{{ SubnetGroupName }}' --required
RETURNING
subnet_group;

DELETE examples

delete_subnet_group

Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.

DELETE FROM aws.dax.subnet_groups
WHERE region = '{{ region }}' --required
;