@pulumi/aws-native
Version:
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)
136 lines (135 loc) • 6.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::ApiGatewayV2::Stage
*/
export declare class Stage extends pulumi.CustomResource {
/**
* Get an existing Stage resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Stage;
/**
* Returns true if the given object is an instance of Stage. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Stage;
/**
* Settings for logging access in this stage.
*/
readonly accessLogSettings: pulumi.Output<outputs.apigatewayv2.StageAccessLogSettings | undefined>;
/**
* The API identifier.
*/
readonly apiId: pulumi.Output<string>;
/**
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
*/
readonly autoDeploy: pulumi.Output<boolean | undefined>;
/**
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
*/
readonly clientCertificateId: pulumi.Output<string | undefined>;
/**
* The default route settings for the stage.
*/
readonly defaultRouteSettings: pulumi.Output<outputs.apigatewayv2.StageRouteSettings | undefined>;
/**
* The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
*/
readonly deploymentId: pulumi.Output<string | undefined>;
/**
* The description for the API stage.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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: pulumi.Output<any | undefined>;
/**
* The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
*/
readonly stageName: pulumi.Output<string>;
/**
* 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: pulumi.Output<any | undefined>;
/**
* 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: pulumi.Output<any | undefined>;
/**
* Create a Stage resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: StageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Stage resource.
*/
export interface StageArgs {
/**
* Settings for logging access in this stage.
*/
accessLogSettings?: pulumi.Input<inputs.apigatewayv2.StageAccessLogSettingsArgs>;
/**
* The API identifier.
*/
apiId: pulumi.Input<string>;
/**
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
*/
autoDeploy?: pulumi.Input<boolean>;
/**
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
*/
clientCertificateId?: pulumi.Input<string>;
/**
* The default route settings for the stage.
*/
defaultRouteSettings?: pulumi.Input<inputs.apigatewayv2.StageRouteSettingsArgs>;
/**
* The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
*/
deploymentId?: pulumi.Input<string>;
/**
* The description for the API stage.
*/
description?: pulumi.Input<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.
*/
routeSettings?: any;
/**
* 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>;
/**
* 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.
*/
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.
*/
tags?: any;
}