HostedZoneContextQuery

class aws_cdk.cloud_assembly_schema.HostedZoneContextQuery(*, account, domain_name, lookup_role_arn=None, private_zone=None, region, vpc_id=None)

Bases: object

Query to hosted zone context provider.

Parameters
  • account (str) – Query account.

  • domain_name (str) – The domain name e.g. example.com to lookup.

  • lookup_role_arn (Optional[str]) – The ARN of the role that should be used to look up the missing values. Default: - None

  • private_zone (Optional[bool]) – True if the zone you want to find is a private hosted zone. Default: false

  • region (str) – Query region.

  • vpc_id (Optional[str]) – The VPC ID to that the private zone must be associated with. If you provide VPC ID and privateZone is false, this will return no results and raise an error. Default: - Required if privateZone=true

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

hosted_zone_context_query = cloud_assembly_schema.HostedZoneContextQuery(
    account="account",
    domain_name="domainName",
    region="region",

    # the properties below are optional
    lookup_role_arn="lookupRoleArn",
    private_zone=False,
    vpc_id="vpcId"
)

Attributes

account

Query account.

Return type

str

domain_name

The domain name e.g. example.com to lookup.

Return type

str

lookup_role_arn

The ARN of the role that should be used to look up the missing values.

Default
  • None

Return type

Optional[str]

private_zone

True if the zone you want to find is a private hosted zone.

Default

false

Return type

Optional[bool]

region

Query region.

Return type

str

vpc_id

The VPC ID to that the private zone must be associated with.

If you provide VPC ID and privateZone is false, this will return no results and raise an error.

Default
  • Required if privateZone=true

Return type

Optional[str]