import type { Tag } from './metadata-schema';
/**
 * 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",
    /**
     * Load balancer provider
     */
    LOAD_BALANCER_PROVIDER = "load-balancer",
    /**
     * Load balancer listener provider
     */
    LOAD_BALANCER_LISTENER_PROVIDER = "load-balancer-listener",
    /**
     * Security group provider
     */
    SECURITY_GROUP_PROVIDER = "security-group",
    /**
     * KMS Key Provider
     */
    KEY_PROVIDER = "key-provider",
    /**
     * CCAPI Provider
     */
    CC_API_PROVIDER = "cc-api-provider",
    /**
     * A plugin provider (the actual plugin name will be in the properties)
     */
    PLUGIN = "plugin"
}
/**
 * Options for context lookup roles.
 */
export interface ContextLookupRoleOptions {
    /**
     * Query account
     */
    readonly account: string;
    /**
     * Query region
     */
    readonly region: string;
    /**
     * The ARN of the role that should be used to look up the missing values
     *
     * @default - None
     */
    readonly lookupRoleArn?: string;
    /**
     * The ExternalId that needs to be supplied while assuming this role
     *
     * @default - No ExternalId will be supplied
     */
    readonly lookupRoleExternalId?: string;
    /**
     * Additional options to pass to STS when assuming the lookup role.
     *
     * - `RoleArn` should not be used. Use the dedicated `lookupRoleArn` property instead.
     * - `ExternalId` should not be used. Use the dedicated `lookupRoleExternalId` instead.
     *
     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property
     * @default - No additional options.
     */
    readonly assumeRoleAdditionalOptions?: {
        [key: string]: any;
    };
}
/**
 * Query to AMI context provider
 */
