software.amazon.awscdk.services.ec2

Class CfnNetworkInterface

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

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.269Z")
 @Stability(value=Stable)
public class CfnNetworkInterface
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::NetworkInterface`.

Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .

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.*;
 CfnNetworkInterface cfnNetworkInterface = CfnNetworkInterface.Builder.create(this, "MyCfnNetworkInterface")
         .subnetId("subnetId")
         // the properties below are optional
         .description("description")
         .groupSet(List.of("groupSet"))
         .interfaceType("interfaceType")
         .ipv6AddressCount(123)
         .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                 .ipv6Address("ipv6Address")
                 .build()))
         .privateIpAddress("privateIpAddress")
         .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                 .primary(false)
                 .privateIpAddress("privateIpAddress")
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .sourceDestCheck(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNetworkInterface.Builder A fluent builder for CfnNetworkInterface.
static interface	CfnNetworkInterface.InstanceIpv6AddressProperty Describes the IPv6 addresses to associate with the network interface.
static interface	CfnNetworkInterface.PrivateIpAddressSpecificationProperty Describes a secondary private IPv4 address for a network interface.

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
	CfnNetworkInterface(software.constructs.Construct scope, String id, CfnNetworkInterfaceProps props) Create a new `AWS::EC2::NetworkInterface`.
protected	CfnNetworkInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInterface(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID of the network interface.
String	getAttrPrimaryPrivateIpAddress() The primary private IP address of the network interface.
List<String>	getAttrSecondaryPrivateIpAddresses() The secondary private IP addresses of the network interface.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the network interface.
List<String>	getGroupSet() The security group IDs associated with this network interface.
String	getInterfaceType() The type of network interface.
Number	getIpv6AddressCount() The number of IPv6 addresses to assign to a network interface.
Object	getIpv6Addresses() One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
String	getPrivateIpAddress() Assigns a single private IP address to the network interface, which is used as the primary private IP address.
Object	getPrivateIpAddresses() Assigns private IP addresses to the network interface.
Number	getSecondaryPrivateIpAddressCount() The number of secondary private IPv4 addresses to assign to a network interface.
Object	getSourceDestCheck() Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
String	getSubnetId() The ID of the subnet to associate with the network interface.
TagManager	getTags() An arbitrary set of tags (key-value pairs) for this network interface.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description for the network interface.
void	setGroupSet(List<String> value) The security group IDs associated with this network interface.
void	setInterfaceType(String value) The type of network interface.
void	setIpv6AddressCount(Number value) The number of IPv6 addresses to assign to a network interface.
void	setIpv6Addresses(IResolvable value) One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
void	setIpv6Addresses(List<Object> value) One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
void	setPrivateIpAddress(String value) Assigns a single private IP address to the network interface, which is used as the primary private IP address.
void	setPrivateIpAddresses(IResolvable value) Assigns private IP addresses to the network interface.
void	setPrivateIpAddresses(List<Object> value) Assigns private IP addresses to the network interface.
void	setSecondaryPrivateIpAddressCount(Number value) The number of secondary private IPv4 addresses to assign to a network interface.
void	setSourceDestCheck(Boolean value) Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
void	setSourceDestCheck(IResolvable value) Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
void	setSubnetId(String value) The ID of the subnet to associate with the network interface.

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

CfnNetworkInterface

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

CfnNetworkInterface

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

CfnNetworkInterface

@Stability(value=Stable)
public CfnNetworkInterface(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnNetworkInterfaceProps props)

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

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.

getAttrId

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

The ID of the network interface.

getAttrPrimaryPrivateIpAddress

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

The primary private IP address of the network interface.

For example, 10.0.0.192 .

getAttrSecondaryPrivateIpAddresses

@Stability(value=Stable)
 @NotNull
public List<String> getAttrSecondaryPrivateIpAddresses()

The secondary private IP addresses of the network interface.

For example, ["10.0.0.161", "10.0.0.162", "10.0.0.163"] .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

An arbitrary set of tags (key-value pairs) for this network interface.

getSubnetId

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

The ID of the subnet to associate with the network interface.

setSubnetId

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

The ID of the subnet to associate with the network interface.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the network interface.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the network interface.

getGroupSet

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

The security group IDs associated with this network interface.

setGroupSet

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

The security group IDs associated with this network interface.

getInterfaceType

@Stability(value=Stable)
 @Nullable
public String getInterfaceType()

The type of network interface.

The default is interface . The supported values are efa and trunk .

setInterfaceType

@Stability(value=Stable)
public void setInterfaceType(@Nullable
                                                      String value)

The type of network interface.

The default is interface . The supported values are efa and trunk .

getIpv6AddressCount

@Stability(value=Stable)
 @Nullable
public Number getIpv6AddressCount()

The number of IPv6 addresses to assign to a network interface.

Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.

setIpv6AddressCount

@Stability(value=Stable)
public void setIpv6AddressCount(@Nullable
                                                         Number value)

The number of IPv6 addresses to assign to a network interface.

Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.

getIpv6Addresses

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

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

setIpv6Addresses

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

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

setIpv6Addresses

@Stability(value=Stable)
public void setIpv6Addresses(@Nullable
                                                      List<Object> value)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

getPrivateIpAddress

@Stability(value=Stable)
 @Nullable
public String getPrivateIpAddress()

Assigns a single private IP address to the network interface, which is used as the primary private IP address.

If you want to specify multiple private IP address, use the PrivateIpAddresses property.

setPrivateIpAddress

@Stability(value=Stable)
public void setPrivateIpAddress(@Nullable
                                                         String value)

Assigns a single private IP address to the network interface, which is used as the primary private IP address.

If you want to specify multiple private IP address, use the PrivateIpAddresses property.

getPrivateIpAddresses

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

Assigns private IP addresses to the network interface.

You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.

setPrivateIpAddresses

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

Assigns private IP addresses to the network interface.

You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.

setPrivateIpAddresses

@Stability(value=Stable)
public void setPrivateIpAddresses(@Nullable
                                                           List<Object> value)

Assigns private IP addresses to the network interface.

You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.

getSecondaryPrivateIpAddressCount

@Stability(value=Stable)
 @Nullable
public Number getSecondaryPrivateIpAddressCount()

The number of secondary private IPv4 addresses to assign to a network interface.

When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .

setSecondaryPrivateIpAddressCount

@Stability(value=Stable)
public void setSecondaryPrivateIpAddressCount(@Nullable
                                                                       Number value)

The number of secondary private IPv4 addresses to assign to a network interface.

When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .

getSourceDestCheck

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

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

setSourceDestCheck

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

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

setSourceDestCheck

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

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.