software.amazon.awscdk.services.ec2

Class CfnDHCPOptions

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnDHCPOptions

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:02.830Z")
public class CfnDHCPOptions
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::DHCPOptions`.

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"))
         .netbiosNameServers(List.of("netbiosNameServers"))
         .netbiosNodeType(123)
         .ntpServers(List.of("ntpServers"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDHCPOptions.Builder A fluent builder for CfnDHCPOptions.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDHCPOptions(Construct scope, java.lang.String id) Create a new `AWS::EC2::DHCPOptions`.
	CfnDHCPOptions(Construct scope, java.lang.String id, CfnDHCPOptionsProps props) Create a new `AWS::EC2::DHCPOptions`.
protected	CfnDHCPOptions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDHCPOptions(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrDhcpOptionsId() The ID of the DHCP options set.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDomainName() This value is used to complete unqualified DNS hostnames.
java.util.List<java.lang.String>	getDomainNameServers() The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
java.util.List<java.lang.String>	getNetbiosNameServers() The IPv4 addresses of up to four NetBIOS name servers.
java.lang.Number	getNetbiosNodeType() The NetBIOS node type (1, 2, 4, or 8).
java.util.List<java.lang.String>	getNtpServers() The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
TagManager	getTags() Any tags assigned to the DHCP options set.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDomainName(java.lang.String value) This value is used to complete unqualified DNS hostnames.
void	setDomainNameServers(java.util.List<java.lang.String> value) The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
void	setNetbiosNameServers(java.util.List<java.lang.String> value) The IPv4 addresses of up to four NetBIOS name servers.
void	setNetbiosNodeType(java.lang.Number value) The NetBIOS node type (1, 2, 4, or 8).
void	setNtpServers(java.util.List<java.lang.String> value) The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDHCPOptions

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

CfnDHCPOptions

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

CfnDHCPOptions

public CfnDHCPOptions(Construct scope,
                      java.lang.String id,
                      CfnDHCPOptionsProps props)

Create a new `AWS::EC2::DHCPOptions`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnDHCPOptions

public CfnDHCPOptions(Construct scope,
                      java.lang.String id)

Create a new `AWS::EC2::DHCPOptions`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDhcpOptionsId

public java.lang.String getAttrDhcpOptionsId()

The ID of the DHCP options set.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Any tags assigned to the DHCP options set.

getDomainName

public java.lang.String getDomainName()

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

setDomainName

public void setDomainName(java.lang.String value)

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

getDomainNameServers

public java.util.List<java.lang.String> getDomainNameServers()

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.

setDomainNameServers

public void setDomainNameServers(java.util.List<java.lang.String> value)

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.

getNetbiosNameServers

public java.util.List<java.lang.String> getNetbiosNameServers()

The IPv4 addresses of up to four NetBIOS name servers.

setNetbiosNameServers

public void setNetbiosNameServers(java.util.List<java.lang.String> value)

The IPv4 addresses of up to four NetBIOS name servers.

getNetbiosNodeType

public java.lang.Number getNetbiosNodeType()

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

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

setNetbiosNodeType

public void setNetbiosNodeType(java.lang.Number value)

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

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

getNtpServers

public java.util.List<java.lang.String> getNtpServers()

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

setNtpServers

public void setNtpServers(java.util.List<java.lang.String> value)

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