Interface CfnInstance.NetworkInterfaceProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnInstance.NetworkInterfaceProperty.Jsii$Proxy
- Enclosing class:
CfnInstance
You can create a network interface when launching an instance. For an example, see the AWS::EC2::Instance examples .
Alternatively, you can attach an existing network interface when launching an instance. For an example, see the AWS::EC2:NetworkInterface examples .
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.*; NetworkInterfaceProperty networkInterfaceProperty = NetworkInterfaceProperty.builder() .deviceIndex("deviceIndex") // the properties below are optional .associateCarrierIpAddress(false) .associatePublicIpAddress(false) .deleteOnTermination(false) .description("description") .groupSet(List.of("groupSet")) .ipv6AddressCount(123) .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder() .ipv6Address("ipv6Address") .build())) .networkInterfaceId("networkInterfaceId") .privateIpAddress("privateIpAddress") .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder() .primary(false) .privateIpAddress("privateIpAddress") .build())) .secondaryPrivateIpAddressCount(123) .subnetId("subnetId") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnInstance.NetworkInterfaceProperty
static final class
An implementation forCfnInstance.NetworkInterfaceProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Indicates whether to assign a carrier IP address to the network interface.default Object
Indicates whether to assign a public IPv4 address to an instance.default Object
Indicates whether the network interface is deleted when the instance is terminated.default String
The description of the network interface.The position of the network interface in the attachment order.The IDs of the security groups for the network interface.default Number
A number of IPv6 addresses to assign to the network interface.default Object
The IPv6 addresses to assign to the network interface.default String
The ID of the network interface, when attaching an existing network interface.default String
The private IPv4 address of the network interface.default Object
One or more private IPv4 addresses to assign to the network interface.default Number
The number of secondary private IPv4 addresses.default String
The ID of the subnet associated with the network interface.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeviceIndex
The position of the network interface in the attachment order.A primary network interface has a device index of 0.
If you create a network interface when launching an instance, you must specify the device index.
- See Also:
-
getAssociateCarrierIpAddress
Indicates whether to assign a carrier IP address to the network interface.You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the AWS Wavelength Developer Guide .
- See Also:
-
getAssociatePublicIpAddress
Indicates whether to assign a public IPv4 address to an instance.Applies only if creating a network interface when launching an instance. The network interface must be the primary network interface. If launching into a default subnet, the default value is
true
.AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the VPC pricing page .
- See Also:
-
getDeleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.Applies only if creating a network interface when launching an instance.
- See Also:
-
getDescription
The description of the network interface.Applies only if creating a network interface when launching an instance.
- See Also:
-
getGroupSet
The IDs of the security groups for the network interface.Applies only if creating a network interface when launching an instance.
- See Also:
-
getIpv6AddressCount
A number of IPv6 addresses to assign to the network interface.Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
- See Also:
-
getIpv6Addresses
The IPv6 addresses to assign to the network interface.You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
- See Also:
-
getNetworkInterfaceId
The ID of the network interface, when attaching an existing network interface.- See Also:
-
getPrivateIpAddress
The private IPv4 address of the network interface.Applies only if creating a network interface when launching an instance.
- See Also:
-
getPrivateIpAddresses
One or more private IPv4 addresses to assign to the network interface.Only one private IPv4 address can be designated as primary.
- See Also:
-
getSecondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses.You can't specify this option and specify more than one private IP address using the private IP addresses option.
- See Also:
-
getSubnetId
The ID of the subnet associated with the network interface.Applies only if creating a network interface when launching an instance.
- See Also:
-
builder
-