aws-cdk-lib.cloud_assembly_schema.HostedZoneContextQuery

interface HostedZoneContextQuery

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.HostedZoneContextQuery
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#HostedZoneContextQuery
Javasoftware.amazon.awscdk.cloudassembly.schema.HostedZoneContextQuery
Pythonaws_cdk.cloud_assembly_schema.HostedZoneContextQuery
TypeScript (source)aws-cdk-lib » cloud_assembly_schema » HostedZoneContextQuery

Query to hosted zone context provider.

Example

// 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';
const hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {
  account: 'account',
  domainName: 'domainName',
  region: 'region',

  // the properties below are optional
  lookupRoleArn: 'lookupRoleArn',
  privateZone: false,
  vpcId: 'vpcId',
};

Properties

NameTypeDescription
accountstringQuery account.
domainNamestringThe domain name e.g. example.com to lookup.
regionstringQuery region.
lookupRoleArn?stringThe ARN of the role that should be used to look up the missing values.
privateZone?booleanTrue if the zone you want to find is a private hosted zone.
vpcId?stringThe VPC ID to that the private zone must be associated with.

account

Type: string

Query account.


domainName

Type: string

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


region

Type: string

Query region.


lookupRoleArn?

Type: string (optional, default: None)

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


privateZone?

Type: boolean (optional, default: false)

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


vpcId?

Type: string (optional, default: Required if privateZone=true)

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.