PublicHostedZone¶
-
class
aws_cdk.aws_route53.
PublicHostedZone
(scope, id, *, caa_amazon=None, cross_account_zone_delegation_principal=None, cross_account_zone_delegation_role_name=None, zone_name, comment=None, query_logs_log_group_arn=None)¶ Bases:
aws_cdk.aws_route53.HostedZone
Create a Route53 public hosted zone.
- ExampleMetadata
infused
- Resource
AWS::Route53::HostedZone
Example:
zone_from_attributes = route53.PublicHostedZone.from_public_hosted_zone_attributes(self, "MyZone", zone_name="example.com", hosted_zone_id="ZOJJZC49E0EPZ" ) # Does not know zoneName zone_from_id = route53.PublicHostedZone.from_public_hosted_zone_id(self, "MyZone", "ZOJJZC49E0EPZ")
- Parameters
scope (
Construct
) –id (
str
) –caa_amazon (
Optional
[bool
]) – Whether to create a CAA record to restrict certificate authorities allowed to issue certificates for this domain to Amazon only. Default: falsecross_account_zone_delegation_principal (
Optional
[IPrincipal
]) – A principal which is trusted to assume a role for zone delegation. Default: - No delegation configurationcross_account_zone_delegation_role_name (
Optional
[str
]) – The name of the role created for cross account delegation. Default: - A role name is generated automaticallyzone_name (
str
) – The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name.comment (
Optional
[str
]) – Any comments that you want to include about the hosted zone. Default: nonequery_logs_log_group_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) for the log group that you want Amazon Route 53 to send query logs to. Default: disabled
Methods
-
add_delegation
(delegate, *, comment=None, ttl=None)¶ Adds a delegation from this zone to a designated zone.
- Parameters
delegate (
IPublicHostedZone
) – the zone being delegated to.comment (
Optional
[str
]) – A comment to add on the DNS record created to incorporate the delegation. Default: nonettl (
Optional
[Duration
]) – The TTL (Time To Live) of the DNS delegation record in DNS caches. Default: 172800
- Return type
None
-
add_vpc
(_vpc)¶ Add another VPC to this private hosted zone.
- Parameters
_vpc (
IVpc
) –- Return type
None
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
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 (
RemovalPolicy
) –- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
cross_account_zone_delegation_role
¶ Role for cross account zone delegation.
- Return type
Optional
[Role
]
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
hosted_zone_arn
¶ route53:::hostedzone/${Id}.
- Type
ARN of this hosted zone, such as arn
- Type
${Partition}
- Return type
str
-
hosted_zone_id
¶ ID of this hosted zone, such as “Z23ABC4XYZL05B”.
- Return type
str
-
hosted_zone_name_servers
¶ ns1.example.com.
This attribute will be undefined for private hosted zones or hosted zones imported from another stack.
- Type
Returns the set of name servers for the specific hosted zone. For example
- Return type
Optional
[List
[str
]]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
zone_name
¶ FQDN of this hosted zone.
- Return type
str
Static Methods
-
classmethod
from_hosted_zone_attributes
(scope, id, *, hosted_zone_id, zone_name)¶ Imports a hosted zone from another stack.
Use when both hosted zone ID and hosted zone name are known.
- Parameters
scope (
Construct
) – the parent Construct for this Construct.id (
str
) – the logical name of this Construct.hosted_zone_id (
str
) – Identifier of the hosted zone.zone_name (
str
) – Name of the hosted zone.
- Return type
-
classmethod
from_hosted_zone_id
(scope, id, hosted_zone_id)¶ Import a Route 53 hosted zone defined either outside the CDK, or in a different CDK stack.
Use when hosted zone ID is known. Hosted zone name becomes unavailable through this query.
- Parameters
scope (
Construct
) – the parent Construct for this Construct.id (
str
) – the logical name of this Construct.hosted_zone_id (
str
) – the ID of the hosted zone to import.
- Return type
-
classmethod
from_lookup
(scope, id, *, domain_name, private_zone=None, vpc_id=None)¶ Lookup a hosted zone in the current account/region based on query parameters.
Requires environment, you must specify env for the stack.
Use to easily query hosted zones.
- Parameters
scope (
Construct
) –id (
str
) –domain_name (
str
) – The zone domain e.g. example.com.private_zone (
Optional
[bool
]) – Whether the zone that is being looked up is a private hosted zone. Default: falsevpc_id (
Optional
[str
]) – Specifies the ID of the VPC associated with a private hosted zone. If a VPC ID is provided and privateZone is false, no results will be returned and an error will be raised Default: - No VPC ID
- See
https://docs.aws.amazon.com/cdk/latest/guide/environments.html
- Return type
-
classmethod
from_public_hosted_zone_attributes
(scope, id, *, hosted_zone_id, zone_name)¶ Imports a public hosted zone from another stack.
Use when both hosted zone ID and hosted zone name are known.
- Parameters
scope (
Construct
) – the parent Construct for this Construct.id (
str
) – the logical name of this Construct.hosted_zone_id (
str
) – Identifier of the hosted zone.zone_name (
str
) – Name of the hosted zone.
- Return type
-
classmethod
from_public_hosted_zone_id
(scope, id, public_hosted_zone_id)¶ Import a Route 53 public hosted zone defined either outside the CDK, or in a different CDK stack.
- Parameters
scope (
Construct
) – the parent Construct for this Construct.id (
str
) – the logical name of this Construct.public_hosted_zone_id (
str
) – the ID of the public hosted zone to import.
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool