aws-cdk-lib.aws_ec2.CfnDHCPOptionsProps

CfnDHCPOptionsProps Struct

Properties for defining a CfnDHCPOptions.

Source

Generated code

Type last changed

v2.134.0 · 26 Mar 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnDHCPOptionsProps: ec2.CfnDHCPOptionsProps = {
  domainName: 'domainName',
  domainNameServers: ['domainNameServers'],
  ipv6AddressPreferredLeaseTime: 123,
  netbiosNameServers: ['netbiosNameServers'],
  netbiosNodeType: 123,
  ntpServers: ['ntpServers'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#

This value is used to complete unqualified DNS hostnames.

notes

If you're using AmazonProvidedDNS in us-east-1 , specify ec2.internal . If you're using AmazonProvidedDNS in another Region, specify region . compute.internal (for example, ap-northeast-1.compute.internal ). Otherwise, specify a domain name (for example, MyCompany.com ).

domainNameServersstring[]domain_name_serverstyping.List[str]domainNameServersList<String>DomainNameServersstring[]DomainNameServers*[]*string#

The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .

The default is AmazonProvidedDNS . To have your instance receive a custom DNS hostname as specified in DomainName , you must set this property to a custom DNS server.

ipv6AddressPreferredLeaseTimenumberipv6_address_preferred_lease_timeint | floatipv6AddressPreferredLeaseTimeNumberIpv6AddressPreferredLeaseTimedoubleIpv6AddressPreferredLeaseTime*float64#

A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal.

notes

Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.

netbiosNameServersstring[]netbios_name_serverstyping.List[str]netbiosNameServersList<String>NetbiosNameServersstring[]NetbiosNameServers*[]*string#

The IPv4 addresses of up to four NetBIOS name servers.

netbiosNodeTypenumbernetbios_node_typeint | floatnetbiosNodeTypeNumberNetbiosNodeTypedoubleNetbiosNodeType*float64#

The NetBIOS node type (1, 2, 4, or 8).

We recommend that you specify 2 (broadcast and multicast are not currently supported).

ntpServersstring[]ntp_serverstyping.List[str]ntpServersList<String>NtpServersstring[]NtpServers*[]*string#

The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Any tags assigned to the DHCP options set.

Used as props by

• CfnDHCPOptions