vpcdhcp_options_associations

Creates, updates, deletes or gets a vpcdhcp_options_association resource or lists vpcdhcp_options_associations in a region

Overview

Name	vpcdhcp_options_associations
Type	Resource
Description	Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
Id	aws.ec2.vpcdhcp_options_associations

Fields

Name	Datatype	Description
dhcp_options_id	string	The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_id	string	The ID of the VPC.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	VpcId, DhcpOptionsId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vpcdhcp_options_associations in a region.

SELECT
region,
dhcp_options_id,
vpc_id
FROM aws.ec2.vpcdhcp_options_associations
WHERE region = 'us-east-1';

Gets all properties from an individual vpcdhcp_options_association.

SELECT
region,
dhcp_options_id,
vpc_id
FROM aws.ec2.vpcdhcp_options_associations
WHERE region = 'us-east-1' AND data__Identifier = '<DhcpOptionsId>|<VpcId>';

INSERT example

Use the following StackQL query and manifest file to create a new vpcdhcp_options_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.vpcdhcp_options_associations (
 DhcpOptionsId,
 VpcId,
 region
)
SELECT 
'{{ DhcpOptionsId }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.vpcdhcp_options_associations (
 DhcpOptionsId,
 VpcId,
 region
)
SELECT 
 '{{ DhcpOptionsId }}',
 '{{ VpcId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpcdhcp_options_association
    props:
      - name: DhcpOptionsId
        value: '{{ DhcpOptionsId }}'
      - name: VpcId
        value: '{{ VpcId }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.vpcdhcp_options_associations
WHERE data__Identifier = '<DhcpOptionsId|VpcId>'
AND region = 'us-east-1';

Permissions

To operate on the vpcdhcp_options_associations resource, the following permissions are required:

Create

ec2:AssociateDhcpOptions

Update

ec2:AssociateDhcpOptions

Delete

ec2:AssociateDhcpOptions

Read

ec2:DescribeVpcs

List

ec2:DescribeVpcs