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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.137Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDHCPOptions(software.constructs.Construct scope, String id) Create a new `AWS::EC2::DHCPOptions`.
	CfnDHCPOptions(software.constructs.Construct scope, 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
String	getAttrDhcpOptionsId() The ID of the DHCP options set.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() This value is used to complete unqualified DNS hostnames.
List<String>	getDomainNameServers() The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
List<String>	getNetbiosNameServers() The IPv4 addresses of up to four NetBIOS name servers.
Number	getNetbiosNodeType() The NetBIOS node type (1, 2, 4, or 8).
List<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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainName(String value) This value is used to complete unqualified DNS hostnames.
void	setDomainNameServers(List<String> value) The IPv4 addresses of up to four domain name servers, or `AmazonProvidedDNS` .
void	setNetbiosNameServers(List<String> value) The IPv4 addresses of up to four NetBIOS name servers.
void	setNetbiosNodeType(Number value) The NetBIOS node type (1, 2, 4, or 8).
void	setNtpServers(List<String> value) The IPv4 addresses of up to four Network Time Protocol (NTP) servers.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnDHCPOptions(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               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

@Stability(value=Stable)
public CfnDHCPOptions(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrDhcpOptionsId()

The ID of the DHCP options set.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Any tags assigned to the DHCP options set.

getDomainName

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDomainName(@Nullable
                                                   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

@Stability(value=Stable)
 @Nullable
public List<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

@Stability(value=Stable)
public void setDomainNameServers(@Nullable
                                                          List<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

@Stability(value=Stable)
 @Nullable
public List<String> getNetbiosNameServers()

The IPv4 addresses of up to four NetBIOS name servers.

setNetbiosNameServers

@Stability(value=Stable)
public void setNetbiosNameServers(@Nullable
                                                           List<String> value)

The IPv4 addresses of up to four NetBIOS name servers.

getNetbiosNodeType

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setNetbiosNodeType(@Nullable
                                                        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

@Stability(value=Stable)
 @Nullable
public List<String> getNtpServers()

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

setNtpServers

@Stability(value=Stable)
public void setNtpServers(@Nullable
                                                   List<String> value)

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