@aws-accelerator/config
    Preparing search index...

    Interface INetworkInterfaceItem

    CustomizationsConfig / AppConfigItem | Ec2FirewallConfig / LaunchTemplateConfig / NetworkInterfaceItemConfig

    The parameters for a network interface.

    https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.html

    networkInterfaces:
     - deleteOnTermination: true
       description: secondary network interface
       deviceIndex: 1
       groups:
         # security group is from network-config.yaml under the same vpc
         - SharedServices-Main-sg
       # subnet is from network-config.yaml under the same vpc
       subnetId: SharedServices-App-A
    interface INetworkInterfaceItem {
        associateCarrierIpAddress?: boolean;
        associateElasticIp?: boolean;
        associatePublicIpAddress?: boolean;
        deleteOnTermination?: boolean;
        description?: string;
        deviceIndex?: number;
        groups?: string[];
        interfaceType?: string;
        networkCardIndex?: number;
        networkInterfaceId?: string;
        privateIpAddress?: string;
        privateIpAddresses?: IPrivateIpAddressItem[];
        secondaryPrivateIpAddressCount?: number;
        sourceDestCheck?: boolean;
        subnetId?: string;
    }
    Index

    Properties

    associateCarrierIpAddress? associateElasticIp? associatePublicIpAddress? deleteOnTermination? description? deviceIndex? groups? interfaceType? networkCardIndex? networkInterfaceId? privateIpAddress? privateIpAddresses? secondaryPrivateIpAddressCount? sourceDestCheck? subnetId?

    Properties

    associateCarrierIpAddress?: boolean

    Associates a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface.

    associateElasticIp?: boolean

    Associate an elastic IP with the interface

    This property only applies to EC2-based firewall instances.

    associatePublicIpAddress?: boolean

    Associates a public IPv4 address with eth0 for a new network interface.

    deleteOnTermination?: boolean

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

    description?: string

    A description for the network interface.

    deviceIndex?: number

    The device index for the network interface attachment.

    groups?: string[]

    Security group names to associate with this network interface.

    SecurityGroupConfig

    interfaceType?: string

    The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. If you are not creating an EFA, specify interface or omit this parameter. Valid values: interface | efa

    networkCardIndex?: number

    The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

    networkInterfaceId?: string

    The ID of the network interface.

    privateIpAddress?: string

    The primary private IPv4 address of the network interface.

    privateIpAddresses?: IPrivateIpAddressItem[]

    One or more private IPv4 addresses.

    secondaryPrivateIpAddressCount?: number

    The number of secondary private IPv4 addresses to assign to a network interface.

    sourceDestCheck?: boolean

    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.

    This property only applies to EC2-based firewall instances.

    subnetId?: string

    Valid subnet name from network-config.yaml under the same vpc

    Settings

    Member Visibility

    On This Page

    Properties