Class DhcpOptsConfig

NetworkConfig / DhcpOptsConfig

VPC Dynamic Host Configuration Protocol (DHCP) options sets configuration. Use this configuration to define custom DHCP options sets for your VPCs. Custom DHCP option sets give you control over the DNS servers, domain names, or Network Time Protocol (NTP) servers used by the devices in your VPC.

The following example creates a DHCP option set named accelerator-dhcp-opts in the Network account in the us-east-1 region. The options set assigns a domain name of example.com to hosts in the VPC and configures the DNS server to 1.1.1.1.

Example

dhcpOptions:
  - name: accelerator-dhcp-opts
    accounts:
      - Network
    regions:
      - us-east-1
    domainName: example.com
    domainNameServers
      - 1.1.1.1
    tags: []

Hierarchy

  • DhcpOptsConfig

Implements

Constructors

constructor

Properties

accounts domainName domainNameServers name netbiosNameServers netbiosNodeType ntpServers regions tags

Constructors

constructor

Properties

Readonly accounts

accounts: string[] = ...

An array of friendly account names to deploy the options set.

Remarks

This is the logical name property of the account as defined in accounts-config.yaml.

Readonly domainName

domainName: undefined | string = undefined

(OPTIONAL) A domain name to assign to hosts using the options set.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly domainNameServers

domainNameServers: undefined | string[] = undefined

(OPTIONAL) An array of IP addresses for domain name servers.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly name

name: string = ''

A friendly name for the DHCP options set.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly netbiosNameServers

netbiosNameServers: undefined | string[] = undefined

(OPTIONAL An array of IP addresses for NetBIOS servers.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly netbiosNodeType

netbiosNodeType: undefined | 2 | 1 | 4 | 8 = undefined

(OPTIONAL) The NetBIOS node type number.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

See

netbiosNodeEnum

Readonly ntpServers

ntpServers: undefined | string[] = undefined

(OPTIONAL) An array of IP addresses for NTP servers.

Remarks

CAUTION: Changing this property value after initial deployment causes the DHCP options set to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly regions

regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "cn-north-1" | "cn-northwest-1" | "eu-central-2" | "ap-south-2" | "us-gov-west-1" | "us-gov-east-1" | "us-iso-east-1" | "us-iso-west-1" | "us-isob-east-1" | "ap-southeast-4")[] = ...

An array of regions to deploy the options set.

See

Region

Readonly tags

tags: undefined | Tag[] = undefined

(OPTIONAL) An array of tags for the options set.

Settings

Member Visibility

Theme

Generated using TypeDoc