CfnNetworkInterface

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.273Z")
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 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.

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
	`CfnNetworkInterface(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrId()` The ID of the network interface.
`java.lang.String`	`getAttrPrimaryPrivateIpAddress()` The primary private IP address of the network interface.
`java.util.List<java.lang.String>`	`getAttrSecondaryPrivateIpAddresses()` The secondary private IP addresses of the network interface.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` A description for the network interface.
`java.util.List<java.lang.String>`	`getGroupSet()` The security group IDs associated with this network interface.
`java.lang.String`	`getInterfaceType()` The type of network interface.
`java.lang.Number`	`getIpv6AddressCount()` The number of IPv6 addresses to assign to a network interface.
`java.lang.Object`	`getIpv6Addresses()` One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
`java.lang.String`	`getPrivateIpAddress()` Assigns a single private IP address to the network interface, which is used as the primary private IP address.
`java.lang.Object`	`getPrivateIpAddresses()` Assigns private IP addresses to the network interface.
`java.lang.Number`	`getSecondaryPrivateIpAddressCount()` The number of secondary private IPv4 addresses to assign to a network interface.
`java.lang.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.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDescription(java.lang.String value)` A description for the network interface.
`void`	`setGroupSet(java.util.List<java.lang.String> value)` The security group IDs associated with this network interface.
`void`	`setInterfaceType(java.lang.String value)` The type of network interface.
`void`	`setIpv6AddressCount(java.lang.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(java.util.List<java.lang.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(java.lang.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(java.util.List<java.lang.Object> value)` Assigns private IP addresses to the network interface.
`void`	`setSecondaryPrivateIpAddressCount(java.lang.Number value)` The number of secondary private IPv4 addresses to assign to a network interface.
`void`	`setSourceDestCheck(java.lang.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(java.lang.String value)` The ID of the subnet to associate with the network interface.

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
  - CfnNetworkInterface
```
protected CfnNetworkInterface(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnNetworkInterface
```
protected CfnNetworkInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnNetworkInterface
```
public CfnNetworkInterface(Construct scope,
                           java.lang.String id,
                           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
```
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.
  - getAttrId
```
public java.lang.String getAttrId()
```
    The ID of the network interface.
  - getAttrPrimaryPrivateIpAddress
```
public java.lang.String getAttrPrimaryPrivateIpAddress()
```
    The primary private IP address of the network interface.
    For example, 10.0.0.192 .
  - getAttrSecondaryPrivateIpAddresses
```
public java.util.List<java.lang.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
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An arbitrary set of tags (key-value pairs) for this network interface.
  - getSubnetId
```
public java.lang.String getSubnetId()
```
    The ID of the subnet to associate with the network interface.
  - setSubnetId
```
public void setSubnetId(java.lang.String value)
```
    The ID of the subnet to associate with the network interface.
  - getDescription
```
public java.lang.String getDescription()
```
    A description for the network interface.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description for the network interface.
  - getGroupSet
```
public java.util.List<java.lang.String> getGroupSet()
```
    The security group IDs associated with this network interface.
  - setGroupSet
```
public void setGroupSet(java.util.List<java.lang.String> value)
```
    The security group IDs associated with this network interface.
  - getInterfaceType
```
public java.lang.String getInterfaceType()
```
    The type of network interface.
    The default is interface . The supported values are efa and trunk .
  - setInterfaceType
```
public void setInterfaceType(java.lang.String value)
```
    The type of network interface.
    The default is interface . The supported values are efa and trunk .
  - getIpv6AddressCount
```
public java.lang.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
```
public void setIpv6AddressCount(java.lang.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
```
public java.lang.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
```
public 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.
    If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
  - setIpv6Addresses
```
public void setIpv6Addresses(java.util.List<java.lang.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
```
public java.lang.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
```
public void setPrivateIpAddress(java.lang.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
```
public java.lang.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
```
public void setPrivateIpAddresses(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
```
public void setPrivateIpAddresses(java.util.List<java.lang.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
```
public java.lang.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
```
public void setSecondaryPrivateIpAddressCount(java.lang.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
```
public java.lang.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
```
public void setSourceDestCheck(java.lang.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
```
public 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.
    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.

Class CfnNetworkInterface

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnNetworkInterface

CfnNetworkInterface

CfnNetworkInterface

Method Detail

inspect

renderProperties

getAttrId

getAttrPrimaryPrivateIpAddress

getAttrSecondaryPrivateIpAddresses

getCfnProperties

getTags

getSubnetId

setSubnetId

getDescription

setDescription

getGroupSet

setGroupSet

getInterfaceType

setInterfaceType

getIpv6AddressCount

setIpv6AddressCount

getIpv6Addresses

setIpv6Addresses

setIpv6Addresses

getPrivateIpAddress

setPrivateIpAddress

getPrivateIpAddresses

setPrivateIpAddresses

setPrivateIpAddresses

getSecondaryPrivateIpAddressCount

setSecondaryPrivateIpAddressCount

getSourceDestCheck

setSourceDestCheck

setSourceDestCheck