/** * Identifier for the context provider */ export declare enum ContextProvider { /** * AMI provider */ AMI_PROVIDER = "ami", /** * AZ provider */ AVAILABILITY_ZONE_PROVIDER = "availability-zones", /** * Route53 Hosted Zone provider */ HOSTED_ZONE_PROVIDER = "hosted-zone", /** * SSM Parameter Provider */ SSM_PARAMETER_PROVIDER = "ssm", /** * VPC Provider */ VPC_PROVIDER = "vpc-provider", /** * VPC Endpoint Service AZ Provider */ ENDPOINT_SERVICE_AVAILABILITY_ZONE_PROVIDER = "endpoint-service-availability-zones" } /** * Query to AMI context provider */ export interface AmiContextQuery { /** * Account to query */ readonly account: string; /** * Region to query */ readonly region: string; /** * Owners to DescribeImages call * * @default - All owners */ readonly owners?: string[]; /** * Filters to DescribeImages call */ readonly filters: { [key: string]: string[]; }; } /** * Query to availability zone context provider */ export interface AvailabilityZonesContextQuery { /** * Query account */ readonly account: string; /** * Query region */ readonly region: string; } /** * Query to hosted zone context provider */ export interface HostedZoneContextQuery { /** * Query account */ readonly account: string; /** * Query region */ readonly region: string; /** * The domain name e.g. example.com to lookup */ readonly domainName: string; /** * True if the zone you want to find is a private hosted zone * * @default false */ readonly privateZone?: boolean; /** * 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. * * @default - Required if privateZone=true */ readonly vpcId?: string; } /** * Query to SSM Parameter Context Provider */ export interface SSMParameterContextQuery { /** * Query account */ readonly account: string; /** * Query region */ readonly region: string; /** * Parameter name to query */ readonly parameterName: string; } /** * Query input for looking up a VPC */ export interface VpcContextQuery { /** * Query account */ readonly account: string; /** * Query region */ readonly region: string; /** * Filters to apply to the VPC * * Filter parameters are the same as passed to DescribeVpcs. * * @see https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html */ readonly filter: { [key: string]: string; }; /** * Whether to populate the subnetGroups field of the {@link VpcContextResponse}, * which contains potentially asymmetric subnet groups. * * @default false */ readonly returnAsymmetricSubnets?: boolean; /** * Optional tag for subnet group name. * If not provided, we'll look at the aws-cdk:subnet-name tag. * If the subnet does not have the specified tag, * we'll use its type as the name. * * @default 'aws-cdk:subnet-name' */ readonly subnetGroupNameTag?: string; } /** * Query to endpoint service context provider */ export interface EndpointServiceAvailabilityZonesContextQuery { /** * Query account */ readonly account: string; /** * Query region */ readonly region: string; /** * Query service name */ readonly serviceName: string; } export declare type ContextQueryProperties = AmiContextQuery | AvailabilityZonesContextQuery | HostedZoneContextQuery | SSMParameterContextQuery | VpcContextQuery | EndpointServiceAvailabilityZonesContextQuery;