software.amazon.awscdk.services.ec2

Interface CfnNetworkInterfaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNetworkInterfaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.273Z")
 @Stability(value=Stable)
public interface CfnNetworkInterfaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnNetworkInterface`.

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.*;
 CfnNetworkInterfaceProps cfnNetworkInterfaceProps = CfnNetworkInterfaceProps.builder()
         .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	Interface and Description
static class	CfnNetworkInterfaceProps.Builder A builder for CfnNetworkInterfaceProps
static class	CfnNetworkInterfaceProps.Jsii$Proxy An implementation for CfnNetworkInterfaceProps

Method Summary

Modifier and Type	Method and Description
static CfnNetworkInterfaceProps.Builder	builder()
default String	getDescription() A description for the network interface.
default List<String>	getGroupSet() The security group IDs associated with this network interface.
default String	getInterfaceType() The type of network interface.
default Number	getIpv6AddressCount() The number of IPv6 addresses to assign to a network interface.
default Object	getIpv6Addresses() One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
default String	getPrivateIpAddress() Assigns a single private IP address to the network interface, which is used as the primary private IP address.
default Object	getPrivateIpAddresses() Assigns private IP addresses to the network interface.
default Number	getSecondaryPrivateIpAddressCount() The number of secondary private IPv4 addresses to assign to a network interface.
default 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.
default List<CfnTag>	getTags() An arbitrary set of tags (key-value pairs) for this network interface.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSubnetId

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

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

getDescription

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

A description for the network interface.

getGroupSet

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

The security group IDs associated with this network interface.

getInterfaceType

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

The type of network interface.

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

getIpv6AddressCount

@Stability(value=Stable)
 @Nullable
default 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.

getIpv6Addresses

@Stability(value=Stable)
 @Nullable
default 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.

getPrivateIpAddress

@Stability(value=Stable)
 @Nullable
default 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.

getPrivateIpAddresses

@Stability(value=Stable)
 @Nullable
default 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.

getSecondaryPrivateIpAddressCount

@Stability(value=Stable)
 @Nullable
default 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 .

getSourceDestCheck

@Stability(value=Stable)
 @Nullable
default 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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

builder

@Stability(value=Stable)
static CfnNetworkInterfaceProps.Builder builder()

Returns:

a CfnNetworkInterfaceProps.Builder of CfnNetworkInterfaceProps