HostedZoneContextQuery Struct
Query to hosted zone context provider.
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
Query account.
assumeRoleAdditionalOptions{ [key: string]: any }assume_role_additional_optionstyping.Mapping[str, Any]assumeRoleAdditionalOptionsMap<String, Object>AssumeRoleAdditionalOptionsIDictionary<string, object>AssumeRoleAdditionalOptions*map[string]interface{}#Additional options to pass to STS when assuming the lookup role.
Default: No additional options.
RoleArnshould not be used. Use the dedicatedlookupRoleArnproperty instead.ExternalIdshould not be used. Use the dedicatedlookupRoleExternalIdinstead.
The domain name e.g. example.com to lookup.
lookupRoleArnstringlookup_role_arnstrlookupRoleArnStringLookupRoleArnstringLookupRoleArn*string= None#The ARN of the role that should be used to look up the missing values.
lookupRoleExternalIdstringlookup_role_external_idstrlookupRoleExternalIdStringLookupRoleExternalIdstringLookupRoleExternalId*string#The ExternalId that needs to be supplied while assuming this role.
Default: No ExternalId will be supplied
True if the zone you want to find is a private hosted zone.
Query region.
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.