export interface AmiContextQuery extends ContextLookupRoleOptions {
    /**
     * 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 extends ContextLookupRoleOptions {
}
/**
 * Query to hosted zone context provider
 */
export interface HostedZoneContextQuery extends ContextLookupRoleOptions {
    /**
     * 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 extends ContextLookupRoleOptions {
    /**
     * Parameter name to query
     */
    readonly parameterName: string;
}
/**
 * Query input for looking up a VPC
 */
export interface VpcContextQuery extends ContextLookupRoleOptions {
    /**
     * 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 `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;
    /**
     * Whether to populate the `vpnGatewayId` field of the `VpcContextResponse`,
     * which contains the VPN Gateway ID, if one exists. You can explicitly
     * disable this in order to avoid the lookup if you know the VPC does not have
     * a VPN Gatway attached.
     *
     * @default true
     */
    readonly returnVpnGateways?: boolean;
}
/**
 * Query to endpoint service context provider
 */
export interface EndpointServiceAvailabilityZonesContextQuery extends ContextLookupRoleOptions {
    /**
     * Query service name
     */
    readonly serviceName: string;
}
/**
 * Type of load balancer
 */
export declare enum LoadBalancerType {
    /**
     * Network load balancer
     */
    NETWORK = "network",
    /**
     * Application load balancer
     */
    APPLICATION = "application"
}
/**
 * Filters for selecting load balancers
 */
export interface LoadBalancerFilter extends ContextLookupRoleOptions {
    /**
     * Filter load balancers by their type
     */
    readonly loadBalancerType: LoadBalancerType;
    /**
     * Find by load balancer's ARN
     * @default - does not search by load balancer arn
     */
    readonly loadBalancerArn?: string;
    /**
     * Match load balancer tags
     * @default - does not match load balancers by tags
     */
    readonly loadBalancerTags?: Tag[];
}
/**
 * Query input for looking up a load balancer
 */
export interface LoadBalancerContextQuery extends LoadBalancerFilter {
}
/**
 * The protocol for connections from clients to the load balancer
 */
export declare enum LoadBalancerListenerProtocol {
    /**
     * HTTP protocol
     */
    HTTP = "HTTP",
    /**
     * HTTPS protocol
     */
    HTTPS = "HTTPS",
    /**
     * TCP protocol
     */
    TCP = "TCP",
    /**
     * TLS protocol
     */
    TLS = "TLS",
    /**
     * UDP protocol
     * */
    UDP = "UDP",
    /**
     * TCP and UDP protocol
     * */
    TCP_UDP = "TCP_UDP"
}
/**
 * Query input for looking up a load balancer listener
 */
export interface LoadBalancerListenerContextQuery extends LoadBalancerFilter {
    /**
     * Find by listener's arn
     * @default - does not find by listener arn
     */
    readonly listenerArn?: string;
    /**
     * Filter by listener protocol
     * @default - does not filter by listener protocol
     */
    readonly listenerProtocol?: LoadBalancerListenerProtocol;
    /**
     * Filter listeners by listener port
     * @default - does not filter by a listener port
     */
    readonly listenerPort?: number;
}
/**
 * Query input for looking up a security group
 */
export interface SecurityGroupContextQuery extends ContextLookupRoleOptions {
    /**
     * Security group id
     *
     * @default - None
     */
    readonly securityGroupId?: string;
    /**
     * Security group name
     *
     * @default - None
     */
    readonly securityGroupName?: string;
    /**
     * VPC ID
     *
     * @default - None
     */
    readonly vpcId?: string;
}
/**
 * Query input for looking up a KMS Key
 */
export interface KeyContextQuery extends ContextLookupRoleOptions {
    /**
     * Alias name used to search the Key
     */
    readonly aliasName: string;
}
/**
 * Query input for lookup up CloudFormation resources using CC API
 *
 * The example below is required to successfully compile CDK (otherwise,
 * the CDK build will generate a synthetic example for the below, but it
 * doesn't have enough type information about the literal string union
 * to generate a validly compiling example).
 *
 * @example
 * import { CcApiContextQuery } from '@aws-cdk/cloud-assembly-schema';
 *
 * const x: CcApiContextQuery = {
 *   typeName: 'AWS::Some::Type',
 *   expectedMatchCount: 'exactly-one',
 *   resourceModel: {SomeArn: 'arn:aws:....'},
 *   propertiesToReturn: ['SomeProp'],
 *   account: '11111111111',
 *   region: 'us-east-1',
 * };
 */
export interface CcApiContextQuery extends ContextLookupRoleOptions {
    /**
     * The CloudFormation resource type.
     * See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html
     */
    readonly typeName: string;
    /**
     * Identifier of the resource to look up using `GetResource`.
     *
     * Specifying exactIdentifier will return exactly one result, or throw an error
     * unless `ignoreErrorOnMissingContext` is set.
     *
     * @default - Either exactIdentifier or propertyMatch should be specified.
     */
    readonly exactIdentifier?: string;
    /**
     * The resource model to use to select the resources, using `ListResources`..
     *
     * This is needed for sub-resources where the parent Arn is required.
     *
     * See https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html#resource-operations-list-containers
     *
     * @default - no resource Model is provided
     */
    readonly resourceModel?: Record<string, unknown>;
    /**
     * Returns any resources matching these properties, using `ListResources`.
     *
     * By default, specifying propertyMatch will successfully return 0 or more
     * results. To throw an error if the number of results is unexpected (and
     * prevent the query results from being committed to context), specify
     * `expectedMatchCount`.
     *
     * ## Notes on property completeness
     *
     * CloudControl API's `ListResources` may return fewer properties than
     * `GetResource` would, depending on the resource implementation.
     *
     * The resources that `propertyMatch` matches against will *only ever* be the
     * properties returned by the `ListResources` call.
     *
     * @default - Either exactIdentifier or propertyMatch should be specified.
     */
    readonly propertyMatch?: Record<string, unknown>;
    /**
     * This is a set of properties returned from CC API that we want to return from ContextQuery.
     *
     * If any properties listed here are absent from the target resource, an error will be thrown.
     *
     * The returned object will always include the key `Identifier` with the CC-API returned
     * field `Identifier`.
     *
     * ## Notes on property completeness
     *
     * CloudControl API's `ListResources` may return fewer properties than
     * `GetResource` would, depending on the resource implementation.
     *
     * The returned properties here are *currently* selected from the response
     * object that CloudControl API returns to the CDK CLI.
     *
     * However, if we find there is need to do so, we may decide to change this
     * behavior in the future: we might change it to perform an additional
     * `GetResource` call for resources matched by `propertyMatch`.
     */
    readonly propertiesToReturn: string[];
    /**
     * Expected count of results if `propertyMatch` is specified.
     *
     * If the expected result count does not match the actual count,
     * by default an error is produced and the result is not committed to cached
     * context, and the user can correct the situation and try again without
     * having to manually clear out the context key using `cdk context --remove`
     *
     * If the value of * `ignoreErrorOnMissingContext` is `true`, the value of
     * `expectedMatchCount` is `at-least-one | exactly-one` and the number
     * of found resources is 0, `dummyValue` is returned and committed to context
     * instead.
     *
     * @default 'any'
     */
    readonly expectedMatchCount?: 'any' | 'at-least-one' | 'at-most-one' | 'exactly-one';
    /**
     * The value to return if the resource was not found and `ignoreErrorOnMissingContext` is true.
     *
     * If supplied, `dummyValue` should be an array of objects.
     *
     * `dummyValue` does not have to have elements, and it may have objects with
     * different properties than the properties in `propertiesToReturn`, but it
     * will be easiest for downstream code if the `dummyValue` conforms to
     * the expected response shape.
     *
     * @default - No dummy value available
     */
    readonly dummyValue?: any;
    /**
     * Ignore an error and return the `dummyValue` instead if the resource was not found.
     *
     * - In case of an `exactIdentifier` lookup, return the `dummyValue` if the resource with
     *   that identifier was not found.
     * - In case of a `propertyMatch` lookup, return the `dummyValue` if `expectedMatchCount`
     *   is `at-least-one | exactly-one` and the number of resources found was 0.
     *
     * if `ignoreErrorOnMissingContext` is set, `dummyValue` should be set and be an array.
     *
     * @default false
     */
    readonly ignoreErrorOnMissingContext?: boolean;
}
/**
 * Query input for plugins
 *
 * This alternate branch is necessary because it needs to be able to escape all type checking
 * we do on on the cloud assembly -- we cannot know the properties that will be used a priori.
 */
export interface PluginContextQuery {
    /**
     * The name of the plugin
     */
    readonly pluginName: string;
    /**
     * Arbitrary other arguments for the plugin.
     *
     * This index signature is not usable in non-TypeScript/JavaScript languages.
     *
     * @jsii ignore
     */
    [key: string]: any;
}
export type ContextQueryProperties = AmiContextQuery | AvailabilityZonesContextQuery | HostedZoneContextQuery | SSMParameterContextQuery | VpcContextQuery | EndpointServiceAvailabilityZonesContextQuery | LoadBalancerContextQuery | LoadBalancerListenerContextQuery | SecurityGroupContextQuery | KeyContextQuery | CcApiContextQuery | PluginContextQuery;