software.amazon.awscdk.services.ec2

Class CfnNetworkInterfaceAttachment

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.656Z")
public class CfnNetworkInterfaceAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::NetworkInterfaceAttachment`.

Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption.

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.*;
 CfnNetworkInterfaceAttachment cfnNetworkInterfaceAttachment = CfnNetworkInterfaceAttachment.Builder.create(this, "MyCfnNetworkInterfaceAttachment")
         .deviceIndex("deviceIndex")
         .instanceId("instanceId")
         .networkInterfaceId("networkInterfaceId")
         // the properties below are optional
         .deleteOnTermination(false)
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnNetworkInterfaceAttachment(Construct scope, java.lang.String id, CfnNetworkInterfaceAttachmentProps props) Create a new `AWS::EC2::NetworkInterfaceAttachment`.
protected	CfnNetworkInterfaceAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInterfaceAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDeleteOnTermination() Whether to delete the network interface when the instance terminates.
java.lang.String	getDeviceIndex() The network interface's position in the attachment order.
java.lang.String	getInstanceId() The ID of the instance to which you will attach the ENI.
java.lang.String	getNetworkInterfaceId() The ID of the ENI that you want to attach.
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	setDeleteOnTermination(java.lang.Boolean value) Whether to delete the network interface when the instance terminates.
void	setDeleteOnTermination(IResolvable value) Whether to delete the network interface when the instance terminates.
void	setDeviceIndex(java.lang.String value) The network interface's position in the attachment order.
void	setInstanceId(java.lang.String value) The ID of the instance to which you will attach the ENI.
void	setNetworkInterfaceId(java.lang.String value) The ID of the ENI that you want to attach.

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

CfnNetworkInterfaceAttachment

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

CfnNetworkInterfaceAttachment

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

CfnNetworkInterfaceAttachment

public CfnNetworkInterfaceAttachment(Construct scope,
                                     java.lang.String id,
                                     CfnNetworkInterfaceAttachmentProps props)

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDeviceIndex

public java.lang.String getDeviceIndex()

The network interface's position in the attachment order.

For example, the first attached network interface has a DeviceIndex of 0.

setDeviceIndex

public void setDeviceIndex(java.lang.String value)

The network interface's position in the attachment order.

For example, the first attached network interface has a DeviceIndex of 0.

getInstanceId

public java.lang.String getInstanceId()

The ID of the instance to which you will attach the ENI.

setInstanceId

public void setInstanceId(java.lang.String value)

The ID of the instance to which you will attach the ENI.

getNetworkInterfaceId

public java.lang.String getNetworkInterfaceId()

The ID of the ENI that you want to attach.

setNetworkInterfaceId

public void setNetworkInterfaceId(java.lang.String value)

The ID of the ENI that you want to attach.

getDeleteOnTermination

public java.lang.Object getDeleteOnTermination()

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .

setDeleteOnTermination

public void setDeleteOnTermination(java.lang.Boolean value)

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .

setDeleteOnTermination

public void setDeleteOnTermination(IResolvable value)

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .