CfnVPCEndpoint L1 construct
Specifies a VPC endpoint.
A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the AWS PrivateLink User Guide .
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS service , your own service, or a service hosted by another AWS account . With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for Amazon S3 or DynamoDB . You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to Amazon S3 , see Why can't I connect to an S3 bucket using a gateway VPC endpoint?
An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.
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';
declare const policyDocument: any;
const cfnVPCEndpoint = new ec2.CfnVPCEndpoint(this, 'MyCfnVPCEndpoint', {
vpcId: 'vpcId',
// the properties below are optional
dnsOptions: {
dnsRecordIpType: 'dnsRecordIpType',
privateDnsOnlyForInboundResolverEndpoint: 'privateDnsOnlyForInboundResolverEndpoint',
privateDnsPreference: 'privateDnsPreference',
privateDnsSpecifiedDomains: ['privateDnsSpecifiedDomains'],
},
ipAddressType: 'ipAddressType',
policyDocument: policyDocument,
privateDnsEnabled: false,
resourceConfigurationArn: 'resourceConfigurationArn',
routeTableIds: ['routeTableIds'],
securityGroupIds: ['securityGroupIds'],
serviceName: 'serviceName',
serviceNetworkArn: 'serviceNetworkArn',
serviceRegion: 'serviceRegion',
subnetIds: ['subnetIds'],
tags: [{
key: 'key',
value: 'value',
}],
vpcEndpointType: 'vpcEndpointType',
});
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
# policy_document: Any
cfn_vpc_endpoint = ec2.CfnVPCEndpoint(self, "MyCfnVPCEndpoint",
vpc_id="vpcId",
# the properties below are optional
dns_options=ec2.CfnVPCEndpoint.DnsOptionsSpecificationProperty(
dns_record_ip_type="dnsRecordIpType",
private_dns_only_for_inbound_resolver_endpoint="privateDnsOnlyForInboundResolverEndpoint",
private_dns_preference="privateDnsPreference",
private_dns_specified_domains=["privateDnsSpecifiedDomains"]
),
ip_address_type="ipAddressType",
policy_document=policy_document,
private_dns_enabled=False,
resource_configuration_arn="resourceConfigurationArn",
route_table_ids=["routeTableIds"],
security_group_ids=["securityGroupIds"],
service_name="serviceName",
service_network_arn="serviceNetworkArn",
service_region="serviceRegion",
subnet_ids=["subnetIds"],
tags=[CfnTag(
key="key",
value="value"
)],
vpc_endpoint_type="vpcEndpointType"
)
// 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.*;
Object policyDocument;
CfnVPCEndpoint cfnVPCEndpoint = CfnVPCEndpoint.Builder.create(this, "MyCfnVPCEndpoint")
.vpcId("vpcId")
// the properties below are optional
.dnsOptions(DnsOptionsSpecificationProperty.builder()
.dnsRecordIpType("dnsRecordIpType")
.privateDnsOnlyForInboundResolverEndpoint("privateDnsOnlyForInboundResolverEndpoint")
.privateDnsPreference("privateDnsPreference")
.privateDnsSpecifiedDomains(List.of("privateDnsSpecifiedDomains"))
.build())
.ipAddressType("ipAddressType")
.policyDocument(policyDocument)
.privateDnsEnabled(false)
.resourceConfigurationArn("resourceConfigurationArn")
.routeTableIds(List.of("routeTableIds"))
.securityGroupIds(List.of("securityGroupIds"))
.serviceName("serviceName")
.serviceNetworkArn("serviceNetworkArn")
.serviceRegion("serviceRegion")
.subnetIds(List.of("subnetIds"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcEndpointType("vpcEndpointType")
.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 policyDocument;
var cfnVPCEndpoint = new CfnVPCEndpoint(this, "MyCfnVPCEndpoint", new CfnVPCEndpointProps {
VpcId = "vpcId",
// the properties below are optional
DnsOptions = new DnsOptionsSpecificationProperty {
DnsRecordIpType = "dnsRecordIpType",
PrivateDnsOnlyForInboundResolverEndpoint = "privateDnsOnlyForInboundResolverEndpoint",
PrivateDnsPreference = "privateDnsPreference",
PrivateDnsSpecifiedDomains = new [] { "privateDnsSpecifiedDomains" }
},
IpAddressType = "ipAddressType",
PolicyDocument = policyDocument,
PrivateDnsEnabled = false,
ResourceConfigurationArn = "resourceConfigurationArn",
RouteTableIds = new [] { "routeTableIds" },
SecurityGroupIds = new [] { "securityGroupIds" },
ServiceName = "serviceName",
ServiceNetworkArn = "serviceNetworkArn",
ServiceRegion = "serviceRegion",
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcEndpointType = "vpcEndpointType"
});
// 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"
var policyDocument interface{}
cfnVPCEndpoint := awscdk.Aws_ec2.NewCfnVPCEndpoint(this, jsii.String("MyCfnVPCEndpoint"), &CfnVPCEndpointProps{
VpcId: jsii.String("vpcId"),
// the properties below are optional
DnsOptions: &DnsOptionsSpecificationProperty{
DnsRecordIpType: jsii.String("dnsRecordIpType"),
PrivateDnsOnlyForInboundResolverEndpoint: jsii.String("privateDnsOnlyForInboundResolverEndpoint"),
PrivateDnsPreference: jsii.String("privateDnsPreference"),
PrivateDnsSpecifiedDomains: []*string{
jsii.String("privateDnsSpecifiedDomains"),
},
},
IpAddressType: jsii.String("ipAddressType"),
PolicyDocument: policyDocument,
PrivateDnsEnabled: jsii.Boolean(false),
ResourceConfigurationArn: jsii.String("resourceConfigurationArn"),
RouteTableIds: []interface{}{
jsii.String("routeTableIds"),
},
SecurityGroupIds: []interface{}{
jsii.String("securityGroupIds"),
},
ServiceName: jsii.String("serviceName"),
ServiceNetworkArn: jsii.String("serviceNetworkArn"),
ServiceRegion: jsii.String("serviceRegion"),
SubnetIds: []interface{}{
jsii.String("subnetIds"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VpcEndpointType: jsii.String("vpcEndpointType"),
})
Initializer
new CfnVPCEndpoint(scope: Construct, id: string, props: CfnVPCEndpointProps)
CfnVPCEndpoint(scope: Construct, id: str, props: CfnVPCEndpointProps)
new CfnVPCEndpoint(Construct scope, String id, CfnVPCEndpointProps props)
new CfnVPCEndpoint(Construct scope, string id, CfnVPCEndpointProps props)
NewCfnVPCEndpoint(Scope Construct, Id *string, Props CfnVPCEndpointProps)
Construct Props
dnsOptionsIResolvable | CfnVPCEndpoint.DnsOptionsSpecificationPropertydns_optionstyping.Union[IResolvable, DnsOptionsSpecificationProperty]dnsOptionsIResolvableDnsOptionsIResolvableDnsOptionsinterface{}#policyDocumentanypolicy_documentAnypolicyDocumentObjectPolicyDocumentobjectPolicyDocumentinterface{}#notes
The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and AWS CloudFormation converts the policy to JSON format before calling the API actions for AWS PrivateLink . Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties section:
Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'
privateDnsEnabledboolean | IResolvableprivate_dns_enabledtyping.Union[bool, IResolvable]privateDnsEnabledBooleanPrivateDnsEnabledboolPrivateDnsEnabledinterface{}#notes
The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport .
This property is supported only for interface endpoints.
Default: false
resourceConfigurationArnstringresource_configuration_arnstrresourceConfigurationArnStringResourceConfigurationArnstringResourceConfigurationArn*string#routeTableIdsstring | IRouteTableRef[]route_table_idstyping.List[typing.Union[str, IRouteTableRef]]routeTableIdsList<String>RouteTableIdsstring[]RouteTableIds*[]interface{}#Routing is supported only for gateway endpoints.
securityGroupIdsstring | ISecurityGroupRef[]security_group_idstyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupIdsList<String>SecurityGroupIdsstring[]SecurityGroupIds*[]interface{}#If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
serviceNetworkArnstringservice_network_arnstrserviceNetworkArnStringServiceNetworkArnstringServiceNetworkArn*string#subnetIdsstring | ISubnetRef[]subnet_idstyping.List[typing.Union[str, ISubnetRef]]subnetIdsList<String>SubnetIdsstring[]SubnetIds*[]interface{}#You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
vpcEndpointTypestringvpc_endpoint_typestrvpcEndpointTypeStringVpcEndpointTypestringVpcEndpointType*string#Default: Gateway
Properties
attrCreationTimestampstringattr_creation_timestampstrattrCreationTimestampStringAttrCreationTimestampstringAttrCreationTimestamp*stringrequired#For example: Fri Sep 28 23:34:36 UTC 2018.
attrDnsEntriesstring[]attr_dns_entriestyping.List[str]attrDnsEntriesList<String>AttrDnsEntriesstring[]AttrDnsEntries*[]*stringrequired#notes
Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.
The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.
["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]
If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.
attrNetworkInterfaceIdsstring[]attr_network_interface_idstyping.List[str]attrNetworkInterfaceIdsList<String>AttrNetworkInterfaceIdsstring[]AttrNetworkInterfaceIds*[]*stringrequired#If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#dnsOptionsIResolvable | CfnVPCEndpoint.DnsOptionsSpecificationPropertydns_optionstyping.Union[IResolvable, DnsOptionsSpecificationProperty]dnsOptionsIResolvableDnsOptionsIResolvableDnsOptionsinterface{}#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).
policyDocumentanypolicy_documentAnypolicyDocumentObjectPolicyDocumentobjectPolicyDocumentinterface{}required#privateDnsEnabledboolean | IResolvableprivate_dns_enabledtyping.Union[bool, IResolvable]privateDnsEnabledBooleanPrivateDnsEnabledboolPrivateDnsEnabledinterface{}#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 }).
resourceConfigurationArnstringresource_configuration_arnstrresourceConfigurationArnStringResourceConfigurationArnstringResourceConfigurationArn*string#routeTableIdsstring[]route_table_idstyping.List[str]routeTableIdsList<String>RouteTableIdsstring[]RouteTableIds*[]*string#securityGroupIdsstring[]security_group_idstyping.List[str]securityGroupIdsList<String>SecurityGroupIdsstring[]SecurityGroupIds*[]*string#serviceNetworkArnstringservice_network_arnstrserviceNetworkArnStringServiceNetworkArnstringServiceNetworkArn*string#CfnElements must be defined within a stack scope (directly or indirectly).
subnetIdsstring[]subnet_idstyping.List[str]subnetIdsList<String>SubnetIdsstring[]SubnetIds*[]*string#vpcEndpointRefVPCEndpointReferencevpc_endpoint_refVPCEndpointReferencevpcEndpointRefVPCEndpointReferenceVpcEndpointRefVPCEndpointReferenceVpcEndpointRefVPCEndpointReferencerequired#vpcEndpointTypestringvpc_endpoint_typestrvpcEndpointTypeStringVpcEndpointTypestringVpcEndpointType*string#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:
arnForVPCEndpoint(resource: IVPCEndpointRef): string@staticmethod def arn_for_vpc_endpoint(resource: IVPCEndpointRef) -> strpublic static String arnForVPCEndpoint(IVPCEndpointRef resource)public static string ArnForVPCEndpoint(IVPCEndpointRef resource)func ArnForVPCEndpoint(Resource IVPCEndpointRef) *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#fromVpcEndpointId(scope: Construct, id: string, vpcEndpointId: string): IVPCEndpointRef@staticmethod def from_vpc_endpoint_id(scope: Construct, id: str, vpc_endpoint_id: str) -> IVPCEndpointRefpublic static IVPCEndpointRef fromVpcEndpointId(Construct scope, String id, String vpcEndpointId)public static IVPCEndpointRef FromVpcEndpointId(Construct scope, string id, string vpcEndpointId)func FromVpcEndpointId(Scope Construct, Id *string, VpcEndpointId *string) IVPCEndpointRefstatic#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.
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#isCfnVPCEndpoint(x: any): boolean@staticmethod def is_cfn_vpc_endpoint(x: Any) -> boolpublic static Boolean isCfnVPCEndpoint(Object x)public static bool IsCfnVPCEndpoint(object x)func IsCfnVPCEndpoint(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.