CfnNetworkInterface¶
-
class
aws_cdk.aws_ec2.
CfnNetworkInterface
(scope, id, *, subnet_id, description=None, group_set=None, interface_type=None, ipv6_address_count=None, ipv6_addresses=None, private_ip_address=None, private_ip_addresses=None, secondary_private_ip_address_count=None, source_dest_check=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::NetworkInterface
.Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .
- CloudformationResource
AWS::EC2::NetworkInterface
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_network_interface = ec2.CfnNetworkInterface(self, "MyCfnNetworkInterface", subnet_id="subnetId", # the properties below are optional description="description", group_set=["groupSet"], interface_type="interfaceType", ipv6_address_count=123, ipv6_addresses=[ec2.CfnNetworkInterface.InstanceIpv6AddressProperty( ipv6_address="ipv6Address" )], private_ip_address="privateIpAddress", private_ip_addresses=[ec2.CfnNetworkInterface.PrivateIpAddressSpecificationProperty( primary=False, private_ip_address="privateIpAddress" )], secondary_private_ip_address_count=123, source_dest_check=False, tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::EC2::NetworkInterface
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
subnet_id (
str
) – The ID of the subnet to associate with the network interface.description (
Optional
[str
]) – A description for the network interface.group_set (
Optional
[Sequence
[str
]]) – The security group IDs associated with this network interface.interface_type (
Optional
[str
]) – The type of network interface. The default isinterface
. The supported values areefa
andtrunk
.ipv6_address_count (
Union
[int
,float
,None
]) – The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use theIpv6Addresses
property and don’t specify this property.ipv6_addresses (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,InstanceIpv6AddressProperty
]],None
]) – One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you’re specifying a number of IPv6 addresses, use theIpv6AddressCount
property and don’t specify this property.private_ip_address (
Optional
[str
]) – Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use thePrivateIpAddresses
property.private_ip_addresses (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PrivateIpAddressSpecificationProperty
]],None
]) – Assigns private IP addresses to the network interface. You can specify a primary private IP address by setting the value of thePrimary
property totrue
in thePrivateIpAddressSpecification
property. If you want EC2 to automatically assign private IP addresses, use theSecondaryPrivateIpAddressCount
property and do not specify this property.secondary_private_ip_address_count (
Union
[int
,float
,None
]) – The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet’s IPv4 CIDR range. You can’t specify this option and specify more than one private IP address usingprivateIpAddresses
. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .source_dest_check (
Union
[bool
,IResolvable
,None
]) – Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value istrue
, source/destination checks are enabled; otherwise, they are disabled. The default value istrue
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.tags (
Optional
[Sequence
[CfnTag
]]) – An arbitrary set of tags (key-value pairs) for this network interface.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::EC2::NetworkInterface'¶
-
attr_id
¶ The ID of the network interface.
- CloudformationAttribute
Id
- Return type
str
-
attr_primary_private_ip_address
¶ The primary private IP address of the network interface.
For example,
10.0.0.192
.- CloudformationAttribute
PrimaryPrivateIpAddress
- Return type
str
-
attr_secondary_private_ip_addresses
¶ The secondary private IP addresses of the network interface.
For example,
["10.0.0.161", "10.0.0.162", "10.0.0.163"]
.- CloudformationAttribute
SecondaryPrivateIpAddresses
- Return type
List
[str
]
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
description
¶ A description for the network interface.
-
group_set
¶ The security group IDs associated with this network interface.
- Link
- Return type
Optional
[List
[str
]]
-
interface_type
¶ The type of network interface.
The default is
interface
. The supported values areefa
andtrunk
.
-
ipv6_address_count
¶ The number of IPv6 addresses to assign to a network interface.
Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the
Ipv6Addresses
property and don’t specify this property.- Link
- Return type
Union
[int
,float
,None
]
-
ipv6_addresses
¶ One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
If you’re specifying a number of IPv6 addresses, use the
Ipv6AddressCount
property and don’t specify this property.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,InstanceIpv6AddressProperty
]],None
]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
private_ip_address
¶ Assigns a single private IP address to the network interface, which is used as the primary private IP address.
If you want to specify multiple private IP address, use the
PrivateIpAddresses
property.
-
private_ip_addresses
¶ Assigns private IP addresses to the network interface.
You can specify a primary private IP address by setting the value of the
Primary
property totrue
in thePrivateIpAddressSpecification
property. If you want EC2 to automatically assign private IP addresses, use theSecondaryPrivateIpAddressCount
property and do not specify this property.
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
secondary_private_ip_address_count
¶ The number of secondary private IPv4 addresses to assign to a network interface.
When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet’s IPv4 CIDR range. You can’t specify this option and specify more than one private IP address using
privateIpAddresses
.The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
- Link
- Return type
Union
[int
,float
,None
]
-
source_dest_check
¶ Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
If the value is
true
, source/destination checks are enabled; otherwise, they are disabled. The default value istrue
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
subnet_id
¶ The ID of the subnet to associate with the network interface.
An arbitrary set of tags (key-value pairs) for this network interface.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
InstanceIpv6AddressProperty¶
-
class
CfnNetworkInterface.
InstanceIpv6AddressProperty
(*, ipv6_address)¶ Bases:
object
Describes the IPv6 addresses to associate with the network interface.
- Parameters
ipv6_address (
str
) – An IPv6 address to associate with the network interface.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 instance_ipv6_address_property = ec2.CfnNetworkInterface.InstanceIpv6AddressProperty( ipv6_address="ipv6Address" )
Attributes
-
ipv6_address
¶ An IPv6 address to associate with the network interface.
PrivateIpAddressSpecificationProperty¶
-
class
CfnNetworkInterface.
PrivateIpAddressSpecificationProperty
(*, primary, private_ip_address)¶ Bases:
object
Describes a secondary private IPv4 address for a network interface.
- Parameters
primary (
Union
[bool
,IResolvable
]) – 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 (
str
) – The private IP address of the network interface.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 private_ip_address_specification_property = ec2.CfnNetworkInterface.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.
-
private_ip_address
¶ The private IP address of the network interface.