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	awscc.ec2.vpcdhcp_options_associations

Fields

get (all properties)

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.

list (identifiers only)

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.

For more information, see AWS::EC2::VPCDHCPOptionsAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpcdhcp_options_associations	INSERT	VpcId, DhcpOptionsId, region
delete_resource	vpcdhcp_options_associations	DELETE	Identifier, region
update_resource	vpcdhcp_options_associations	UPDATE	Identifier, PatchDocument, region
list_resources	vpcdhcp_options_associations_list_only	SELECT	region
get_resource	vpcdhcp_options_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpcdhcp_options_association.

SELECT
  region,
  dhcp_options_id,
  vpc_id
FROM awscc.ec2.vpcdhcp_options_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ dhcp_options_id }}|{{ vpc_id }}';

list (identifiers only)

Lists all vpcdhcp_options_associations in a region.

SELECT
  region,
  dhcp_options_id,
  vpc_id
FROM awscc.ec2.vpcdhcp_options_associations_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.vpcdhcp_options_associations (
  DhcpOptionsId,
  VpcId,
  region
)
SELECT
  '{{ dhcp_options_id }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpcdhcp_options_associations (
  DhcpOptionsId,
  VpcId,
  region
)
SELECT
  '{{ dhcp_options_id }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: dhcp_options_id
      value: '{{ dhcp_options_id }}'
    - name: vpc_id
      value: '{{ vpc_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpcdhcp_options_associations
WHERE
  Identifier = '{{ dhcp_options_id }}|{{ vpc_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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