Package software.amazon.awscdk.services.ec2

Class CfnVPCDHCPOptionsAssociation

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

All Implemented Interfaces:

IInspectable, IVPCDHCPOptionsAssociationRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:12.030Z")
@Stability(Stable)
public class CfnVPCDHCPOptionsAssociation
extends CfnResource
implements IInspectable, IVPCDHCPOptionsAssociationRef

Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

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.*;
 CfnVPCDHCPOptionsAssociation cfnVPCDHCPOptionsAssociation = CfnVPCDHCPOptionsAssociation.Builder.create(this, "MyCfnVPCDHCPOptionsAssociation")
         .dhcpOptionsId("dhcpOptionsId")
         .vpcId("vpcId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ec2.IVPCDHCPOptionsAssociationRef

IVPCDHCPOptionsAssociationRef.Jsii$Default, IVPCDHCPOptionsAssociationRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVPCDHCPOptionsAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCDHCPOptionsAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVPCDHCPOptionsAssociation(software.constructs.Construct scope, String id, CfnVPCDHCPOptionsAssociationProps props)	Create a new AWS::EC2::VPCDHCPOptionsAssociation.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getDhcpOptionsId()	The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
VPCDHCPOptionsAssociationReference	getVpcdhcpOptionsAssociationRef()	A reference to a VPCDHCPOptionsAssociation resource.
String	getVpcId()	The ID of the VPC.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnVPCDHCPOptionsAssociation(Object x)	Checks whether the given object is a CfnVPCDHCPOptionsAssociation.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDhcpOptionsId(String value)	The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
void	setVpcId(String value)	The ID of the VPC.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnVPCDHCPOptionsAssociation

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

CfnVPCDHCPOptionsAssociation

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

CfnVPCDHCPOptionsAssociation

@Stability(Stable)
public CfnVPCDHCPOptionsAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVPCDHCPOptionsAssociationProps props)

Create a new AWS::EC2::VPCDHCPOptionsAssociation.

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. This parameter is required.

Method Details

isCfnVPCDHCPOptionsAssociation

@Stability(Stable)
@NotNull
public static Boolean isCfnVPCDHCPOptionsAssociation(@NotNull
 Object x)

Checks whether the given object is a CfnVPCDHCPOptionsAssociation.

Parameters:

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getVpcdhcpOptionsAssociationRef

@Stability(Stable)
@NotNull
public VPCDHCPOptionsAssociationReference getVpcdhcpOptionsAssociationRef()

A reference to a VPCDHCPOptionsAssociation resource.

Specified by:

getVpcdhcpOptionsAssociationRef in interface IVPCDHCPOptionsAssociationRef

getDhcpOptionsId

@Stability(Stable)
@NotNull
public String getDhcpOptionsId()

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

setDhcpOptionsId

@Stability(Stable)
public void setDhcpOptionsId(@NotNull
 String value)

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

getVpcId

@Stability(Stable)
@NotNull
public String getVpcId()

The ID of the VPC.

setVpcId

@Stability(Stable)
public void setVpcId(@NotNull
 String value)

The ID of the VPC.