HostedZoneContextQuery

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

Bases: ContextLookupRoleOptions

Query to hosted zone context provider.

Parameters:
  • account (str) – Query account.

  • region (str) – Query region.

  • assume_role_additional_options (Optional[Mapping[str, Any]]) – Additional options to pass to STS when assuming the lookup role. - RoleArn should not be used. Use the dedicated lookupRoleArn property instead. - ExternalId should not be used. Use the dedicated lookupRoleExternalId instead. Default: - No additional options.

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

  • lookup_role_external_id (Optional[str]) – The ExternalId that needs to be supplied while assuming this role. Default: - No ExternalId will be supplied

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

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

  • 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

Attributes

account

Query account.

assume_role_additional_options

Additional options to pass to STS when assuming the lookup role.

  • RoleArn should not be used. Use the dedicated lookupRoleArn property instead.

  • ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.

Default:
  • No additional options.

See:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

domain_name

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

lookup_role_arn

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

Default:
  • None

lookup_role_external_id

The ExternalId that needs to be supplied while assuming this role.

Default:
  • No ExternalId will be supplied

private_zone

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

Default:

false

region

Query region.

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