software.amazon.awscdk.services.ec2

Class CfnNetworkInterfaceAttachment

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

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.272Z")
 @Stability(value=Stable)
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 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
	CfnNetworkInterfaceAttachment(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
Object	getDeleteOnTermination() Whether to delete the network interface when the instance terminates.
String	getDeviceIndex() The network interface's position in the attachment order.
String	getInstanceId() The ID of the instance to which you will attach the ENI.
String	getNetworkInterfaceId() The ID of the ENI that you want to attach.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeleteOnTermination(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(String value) The network interface's position in the attachment order.
void	setInstanceId(String value) The ID of the instance to which you will attach the ENI.
void	setNetworkInterfaceId(String value) The ID of the ENI that you want to attach.

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

CfnNetworkInterfaceAttachment

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

CfnNetworkInterfaceAttachment

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

CfnNetworkInterfaceAttachment

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDeviceIndex

@Stability(value=Stable)
 @NotNull
public String getDeviceIndex()

The network interface's position in the attachment order.

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

setDeviceIndex

@Stability(value=Stable)
public void setDeviceIndex(@NotNull
                                                    String value)

The network interface's position in the attachment order.

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

getInstanceId

@Stability(value=Stable)
 @NotNull
public String getInstanceId()

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

setInstanceId

@Stability(value=Stable)
public void setInstanceId(@NotNull
                                                   String value)

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

getNetworkInterfaceId

@Stability(value=Stable)
 @NotNull
public String getNetworkInterfaceId()

The ID of the ENI that you want to attach.

setNetworkInterfaceId

@Stability(value=Stable)
public void setNetworkInterfaceId(@NotNull
                                                           String value)

The ID of the ENI that you want to attach.

getDeleteOnTermination

@Stability(value=Stable)
 @Nullable
public Object getDeleteOnTermination()

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .

setDeleteOnTermination

@Stability(value=Stable)
public void setDeleteOnTermination(@Nullable
                                                            Boolean value)

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .

setDeleteOnTermination

@Stability(value=Stable)
public void setDeleteOnTermination(@Nullable
                                                            IResolvable value)

Whether to delete the network interface when the instance terminates.

By default, this value is set to true .