# HostedZoneContextQuery

Query to hosted zone context provider.

Extends: HostedZoneContextQuery
Extends: ContextLookupRoleOptions

- Source: [`node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.d.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.d.ts#L117)
- Type last changed: v2.160.0 · 24 Sep 2024

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {
  account: 'account',
  domainName: 'domainName',
  region: 'region',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  lookupRoleArn: 'lookupRoleArn',
  lookupRoleExternalId: 'lookupRoleExternalId',
  privateZone: false,
  vpcId: 'vpcId',
};
```

## Properties

- `account`: string (required) — Query account.

- `assumeRoleAdditionalOptions`: { [key: string]: any } — Additional options to pass to STS when assuming the lookup role.

  **Default:** No additional options.

  - `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
  - `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.

- `domainName`: string (required) — The domain name e.g. example.com to lookup.

- `lookupRoleArn`: string = None — The ARN of the role that should be used to look up the missing values.

- `lookupRoleExternalId`: string — The ExternalId that needs to be supplied while assuming this role.

  **Default:** No ExternalId will be supplied

- `privateZone`: boolean = false — True if the zone you want to find is a private hosted zone.

- `region`: string (required) — Query region.

- `vpcId`: string — The VPC ID to that the private zone must be associated with.

  **Default:** Required if privateZone=true

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