CfnNetworkInterface L1 construct
Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnNetworkInterface = new ec2.CfnNetworkInterface(this, 'MyCfnNetworkInterface', {
subnetId: 'subnetId',
// the properties below are optional
connectionTrackingSpecification: {
tcpEstablishedTimeout: 123,
udpStreamTimeout: 123,
udpTimeout: 123,
},
description: 'description',
enablePrimaryIpv6: false,
groupSet: ['groupSet'],
interfaceType: 'interfaceType',
ipv4PrefixCount: 123,
ipv4Prefixes: [{
ipv4Prefix: 'ipv4Prefix',
}],
ipv6AddressCount: 123,
ipv6Addresses: [{
ipv6Address: 'ipv6Address',
}],
ipv6PrefixCount: 123,
ipv6Prefixes: [{
ipv6Prefix: 'ipv6Prefix',
}],
privateIpAddress: 'privateIpAddress',
privateIpAddresses: [{
primary: false,
privateIpAddress: 'privateIpAddress',
}],
publicIpDnsHostnameTypeSpecification: 'publicIpDnsHostnameTypeSpecification',
secondaryPrivateIpAddressCount: 123,
sourceDestCheck: false,
tags: [{
key: 'key',
value: 'value',
}],
});
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 import aws_ec2 as ec2
cfn_network_interface = ec2.CfnNetworkInterface(self, "MyCfnNetworkInterface",
subnet_id="subnetId",
# the properties below are optional
connection_tracking_specification=ec2.CfnNetworkInterface.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.CfnNetworkInterface.Ipv4PrefixSpecificationProperty(
ipv4_prefix="ipv4Prefix"
)],
ipv6_address_count=123,
ipv6_addresses=[ec2.CfnNetworkInterface.InstanceIpv6AddressProperty(
ipv6_address="ipv6Address"
)],
ipv6_prefix_count=123,
ipv6_prefixes=[ec2.CfnNetworkInterface.Ipv6PrefixSpecificationProperty(
ipv6_prefix="ipv6Prefix"
)],
private_ip_address="privateIpAddress",
private_ip_addresses=[ec2.CfnNetworkInterface.PrivateIpAddressSpecificationProperty(
primary=False,
private_ip_address="privateIpAddress"
)],
public_ip_dns_hostname_type_specification="publicIpDnsHostnameTypeSpecification",
secondary_private_ip_address_count=123,
source_dest_check=False,
tags=[CfnTag(
key="key",
value="value"
)]
)
// 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.*;
CfnNetworkInterface cfnNetworkInterface = CfnNetworkInterface.Builder.create(this, "MyCfnNetworkInterface")
.subnetId("subnetId")
// the properties below are optional
.connectionTrackingSpecification(ConnectionTrackingSpecificationProperty.builder()
.tcpEstablishedTimeout(123)
.udpStreamTimeout(123)
.udpTimeout(123)
.build())
.description("description")
.enablePrimaryIpv6(false)
.groupSet(List.of("groupSet"))
.interfaceType("interfaceType")
.ipv4PrefixCount(123)
.ipv4Prefixes(List.of(Ipv4PrefixSpecificationProperty.builder()
.ipv4Prefix("ipv4Prefix")
.build()))
.ipv6AddressCount(123)
.ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
.ipv6Address("ipv6Address")
.build()))
.ipv6PrefixCount(123)
.ipv6Prefixes(List.of(Ipv6PrefixSpecificationProperty.builder()
.ipv6Prefix("ipv6Prefix")
.build()))
.privateIpAddress("privateIpAddress")
.privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
.primary(false)
.privateIpAddress("privateIpAddress")
.build()))
.publicIpDnsHostnameTypeSpecification("publicIpDnsHostnameTypeSpecification")
.secondaryPrivateIpAddressCount(123)
.sourceDestCheck(false)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnNetworkInterface = new CfnNetworkInterface(this, "MyCfnNetworkInterface", new CfnNetworkInterfaceProps {
SubnetId = "subnetId",
// the properties below are optional
ConnectionTrackingSpecification = new ConnectionTrackingSpecificationProperty {
TcpEstablishedTimeout = 123,
UdpStreamTimeout = 123,
UdpTimeout = 123
},
Description = "description",
EnablePrimaryIpv6 = false,
GroupSet = new [] { "groupSet" },
InterfaceType = "interfaceType",
Ipv4PrefixCount = 123,
Ipv4Prefixes = new [] { new Ipv4PrefixSpecificationProperty {
Ipv4Prefix = "ipv4Prefix"
} },
Ipv6AddressCount = 123,
Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
Ipv6Address = "ipv6Address"
} },
Ipv6PrefixCount = 123,
Ipv6Prefixes = new [] { new Ipv6PrefixSpecificationProperty {
Ipv6Prefix = "ipv6Prefix"
} },
PrivateIpAddress = "privateIpAddress",
PrivateIpAddresses = new [] { new PrivateIpAddressSpecificationProperty {
Primary = false,
PrivateIpAddress = "privateIpAddress"
} },
PublicIpDnsHostnameTypeSpecification = "publicIpDnsHostnameTypeSpecification",
SecondaryPrivateIpAddressCount = 123,
SourceDestCheck = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnNetworkInterface := awscdk.Aws_ec2.NewCfnNetworkInterface(this, jsii.String("MyCfnNetworkInterface"), &CfnNetworkInterfaceProps{
SubnetId: jsii.String("subnetId"),
// the properties below are optional
ConnectionTrackingSpecification: &ConnectionTrackingSpecificationProperty{
TcpEstablishedTimeout: jsii.Number(123),
UdpStreamTimeout: jsii.Number(123),
UdpTimeout: jsii.Number(123),
},
Description: jsii.String("description"),
EnablePrimaryIpv6: jsii.Boolean(false),
GroupSet: []interface{}{
jsii.String("groupSet"),
},
InterfaceType: jsii.String("interfaceType"),
Ipv4PrefixCount: jsii.Number(123),
Ipv4Prefixes: []interface{}{
&Ipv4PrefixSpecificationProperty{
Ipv4Prefix: jsii.String("ipv4Prefix"),
},
},
Ipv6AddressCount: jsii.Number(123),
Ipv6Addresses: []interface{}{
&InstanceIpv6AddressProperty{
Ipv6Address: jsii.String("ipv6Address"),
},
},
Ipv6PrefixCount: jsii.Number(123),
Ipv6Prefixes: []interface{}{
&Ipv6PrefixSpecificationProperty{
Ipv6Prefix: jsii.String("ipv6Prefix"),
},
},
PrivateIpAddress: jsii.String("privateIpAddress"),
PrivateIpAddresses: []interface{}{
&PrivateIpAddressSpecificationProperty{
Primary: jsii.Boolean(false),
PrivateIpAddress: jsii.String("privateIpAddress"),
},
},
PublicIpDnsHostnameTypeSpecification: jsii.String("publicIpDnsHostnameTypeSpecification"),
SecondaryPrivateIpAddressCount: jsii.Number(123),
SourceDestCheck: jsii.Boolean(false),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
new CfnNetworkInterface(scope: Construct, id: string, props: CfnNetworkInterfaceProps)
CfnNetworkInterface(scope: Construct, id: str, props: CfnNetworkInterfaceProps)
new CfnNetworkInterface(Construct scope, String id, CfnNetworkInterfaceProps props)
new CfnNetworkInterface(Construct scope, string id, CfnNetworkInterfaceProps props)
NewCfnNetworkInterface(Scope Construct, Id *string, Props CfnNetworkInterfaceProps)
Construct Props
connectionTrackingSpecificationIResolvable | CfnNetworkInterface.ConnectionTrackingSpecificationPropertyconnection_tracking_specificationtyping.Union[IResolvable, ConnectionTrackingSpecificationProperty]connectionTrackingSpecificationIResolvableConnectionTrackingSpecificationIResolvableConnectionTrackingSpecificationinterface{}#enablePrimaryIpv6boolean | IResolvableenable_primary_ipv6typing.Union[bool, IResolvable]enablePrimaryIpv6BooleanEnablePrimaryIpv6boolEnablePrimaryIpv6interface{}#notes
A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
groupSetstring | ISecurityGroupRef[]group_settyping.List[typing.Union[str, ISecurityGroupRef]]groupSetList<String>GroupSetstring[]GroupSet*[]interface{}#The default is interface . The supported values are efa and trunk .
ipv4PrefixCountnumberipv4_prefix_countint | floatipv4PrefixCountNumberIpv4PrefixCountdoubleIpv4PrefixCount*float64#When creating a network interface, you can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv4PrefixesIResolvable | IResolvable | CfnNetworkInterface.Ipv4PrefixSpecificationProperty[]ipv4_prefixestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, Ipv4PrefixSpecificationProperty]]]ipv4PrefixesIResolvableIpv4PrefixesIResolvableIpv4Prefixesinterface{}#When creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv6AddressCountnumberipv6_address_countint | floatipv6AddressCountNumberIpv6AddressCountdoubleIpv6AddressCount*float64#notes
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.
When creating a network interface, you can't specify a count of IPv6 addresses if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
ipv6AddressesIResolvable | IResolvable | CfnNetworkInterface.InstanceIpv6AddressProperty[]ipv6_addressestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceIpv6AddressProperty]]]ipv6AddressesIResolvableIpv6AddressesIResolvableIpv6Addressesinterface{}#notes
If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
When creating a network interface, you can't specify IPv6 addresses if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
ipv6PrefixCountnumberipv6_prefix_countint | floatipv6PrefixCountNumberIpv6PrefixCountdoubleIpv6PrefixCount*float64#When creating a network interface, you can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
ipv6PrefixesIResolvable | IResolvable | CfnNetworkInterface.Ipv6PrefixSpecificationProperty[]ipv6_prefixestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, Ipv6PrefixSpecificationProperty]]]ipv6PrefixesIResolvableIpv6PrefixesIResolvableIpv6Prefixesinterface{}#When creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
privateIpAddressstringprivate_ip_addressstrprivateIpAddressStringPrivateIpAddressstringPrivateIpAddress*string#If you want to specify multiple private IP addresses, use the PrivateIpAddresses property.
privateIpAddressesIResolvable | IResolvable | CfnNetworkInterface.PrivateIpAddressSpecificationProperty[]private_ip_addressestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrivateIpAddressSpecificationProperty]]]privateIpAddressesIResolvablePrivateIpAddressesIResolvablePrivateIpAddressesinterface{}#notes
You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
When creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
publicIpDnsHostnameTypeSpecificationstringpublic_ip_dns_hostname_type_specificationstrpublicIpDnsHostnameTypeSpecificationStringPublicIpDnsHostnameTypeSpecificationstringPublicIpDnsHostnameTypeSpecification*string#secondaryPrivateIpAddressCountnumbersecondary_private_ip_address_countint | floatsecondaryPrivateIpAddressCountNumberSecondaryPrivateIpAddressCountdoubleSecondaryPrivateIpAddressCount*float64#notes
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 .
When creating a Network Interface, you can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
sourceDestCheckboolean | IResolvablesource_dest_checktyping.Union[bool, IResolvable]sourceDestCheckBooleanSourceDestCheckboolSourceDestCheckinterface{}#notes
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.
subnetIdstring | ISubnetRefsubnet_idtyping.Union[str, ISubnetRef]subnetIdStringSubnetIdstringSubnetIdinterface{}required#Properties
attrPrimaryIpv6Addressstringattr_primary_ipv6_addressstrattrPrimaryIpv6AddressStringAttrPrimaryIpv6AddressstringAttrPrimaryIpv6Address*stringrequired#attrPrimaryPrivateIpAddressstringattr_primary_private_ip_addressstrattrPrimaryPrivateIpAddressStringAttrPrimaryPrivateIpAddressstringAttrPrimaryPrivateIpAddress*stringrequired#For example, 10.0.0.192 .
attrPublicIpDnsNameOptionsIResolvableattr_public_ip_dns_name_optionsIResolvableattrPublicIpDnsNameOptionsIResolvableAttrPublicIpDnsNameOptionsIResolvableAttrPublicIpDnsNameOptionsIResolvablerequired#attrSecondaryPrivateIpAddressesstring[]attr_secondary_private_ip_addressestyping.List[str]attrSecondaryPrivateIpAddressesList<String>AttrSecondaryPrivateIpAddressesstring[]AttrSecondaryPrivateIpAddresses*[]*stringrequired#For example, ["10.0.0.161", "10.0.0.162", "10.0.0.163"] .
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#connectionTrackingSpecificationIResolvable | CfnNetworkInterface.ConnectionTrackingSpecificationPropertyconnection_tracking_specificationtyping.Union[IResolvable, ConnectionTrackingSpecificationProperty]connectionTrackingSpecificationIResolvableConnectionTrackingSpecificationIResolvableConnectionTrackingSpecificationinterface{}#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#enablePrimaryIpv6boolean | IResolvableenable_primary_ipv6typing.Union[bool, IResolvable]enablePrimaryIpv6BooleanEnablePrimaryIpv6boolEnablePrimaryIpv6interface{}#ipv4PrefixCountnumberipv4_prefix_countint | floatipv4PrefixCountNumberIpv4PrefixCountdoubleIpv4PrefixCount*float64#ipv4PrefixesIResolvable | IResolvable | CfnNetworkInterface.Ipv4PrefixSpecificationProperty[]ipv4_prefixestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, Ipv4PrefixSpecificationProperty]]]ipv4PrefixesIResolvableIpv4PrefixesIResolvableIpv4Prefixesinterface{}#ipv6AddressCountnumberipv6_address_countint | floatipv6AddressCountNumberIpv6AddressCountdoubleIpv6AddressCount*float64#ipv6AddressesIResolvable | IResolvable | CfnNetworkInterface.InstanceIpv6AddressProperty[]ipv6_addressestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceIpv6AddressProperty]]]ipv6AddressesIResolvableIpv6AddressesIResolvableIpv6Addressesinterface{}#ipv6PrefixCountnumberipv6_prefix_countint | floatipv6PrefixCountNumberIpv6PrefixCountdoubleIpv6PrefixCount*float64#ipv6PrefixesIResolvable | IResolvable | CfnNetworkInterface.Ipv6PrefixSpecificationProperty[]ipv6_prefixestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, Ipv6PrefixSpecificationProperty]]]ipv6PrefixesIResolvableIpv6PrefixesIResolvableIpv6Prefixesinterface{}#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).
networkInterfaceRefNetworkInterfaceReferencenetwork_interface_refNetworkInterfaceReferencenetworkInterfaceRefNetworkInterfaceReferenceNetworkInterfaceRefNetworkInterfaceReferenceNetworkInterfaceRefNetworkInterfaceReferencerequired#privateIpAddressstringprivate_ip_addressstrprivateIpAddressStringPrivateIpAddressstringPrivateIpAddress*string#privateIpAddressesIResolvable | IResolvable | CfnNetworkInterface.PrivateIpAddressSpecificationProperty[]private_ip_addressestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrivateIpAddressSpecificationProperty]]]privateIpAddressesIResolvablePrivateIpAddressesIResolvablePrivateIpAddressesinterface{}#publicIpDnsHostnameTypeSpecificationstringpublic_ip_dns_hostname_type_specificationstrpublicIpDnsHostnameTypeSpecificationStringPublicIpDnsHostnameTypeSpecificationstringPublicIpDnsHostnameTypeSpecification*string#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 }).
secondaryPrivateIpAddressCountnumbersecondary_private_ip_address_countint | floatsecondaryPrivateIpAddressCountNumberSecondaryPrivateIpAddressCountdoubleSecondaryPrivateIpAddressCount*float64#sourceDestCheckboolean | IResolvablesource_dest_checktyping.Union[bool, IResolvable]sourceDestCheckBooleanSourceDestCheckboolSourceDestCheckinterface{}#CfnElements must be defined within a stack scope (directly or indirectly).
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path 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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride 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
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForNetworkInterface(resource: INetworkInterfaceRef): string@staticmethod def arn_for_network_interface(resource: INetworkInterfaceRef) -> strpublic static String arnForNetworkInterface(INetworkInterfaceRef resource)public static string ArnForNetworkInterface(INetworkInterfaceRef resource)func ArnForNetworkInterface(Resource INetworkInterfaceRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromNetworkInterfaceId(scope: Construct, id: string, networkInterfaceId: string): INetworkInterfaceRef@staticmethod def from_network_interface_id(scope: Construct, id: str, network_interface_id: str) -> INetworkInterfaceRefpublic static INetworkInterfaceRef fromNetworkInterfaceId(Construct scope, String id, String networkInterfaceId)public static INetworkInterfaceRef FromNetworkInterfaceId(Construct scope, string id, string networkInterfaceId)func FromNetworkInterfaceId(Scope Construct, Id *string, NetworkInterfaceId *string) INetworkInterfaceRefstatic#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnNetworkInterface(x: any): boolean@staticmethod def is_cfn_network_interface(x: Any) -> boolpublic static Boolean isCfnNetworkInterface(Object x)public static bool IsCfnNetworkInterface(object x)func IsCfnNetworkInterface(X interface{}) *boolstatic#isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.