Class CfnInstance.NetworkInterfaceProperty

Specifies a network interface that is to be attached to an instance.

Inheritance

object

CfnInstance.NetworkInterfaceProperty

Implements

CfnInstance.INetworkInterfaceProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInstance.NetworkInterfaceProperty : CfnInstance.INetworkInterfaceProperty

Syntax (vb)

Public Class CfnInstance.NetworkInterfaceProperty Implements CfnInstance.INetworkInterfaceProperty

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var networkInterfaceProperty = new NetworkInterfaceProperty {
                 DeviceIndex = "deviceIndex",

                 // the properties below are optional
                 AssociateCarrierIpAddress = false,
                 AssociatePublicIpAddress = false,
                 DeleteOnTermination = false,
                 Description = "description",
                 EnaSrdSpecification = new EnaSrdSpecificationProperty {
                     EnaSrdEnabled = false,
                     EnaSrdUdpSpecification = new EnaSrdUdpSpecificationProperty {
                         EnaSrdUdpEnabled = false
                     }
                 },
                 GroupSet = new [] { "groupSet" },
                 Ipv6AddressCount = 123,
                 Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
                     Ipv6Address = "ipv6Address"
                 } },
                 NetworkInterfaceId = "networkInterfaceId",
                 PrivateIpAddress = "privateIpAddress",
                 PrivateIpAddresses = new [] { new PrivateIpAddressSpecificationProperty {
                     Primary = false,
                     PrivateIpAddress = "privateIpAddress"
                 } },
                 SecondaryPrivateIpAddressCount = 123,
                 SubnetId = "subnetId"
             };

Synopsis

Constructors

NetworkInterfaceProperty()

Specifies a network interface that is to be attached to an instance.

Properties

AssociateCarrierIpAddress	Indicates whether to assign a carrier IP address to the network interface.
AssociatePublicIpAddress	Indicates whether to assign a public IPv4 address to an instance.
DeleteOnTermination	Indicates whether the network interface is deleted when the instance is terminated.
Description	The description of the network interface.
DeviceIndex	The position of the network interface in the attachment order.
EnaSrdSpecification	Configures ENA Express for UDP network traffic.
GroupSet	The IDs of the security groups for the network interface.
Ipv6AddressCount	A number of IPv6 addresses to assign to the network interface.
Ipv6Addresses	The IPv6 addresses to assign to the network interface.
NetworkInterfaceId	The ID of the network interface, when attaching an existing network interface.
PrivateIpAddress	The private IPv4 address of the network interface.
PrivateIpAddresses	One or more private IPv4 addresses to assign to the network interface.
SecondaryPrivateIpAddressCount	The number of secondary private IPv4 addresses.
SubnetId	The ID of the subnet associated with the network interface.

Constructors

NetworkInterfaceProperty()

Specifies a network interface that is to be attached to an instance.

public NetworkInterfaceProperty()

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var networkInterfaceProperty = new NetworkInterfaceProperty {
                 DeviceIndex = "deviceIndex",

                 // the properties below are optional
                 AssociateCarrierIpAddress = false,
                 AssociatePublicIpAddress = false,
                 DeleteOnTermination = false,
                 Description = "description",
                 EnaSrdSpecification = new EnaSrdSpecificationProperty {
                     EnaSrdEnabled = false,
                     EnaSrdUdpSpecification = new EnaSrdUdpSpecificationProperty {
                         EnaSrdUdpEnabled = false
                     }
                 },
                 GroupSet = new [] { "groupSet" },
                 Ipv6AddressCount = 123,
                 Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
                     Ipv6Address = "ipv6Address"
                 } },
                 NetworkInterfaceId = "networkInterfaceId",
                 PrivateIpAddress = "privateIpAddress",
                 PrivateIpAddresses = new [] { new PrivateIpAddressSpecificationProperty {
                     Primary = false,
                     PrivateIpAddress = "privateIpAddress"
                 } },
                 SecondaryPrivateIpAddressCount = 123,
                 SubnetId = "subnetId"
             };

Properties

AssociateCarrierIpAddress

Indicates whether to assign a carrier IP address to the network interface.

public object? AssociateCarrierIpAddress { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatecarrieripaddress

AssociatePublicIpAddress

Indicates whether to assign a public IPv4 address to an instance.

public object? AssociatePublicIpAddress { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatepublicipaddress

DeleteOnTermination

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

public object? DeleteOnTermination { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deleteontermination

Description

The description of the network interface.

public string? Description { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-description

DeviceIndex

The position of the network interface in the attachment order.

public string DeviceIndex { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deviceindex

EnaSrdSpecification

Configures ENA Express for UDP network traffic.

public object? EnaSrdSpecification { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-enasrdspecification

GroupSet

The IDs of the security groups for the network interface.

public string[]? GroupSet { get; set; }

Property Value

string[]

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-groupset

Ipv6AddressCount

A number of IPv6 addresses to assign to the network interface.

public double? Ipv6AddressCount { get; set; }

Property Value

double?

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresscount

Ipv6Addresses

The IPv6 addresses to assign to the network interface.

public object? Ipv6Addresses { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-ipv6addresses

NetworkInterfaceId

The ID of the network interface, when attaching an existing network interface.

public string? NetworkInterfaceId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-networkinterfaceid

PrivateIpAddress

The private IPv4 address of the network interface.

public string? PrivateIpAddress { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddress

PrivateIpAddresses

One or more private IPv4 addresses to assign to the network interface.

public object? PrivateIpAddresses { get; set; }

Property Value

object

Remarks

Only one private IPv4 address can be designated as primary.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-privateipaddresses

SecondaryPrivateIpAddressCount

The number of secondary private IPv4 addresses.

public double? SecondaryPrivateIpAddressCount { get; set; }

Property Value

double?

Remarks

You can't specify this option and specify more than one private IP address using the private IP addresses option.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-secondaryprivateipaddresscount

SubnetId

The ID of the subnet associated with the network interface.

public string? SubnetId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-subnetid

Implements

CfnInstance.INetworkInterfaceProperty