CfnDHCPOptionsProps

class aws_cdk.aws_ec2.CfnDHCPOptionsProps(*, domain_name=None, domain_name_servers=None, ipv6_address_preferred_lease_time=None, netbios_name_servers=None, netbios_node_type=None, ntp_servers=None, tags=None)

Bases: object

Properties for defining a CfnDHCPOptions.

Parameters:
  • domain_name (Optional[str]) – This value is used to complete unqualified DNS hostnames. 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 ).

  • domain_name_servers (Optional[Sequence[str]]) – 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.

  • ipv6_address_preferred_lease_time (Union[int, float, None]) – 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. 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.

  • netbios_name_servers (Optional[Sequence[str]]) – The IPv4 addresses of up to four NetBIOS name servers.

  • netbios_node_type (Union[int, float, None]) – The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported).

  • ntp_servers (Optional[Sequence[str]]) – The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Any tags assigned to the DHCP options set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_dHCPOptions_props = ec2.CfnDHCPOptionsProps(
    domain_name="domainName",
    domain_name_servers=["domainNameServers"],
    ipv6_address_preferred_lease_time=123,
    netbios_name_servers=["netbiosNameServers"],
    netbios_node_type=123,
    ntp_servers=["ntpServers"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

domain_name

This value is used to complete unqualified DNS hostnames.

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 ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainname

domain_name_servers

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-domainnameservers

ipv6_address_preferred_lease_time

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.

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ipv6addresspreferredleasetime

netbios_name_servers

The IPv4 addresses of up to four NetBIOS name servers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnameservers

netbios_node_type

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-netbiosnodetype

ntp_servers

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-ntpservers

tags

Any tags assigned to the DHCP options set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html#cfn-ec2-dhcpoptions-tags