@pulumi/aws-native/apigatewayv2/getStage.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Resource Type definition for AWS::ApiGatewayV2::Stage
 */
export declare function getStage(args: GetStageArgs, opts?: pulumi.InvokeOptions): Promise<GetStageResult>;
export interface GetStageArgs {
    /**
     * The API identifier.
     */
    apiId: string;
    /**
     * The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
     */
    stageName: string;
}
export interface GetStageResult {
    /**
     * Settings for logging access in this stage.
     */
    readonly accessLogSettings?: outputs.apigatewayv2.StageAccessLogSettings;
    /**
     * Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
     */
    readonly autoDeploy?: boolean;
    /**
     * The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
     */
    readonly clientCertificateId?: string;
    /**
     * The default route settings for the stage.
     */
    readonly defaultRouteSettings?: outputs.apigatewayv2.StageRouteSettings;
    /**
     * The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
     */
    readonly deploymentId?: string;
    /**
     * The description for the API stage.
     */
    readonly description?: string;
    /**
     * Route settings for the stage.
     *
     * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Stage` for more information about the expected schema for this property.
     */
    readonly routeSettings?: any;
    /**
     * A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
     *
     * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Stage` for more information about the expected schema for this property.
     */
    readonly stageVariables?: any;
    /**
     * The collection of tags. Each tag element is associated with a given resource.
     *
     * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Stage` for more information about the expected schema for this property.
     */
    readonly tags?: any;
}
/**
 * Resource Type definition for AWS::ApiGatewayV2::Stage
 */
export declare function getStageOutput(args: GetStageOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStageResult>;
export interface GetStageOutputArgs {
    /**
     * The API identifier.
     */
    apiId: pulumi.Input<string>;
    /**
     * The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
     */
    stageName: pulumi.Input<string>;
}