CfnNetworkInterfacePropsMixin

class aws_cdk.mixins_preview.aws_ec2.mixins.CfnNetworkInterfacePropsMixin(props, *, strategy=None)

Bases: Mixin

Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html
CloudformationResource:: AWS::EC2::NetworkInterface
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

cfn_network_interface_props_mixin = ec2_mixins.CfnNetworkInterfacePropsMixin(ec2_mixins.CfnNetworkInterfaceMixinProps(
    connection_tracking_specification=ec2_mixins.CfnNetworkInterfacePropsMixin.ConnectionTrackingSpecificationProperty(
        tcp_established_timeout=123,
        udp_stream_timeout=123,
        udp_timeout=123
    ),
    description="description",
    enable_primary_ipv6=False,
    group_set=["groupSet"],
    interface_type="interfaceType",
    ipv4_prefix_count=123,
    ipv4_prefixes=[ec2_mixins.CfnNetworkInterfacePropsMixin.Ipv4PrefixSpecificationProperty(
        ipv4_prefix="ipv4Prefix"
    )],
    ipv6_address_count=123,
    ipv6_addresses=[ec2_mixins.CfnNetworkInterfacePropsMixin.InstanceIpv6AddressProperty(
        ipv6_address="ipv6Address"
    )],
    ipv6_prefix_count=123,
    ipv6_prefixes=[ec2_mixins.CfnNetworkInterfacePropsMixin.Ipv6PrefixSpecificationProperty(
        ipv6_prefix="ipv6Prefix"
    )],
    private_ip_address="privateIpAddress",
    private_ip_addresses=[ec2_mixins.CfnNetworkInterfacePropsMixin.PrivateIpAddressSpecificationProperty(
        primary=False,
        private_ip_address="privateIpAddress"
    )],
    public_ip_dns_hostname_type_specification="publicIpDnsHostnameTypeSpecification",
    secondary_private_ip_address_count=123,
    source_dest_check=False,
    subnet_id="subnetId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EC2::NetworkInterface.

Parameters:

props (Union[CfnNetworkInterfaceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['connectionTrackingSpecification', 'description', 'enablePrimaryIpv6', 'groupSet', 'interfaceType', 'ipv4PrefixCount', 'ipv4Prefixes', 'ipv6AddressCount', 'ipv6Addresses', 'ipv6PrefixCount', 'ipv6Prefixes', 'privateIpAddress', 'privateIpAddresses', 'publicIpDnsHostnameTypeSpecification', 'secondaryPrivateIpAddressCount', 'sourceDestCheck', 'subnetId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConnectionTrackingSpecificationProperty

class CfnNetworkInterfacePropsMixin.ConnectionTrackingSpecificationProperty(*, tcp_established_timeout=None, udp_stream_timeout=None, udp_timeout=None)

Bases: object

Configurable options for connection tracking on a network interface.

For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide .

Parameters:

tcp_established_timeout (Union[int, float, None]) – Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
udp_stream_timeout (Union[int, float, None]) – Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
udp_timeout (Union[int, float, None]) – Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

connection_tracking_specification_property = ec2_mixins.CfnNetworkInterfacePropsMixin.ConnectionTrackingSpecificationProperty(
    tcp_established_timeout=123,
    udp_stream_timeout=123,
    udp_timeout=123
)

Attributes

tcp_established_timeout

Timeout (in seconds) for idle TCP connections in an established state.

Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.

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

udp_stream_timeout

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.

Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.

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

udp_timeout

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.

Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

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

InstanceIpv6AddressProperty

class CfnNetworkInterfacePropsMixin.InstanceIpv6AddressProperty(*, ipv6_address=None)

Bases: object

Describes the IPv6 addresses to associate with the network interface.

Parameters:: ipv6_address (Optional[str]) – An IPv6 address to associate with the network interface.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

instance_ipv6_address_property = ec2_mixins.CfnNetworkInterfacePropsMixin.InstanceIpv6AddressProperty(
    ipv6_address="ipv6Address"
)

Attributes

ipv6_address

An IPv6 address to associate with the network interface.

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

Ipv4PrefixSpecificationProperty

class CfnNetworkInterfacePropsMixin.Ipv4PrefixSpecificationProperty(*, ipv4_prefix=None)

Bases: object

Describes an IPv4 prefix.

Parameters:: ipv4_prefix (Optional[str]) – The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv4prefixspecification.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

ipv4_prefix_specification_property = ec2_mixins.CfnNetworkInterfacePropsMixin.Ipv4PrefixSpecificationProperty(
    ipv4_prefix="ipv4Prefix"
)

Attributes

ipv4_prefix

The IPv4 prefix.

For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .

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

Ipv6PrefixSpecificationProperty

class CfnNetworkInterfacePropsMixin.Ipv6PrefixSpecificationProperty(*, ipv6_prefix=None)

Bases: object

Describes the IPv6 prefix.

Parameters:: ipv6_prefix (Optional[str]) – The IPv6 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-ipv6prefixspecification.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

ipv6_prefix_specification_property = ec2_mixins.CfnNetworkInterfacePropsMixin.Ipv6PrefixSpecificationProperty(
    ipv6_prefix="ipv6Prefix"
)

Attributes

ipv6_prefix

The IPv6 prefix.

For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

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

PrivateIpAddressSpecificationProperty

class CfnNetworkInterfacePropsMixin.PrivateIpAddressSpecificationProperty(*, primary=None, private_ip_address=None)

Bases: object

Describes a secondary private IPv4 address for a network interface.

Parameters:

primary (Union[bool, IResolvable, None]) – Sets the private IP address as the primary private address. You can set only one primary private IP address. If you don’t specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address.
private_ip_address (Optional[str]) – The private IP address of the network interface.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

private_ip_address_specification_property = ec2_mixins.CfnNetworkInterfacePropsMixin.PrivateIpAddressSpecificationProperty(
    primary=False,
    private_ip_address="privateIpAddress"
)

Attributes

primary

Sets the private IP address as the primary private address.

You can set only one primary private IP address. If you don’t specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address.

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

private_ip_address

The private IP address of the network interface.

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

PublicIpDnsNameOptionsProperty

class CfnNetworkInterfacePropsMixin.PublicIpDnsNameOptionsProperty(*, dns_hostname_type=None, public_dual_stack_dns_name=None, public_ipv4_dns_name=None, public_ipv6_dns_name=None)

Bases: object

Public hostname type options.

For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide .

Parameters:

dns_hostname_type (Optional[str]) –
The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide .
public_dual_stack_dns_name (Optional[str]) – A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
public_ipv4_dns_name (Optional[str]) – An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
public_ipv6_dns_name (Optional[str]) – An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

public_ip_dns_name_options_property = ec2_mixins.CfnNetworkInterfacePropsMixin.PublicIpDnsNameOptionsProperty(
    dns_hostname_type="dnsHostnameType",
    public_dual_stack_dns_name="publicDualStackDnsName",
    public_ipv4_dns_name="publicIpv4DnsName",
    public_ipv6_dns_name="publicIpv6DnsName"
)

Attributes

dns_hostname_type

The public hostname type.

For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide .

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

public_dual_stack_dns_name

A dual-stack public hostname for a network interface.

Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.

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

public_ipv4_dns_name

An IPv4-enabled public hostname for a network interface.

Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.

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

public_ipv6_dns_name

An IPv6-enabled public hostname for a network interface.

Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

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