Class Stage

Manages an Amazon API Gateway Version 2 stage. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.Stage("example", new Aws.ApiGatewayV2.StageArgs
    {
        ApiId = aws_apigatewayv2_api.Example.Id,
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Stage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public class Stage : CustomResource

Constructors

View Source

Stage(String, StageArgs, CustomResourceOptions)

Create a Stage resource with the given unique name, arguments, and options.

Declaration
public Stage(string name, StageArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
StageArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AccessLogSettings

Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.

Declaration
public Output<StageAccessLogSettings> AccessLogSettings { get; }
Property Value
Type Description
Output<StageAccessLogSettings>
View Source

ApiId

The API identifier.

Declaration
public Output<string> ApiId { get; }
Property Value
Type Description
Output<System.String>
View Source

Arn

The ARN of the stage.

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

AutoDeploy

Whether updates to an API automatically trigger a new deployment. Defaults to false.

Declaration
public Output<bool?> AutoDeploy { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

ClientCertificateId

The identifier of a client certificate for the stage. Use the aws.apigateway.ClientCertificate resource to configure a client certificate. Supported only for WebSocket APIs.

Declaration
public Output<string> ClientCertificateId { get; }
Property Value
Type Description
Output<System.String>
View Source

DefaultRouteSettings

The default route settings for the stage.

Declaration
public Output<StageDefaultRouteSettings> DefaultRouteSettings { get; }
Property Value
Type Description
Output<StageDefaultRouteSettings>
View Source

DeploymentId

The deployment identifier of the stage. Use the aws.apigatewayv2.Deployment resource to configure a deployment.

Declaration
public Output<string> DeploymentId { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

The description for the stage.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

ExecutionArn

The ARN prefix to be used in an aws.lambda.Permission's source_arn attribute or in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.

Declaration
public Output<string> ExecutionArn { get; }
Property Value
Type Description
Output<System.String>
View Source

InvokeUrl

The URL to invoke the API pointing to the stage, e.g. wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage

Declaration
public Output<string> InvokeUrl { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

The name of the stage.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

RouteSettings

Route settings for the stage.

Declaration
public Output<ImmutableArray<StageRouteSetting>> RouteSettings { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<StageRouteSetting>>
View Source

StageVariables

A map that defines the stage variables for the stage.

Declaration
public Output<ImmutableDictionary<string, string>> StageVariables { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

Tags

A map of tags to assign to the stage.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

View Source

Get(String, Input<String>, StageState, CustomResourceOptions)

Get an existing Stage resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Stage Get(string name, Input<string> id, StageState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
StageState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Stage