Package software.amazon.awscdk.services.ec2

Class CfnDHCPOptions

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnDHCPOptions
All Implemented Interfaces:
IInspectable, ITaggable, IDHCPOptionsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:09.128Z") @Stability(Stable) public class CfnDHCPOptions extends CfnResource implements IInspectable, IDHCPOptionsRef, ITaggable
Specifies a set of DHCP options for your VPC.

You must specify at least one of the following properties: DomainNameServers , NetbiosNameServers , NtpServers . If you specify NetbiosNameServers , you must specify NetbiosNodeType .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnDHCPOptions cfnDHCPOptions = CfnDHCPOptions.Builder.create(this, "MyCfnDHCPOptions")
         .domainName("domainName")
         .domainNameServers(List.of("domainNameServers"))
         .ipv6AddressPreferredLeaseTime(123)
         .netbiosNameServers(List.of("netbiosNameServers"))
         .netbiosNodeType(123)
         .ntpServers(List.of("ntpServers"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDHCPOptions

      protected CfnDHCPOptions(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDHCPOptions

      protected CfnDHCPOptions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDHCPOptions

      @Stability(Stable) public CfnDHCPOptions(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDHCPOptionsProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDHCPOptions

      @Stability(Stable) public CfnDHCPOptions(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromDhcpOptionsId

      @Stability(Stable) @NotNull public static IDHCPOptionsRef fromDhcpOptionsId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String dhcpOptionsId)
      Creates a new IDHCPOptionsRef from a dhcpOptionsId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      dhcpOptionsId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDhcpOptionsId

      @Stability(Stable) @NotNull public String getAttrDhcpOptionsId()
      The ID of the DHCP options set.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDhcpOptionsRef

      @Stability(Stable) @NotNull public DHCPOptionsReference getDhcpOptionsRef()
      A reference to a DHCPOptions resource.
      Specified by:
      getDhcpOptionsRef in interface IDHCPOptionsRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDomainName

      @Stability(Stable) @Nullable public String getDomainName()
      This value is used to complete unqualified DNS hostnames.

    • setDomainName

      @Stability(Stable) public void setDomainName(@Nullable String value)
      This value is used to complete unqualified DNS hostnames.

    • getDomainNameServers

      @Stability(Stable) @Nullable public List<String> getDomainNameServers()
      The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS .

    • setDomainNameServers

      @Stability(Stable) public void setDomainNameServers(@Nullable List<String> value)
      The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS .

    • getIpv6AddressPreferredLeaseTime

      @Stability(Stable) @Nullable public Number getIpv6AddressPreferredLeaseTime()
      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.

    • setIpv6AddressPreferredLeaseTime

      @Stability(Stable) public void setIpv6AddressPreferredLeaseTime(@Nullable Number value)
      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.

    • getNetbiosNameServers

      @Stability(Stable) @Nullable public List<String> getNetbiosNameServers()
      The IPv4 addresses of up to four NetBIOS name servers.

    • setNetbiosNameServers

      @Stability(Stable) public void setNetbiosNameServers(@Nullable List<String> value)
      The IPv4 addresses of up to four NetBIOS name servers.

    • getNetbiosNodeType

      @Stability(Stable) @Nullable public Number getNetbiosNodeType()
      The NetBIOS node type (1, 2, 4, or 8).

    • setNetbiosNodeType

      @Stability(Stable) public void setNetbiosNodeType(@Nullable Number value)
      The NetBIOS node type (1, 2, 4, or 8).

    • getNtpServers

      @Stability(Stable) @Nullable public List<String> getNtpServers()
      The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

    • setNtpServers

      @Stability(Stable) public void setNtpServers(@Nullable List<String> value)
      The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Any tags assigned to the DHCP options set.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Any tags assigned to the DHCP options set.