interface HostedZoneContextQuery
Language | Type name |
---|---|
![]() | Amazon.CDK.CloudAssembly.Schema.HostedZoneContextQuery |
![]() | software.amazon.awscdk.cloudassembly.schema.HostedZoneContextQuery |
![]() | aws_cdk.cloud_assembly_schema.HostedZoneContextQuery |
![]() | @aws-cdk/cloud-assembly-schema » HostedZoneContextQuery |
Query to hosted zone context provider.
Properties
Name | Type | Description |
---|---|---|
account | string | Query account. |
domain | string | The domain name e.g. example.com to lookup. |
region | string | Query region. |
assume | { [string]: any } | Additional options to pass to STS when assuming the lookup role. |
lookup | string | The ARN of the role that should be used to look up the missing values. |
lookup | string | The ExternalId that needs to be supplied while assuming this role. |
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.
assumeRoleAdditionalOptions?
Type:
{ [string]: any }
(optional, default: No additional options.)
Additional options to pass to STS when assuming the lookup role.
RoleArn
should not be used. Use the dedicatedlookupRoleArn
property instead.ExternalId
should not be used. Use the dedicatedlookupRoleExternalId
instead.
lookupRoleArn?
Type:
string
(optional, default: None)
The ARN of the role that should be used to look up the missing values.
lookupRoleExternalId?
Type:
string
(optional, default: No ExternalId will be supplied)
The ExternalId that needs to be supplied while assuming this role.
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.