Package software.amazon.awscdk.services.ec2

Interface CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnSpotFleet

@Stability(Stable)
public static interface CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Describes a network interface.

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.*;
 InstanceNetworkInterfaceSpecificationProperty instanceNetworkInterfaceSpecificationProperty = InstanceNetworkInterfaceSpecificationProperty.builder()
         .associatePublicIpAddress(false)
         .deleteOnTermination(false)
         .description("description")
         .deviceIndex(123)
         .groups(List.of("groups"))
         .ipv6AddressCount(123)
         .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                 .ipv6Address("ipv6Address")
                 .build()))
         .networkInterfaceId("networkInterfaceId")
         .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                 .privateIpAddress("privateIpAddress")
                 // the properties below are optional
                 .primary(false)
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .subnetId("subnetId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Builder	A builder for CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty
static final class	CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Jsii$Proxy	An implementation for CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Builder	builder()
default Object	getAssociatePublicIpAddress()	Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.
default Object	getDeleteOnTermination()	Indicates whether the network interface is deleted when the instance is terminated.
default String	getDescription()	The description of the network interface.
default Number	getDeviceIndex()	The position of the network interface in the attachment order.
default List<String>	getGroups()	The IDs of the security groups for the network interface.
default Number	getIpv6AddressCount()	A number of IPv6 addresses to assign to the network interface.
default Object	getIpv6Addresses()	The IPv6 addresses to assign to the network interface.
default String	getNetworkInterfaceId()	The ID of the network interface.
default Object	getPrivateIpAddresses()	The private IPv4 addresses to assign to the network interface.
default Number	getSecondaryPrivateIpAddressCount()	The number of secondary private IPv4 addresses.
default String	getSubnetId()	The ID of the subnet associated with the network interface.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssociatePublicIpAddress

@Stability(Stable)
@Nullable
default Object getAssociatePublicIpAddress()

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.

The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. 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 Amazon VPC pricing page .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress

getDeleteOnTermination

@Stability(Stable)
@Nullable
default Object getDeleteOnTermination()

Indicates whether the network interface is deleted when the instance is terminated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination

getDescription

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

The description of the network interface.

Applies only if creating a network interface when launching an instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description

getDeviceIndex

@Stability(Stable)
@Nullable
default Number getDeviceIndex()

The position of the network interface in the attachment order.

A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex

getGroups

@Stability(Stable)
@Nullable
default List<String> getGroups()

The IDs of the security groups for the network interface.

Applies only if creating a network interface when launching an instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups

getIpv6AddressCount

@Stability(Stable)
@Nullable
default Number 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount

getIpv6Addresses

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses

getNetworkInterfaceId

@Stability(Stable)
@Nullable
default String getNetworkInterfaceId()

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid

getPrivateIpAddresses

@Stability(Stable)
@Nullable
default Object getPrivateIpAddresses()

The private IPv4 addresses to assign to the network interface.

Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses

getSecondaryPrivateIpAddressCount

@Stability(Stable)
@Nullable
default Number 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. You cannot specify this option if you're launching more than one instance in a RunInstances request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

The ID of the subnet associated with the network interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancenetworkinterfacespecification.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid

builder

@Stability(Stable)
static CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Builder builder()

Returns:

a CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty.Builder of CfnSpotFleet.InstanceNetworkInterfaceSpecificationProperty