interface HostedZoneContextQuery
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.HostedZoneContextQuery |
 Java | software.amazon.awscdk.cloudassembly.schema.HostedZoneContextQuery |
 Python | aws_cdk.cloud_assembly_schema.HostedZoneContextQuery |
 TypeScript (source) | @aws-cdk/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 * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {
account: 'account',
domainName: 'domainName',
region: 'region',
// the properties below are optional
lookupRoleArn: 'lookupRoleArn',
privateZone: false,
vpcId: 'vpcId',
};
Properties
| Name | Type | Description |
|---|---|---|
| account | string | Query account. |
| domain | string | The domain name e.g. example.com to lookup. |
| region | string | Query region. |
| lookup | string | The ARN of the role that should be used to look up the missing values. |
| private | boolean | True if the zone you want to find is a private hosted zone. |
| vpc | string | The 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.