CfnHostedZone L1 construct
Creates a new public or private hosted zone.
You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing .
Note the following:
- You can't create a hosted zone for a top-level domain (TLD) such as .com.
- If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide .
When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING . For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC .
The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.
When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS Regions . Each AWS account is scoped to one partition.
The following are the supported partitions:
aws- AWS Regionsaws-cn- China Regionsaws-us-gov- AWS GovCloud (US) RegionFor more information, see Access Management in the AWS General Reference .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_route53 as route53 } from 'aws-cdk-lib';
const cfnHostedZone = new route53.CfnHostedZone(this, 'MyCfnHostedZone', /* all optional props */ {
hostedZoneConfig: {
comment: 'comment',
},
hostedZoneFeatures: {
enableAcceleratedRecovery: false,
},
hostedZoneTags: [{
key: 'key',
value: 'value',
}],
name: 'name',
queryLoggingConfig: {
cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
},
vpcs: [{
vpcId: 'vpcId',
vpcRegion: 'vpcRegion',
}],
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53
cfn_hosted_zone = route53.CfnHostedZone(self, "MyCfnHostedZone",
hosted_zone_config=route53.CfnHostedZone.HostedZoneConfigProperty(
comment="comment"
),
hosted_zone_features=route53.CfnHostedZone.HostedZoneFeaturesProperty(
enable_accelerated_recovery=False
),
hosted_zone_tags=[route53.CfnHostedZone.HostedZoneTagProperty(
key="key",
value="value"
)],
name="name",
query_logging_config=route53.CfnHostedZone.QueryLoggingConfigProperty(
cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn"
),
vpcs=[route53.CfnHostedZone.VPCProperty(
vpc_id="vpcId",
vpc_region="vpcRegion"
)]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.route53.*;
CfnHostedZone cfnHostedZone = CfnHostedZone.Builder.create(this, "MyCfnHostedZone")
.hostedZoneConfig(HostedZoneConfigProperty.builder()
.comment("comment")
.build())
.hostedZoneFeatures(HostedZoneFeaturesProperty.builder()
.enableAcceleratedRecovery(false)
.build())
.hostedZoneTags(List.of(HostedZoneTagProperty.builder()
.key("key")
.value("value")
.build()))
.name("name")
.queryLoggingConfig(QueryLoggingConfigProperty.builder()
.cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
.build())
.vpcs(List.of(VPCProperty.builder()
.vpcId("vpcId")
.vpcRegion("vpcRegion")
.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.Route53;
var cfnHostedZone = new CfnHostedZone(this, "MyCfnHostedZone", new CfnHostedZoneProps {
HostedZoneConfig = new HostedZoneConfigProperty {
Comment = "comment"
},
HostedZoneFeatures = new HostedZoneFeaturesProperty {
EnableAcceleratedRecovery = false
},
HostedZoneTags = new [] { new HostedZoneTagProperty {
Key = "key",
Value = "value"
} },
Name = "name",
QueryLoggingConfig = new QueryLoggingConfigProperty {
CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn"
},
Vpcs = new [] { new VPCProperty {
VpcId = "vpcId",
VpcRegion = "vpcRegion"
} }
});
// 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"
cfnHostedZone := awscdk.Aws_route53.NewCfnHostedZone(this, jsii.String("MyCfnHostedZone"), &CfnHostedZoneProps{
HostedZoneConfig: &HostedZoneConfigProperty{
Comment: jsii.String("comment"),
},
HostedZoneFeatures: &HostedZoneFeaturesProperty{
EnableAcceleratedRecovery: jsii.Boolean(false),
},
HostedZoneTags: []HostedZoneTagProperty{
&HostedZoneTagProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Name: jsii.String("name"),
QueryLoggingConfig: &QueryLoggingConfigProperty{
CloudWatchLogsLogGroupArn: jsii.String("cloudWatchLogsLogGroupArn"),
},
Vpcs: []interface{}{
&VPCProperty{
VpcId: jsii.String("vpcId"),
VpcRegion: jsii.String("vpcRegion"),
},
},
})
Initializer
new CfnHostedZone(scope: Construct, id: string, props?: CfnHostedZoneProps)
CfnHostedZone(scope: Construct, id: str, props: typing.Optional[CfnHostedZoneProps] = None)
new CfnHostedZone(Construct scope, String id, CfnHostedZoneProps props)
new CfnHostedZone(Construct scope, string id, CfnHostedZoneProps? props = null)
NewCfnHostedZone(Scope Construct, Id *string, Props CfnHostedZoneProps)
Construct Props
hostedZoneConfigIResolvable | CfnHostedZone.HostedZoneConfigPropertyhosted_zone_configtyping.Union[IResolvable, HostedZoneConfigProperty]hostedZoneConfigIResolvableHostedZoneConfigIResolvableHostedZoneConfiginterface{}#If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements.
hostedZoneFeaturesIResolvable | CfnHostedZone.HostedZoneFeaturesPropertyhosted_zone_featurestyping.Union[IResolvable, HostedZoneFeaturesProperty]hostedZoneFeaturesIResolvableHostedZoneFeaturesIResolvableHostedZoneFeaturesinterface{}#hostedZoneTagsCfnHostedZone.HostedZoneTagProperty[]hosted_zone_tagstyping.List[HostedZoneTagProperty]hostedZoneTagsList<HostedZoneTagProperty>HostedZoneTagsHostedZoneTagProperty[]HostedZoneTags*[]HostedZoneTagProperty#For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
notes
Specify a fully qualified domain name, for example, www.example.com . The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function.
queryLoggingConfigIResolvable | CfnHostedZone.QueryLoggingConfigPropertyquery_logging_configtyping.Union[IResolvable, QueryLoggingConfigProperty]queryLoggingConfigIResolvableQueryLoggingConfigIResolvableQueryLoggingConfiginterface{}#notes
After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as
NoErrororServFailLog Group and Resource Policy - Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region.
You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.
When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
/aws/route53/ *hosted zone name*
In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
- Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of
Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with*, for example:
arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*
To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:
- For
aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example,aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. - For
aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example,aws:SourceAccount:111111111111.
For more information, see The confused deputy problem in the AWS IAM User Guide .
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI .
Log Streams and Edge Locations - When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
*hosted zone ID* / *edge location code*
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page.
- Queries That Are Logged - Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide .
- Log File Format - For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide .
- Pricing - For information about charges for query logs, see Amazon CloudWatch Pricing .
- How to Stop Logging - If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig .
vpcsIResolvable | IResolvable | CfnHostedZone.VPCProperty[]vpcstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VPCProperty]]]vpcsIResolvableVpcsIResolvableVpcsinterface{}#For public hosted zones, omit
VPCs,VPCId, andVPCRegion.
Properties
attrNameServersstring[]attr_name_serverstyping.List[str]attrNameServersList<String>AttrNameServersstring[]AttrNameServers*[]*stringrequired#This attribute is not supported for private hosted zones.
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#hostedZoneConfigIResolvable | CfnHostedZone.HostedZoneConfigPropertyhosted_zone_configtyping.Union[IResolvable, HostedZoneConfigProperty]hostedZoneConfigIResolvableHostedZoneConfigIResolvableHostedZoneConfiginterface{}#hostedZoneFeaturesIResolvable | CfnHostedZone.HostedZoneFeaturesPropertyhosted_zone_featurestyping.Union[IResolvable, HostedZoneFeaturesProperty]hostedZoneFeaturesIResolvableHostedZoneFeaturesIResolvableHostedZoneFeaturesinterface{}#hostedZoneRefHostedZoneReferencehosted_zone_refHostedZoneReferencehostedZoneRefHostedZoneReferenceHostedZoneRefHostedZoneReferenceHostedZoneRefHostedZoneReferencerequired#hostedZoneTagsRawCfnHostedZone.HostedZoneTagProperty[]hosted_zone_tags_rawtyping.List[HostedZoneTagProperty]hostedZoneTagsRawList<HostedZoneTagProperty>HostedZoneTagsRawHostedZoneTagProperty[]HostedZoneTagsRaw*[]HostedZoneTagProperty#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).
queryLoggingConfigIResolvable | CfnHostedZone.QueryLoggingConfigPropertyquery_logging_configtyping.Union[IResolvable, QueryLoggingConfigProperty]queryLoggingConfigIResolvableQueryLoggingConfigIResolvableQueryLoggingConfiginterface{}#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 }).
CfnElements must be defined within a stack scope (directly or indirectly).
vpcsIResolvable | IResolvable | CfnHostedZone.VPCProperty[]vpcstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VPCProperty]]]vpcsIResolvableVpcsIResolvableVpcsinterface{}#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:
arnForHostedZone(resource: IHostedZoneRef): string@staticmethod def arn_for_hosted_zone(resource: IHostedZoneRef) -> strpublic static String arnForHostedZone(IHostedZoneRef resource)public static string ArnForHostedZone(IHostedZoneRef resource)func ArnForHostedZone(Resource IHostedZoneRef) *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#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.
isCfnHostedZone(x: any): boolean@staticmethod def is_cfn_hosted_zone(x: Any) -> boolpublic static Boolean isCfnHostedZone(Object x)public static bool IsCfnHostedZone(object x)func IsCfnHostedZone(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.