dhcp_options

Creates, updates, deletes or gets a dhcp_option resource or lists dhcp_options in a region

Overview

Name	dhcp_options
Type	Resource
Description	Resource Type definition for AWS::EC2::DHCPOptions
Id	awscc.ec2.dhcp_options

Fields

get (all properties)

Name	Datatype	Description
dhcp_options_id	string
domain_name	string	This value is used to complete unqualified DNS hostnames.
domain_name_servers	array	The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
netbios_name_servers	array	The IPv4 addresses of up to four NetBIOS name servers.
netbios_node_type	integer	The NetBIOS node type (1, 2, 4, or 8).
ntp_servers	array	The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
ipv6_address_preferred_lease_time	integer	The preferred Lease Time for ipV6 address in seconds.
▶tags	array	Any tags assigned to the DHCP options set.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
dhcp_options_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	dhcp_options	INSERT	region
delete_resource	dhcp_options	DELETE	Identifier, region
update_resource	dhcp_options	UPDATE	Identifier, PatchDocument, region
list_resources	dhcp_options_list_only	SELECT	region
get_resource	dhcp_options	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dhcp_option.

SELECT
  region,
  dhcp_options_id,
  domain_name,
  domain_name_servers,
  netbios_name_servers,
  netbios_node_type,
  ntp_servers,
  ipv6_address_preferred_lease_time,
  tags
FROM awscc.ec2.dhcp_options
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ dhcp_options_id }}';

list (identifiers only)

Lists all dhcp_options in a region.

SELECT
  region,
  dhcp_options_id
FROM awscc.ec2.dhcp_options_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.dhcp_options (
  DomainName,
  DomainNameServers,
  NetbiosNameServers,
  NetbiosNodeType,
  NtpServers,
  Ipv6AddressPreferredLeaseTime,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ domain_name_servers }}',
  '{{ netbios_name_servers }}',
  '{{ netbios_node_type }}',
  '{{ ntp_servers }}',
  '{{ ipv6_address_preferred_lease_time }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.dhcp_options (
  DomainName,
  DomainNameServers,
  NetbiosNameServers,
  NetbiosNodeType,
  NtpServers,
  Ipv6AddressPreferredLeaseTime,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ domain_name_servers }}',
  '{{ netbios_name_servers }}',
  '{{ netbios_node_type }}',
  '{{ ntp_servers }}',
  '{{ ipv6_address_preferred_lease_time }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dhcp_option
    props:
      - name: domain_name
        value: '{{ domain_name }}'
      - name: domain_name_servers
        value:
          - '{{ domain_name_servers[0] }}'
      - name: netbios_name_servers
        value:
          - '{{ netbios_name_servers[0] }}'
      - name: netbios_node_type
        value: '{{ netbios_node_type }}'
      - name: ntp_servers
        value:
          - '{{ ntp_servers[0] }}'
      - name: ipv6_address_preferred_lease_time
        value: '{{ ipv6_address_preferred_lease_time }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a dhcp_option resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.dhcp_options
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ dhcp_options_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.dhcp_options
WHERE
  Identifier = '{{ dhcp_options_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

ec2:CreateDhcpOptions,
ec2:DescribeDhcpOptions,
ec2:CreateTags

Read

ec2:DescribeDhcpOptions,
ec2:DescribeTags

Update

ec2:CreateTags,
ec2:DescribeDhcpOptions,
ec2:DeleteTags

Delete

ec2:DeleteDhcpOptions,
ec2:DeleteTags,
ec2:DescribeDhcpOptions

List

ec2:DescribeDhcpOptions