Stage class

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

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apigatewayv2.Stage("example", {
    apiId: exampleAwsApigatewayv2Api.id,
    name: "example-stage",
});
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.Stage("example",
    api_id=example_aws_apigatewayv2_api["id"],
    name="example-stage")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.ApiGatewayV2.Stage("example", new()
    {
        ApiId = exampleAwsApigatewayv2Api.Id,
        Name = "example-stage",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.NewStage(ctx, "example", &apigatewayv2.StageArgs{
			ApiId: pulumi.Any(exampleAwsApigatewayv2Api.Id),
			Name:  pulumi.String("example-stage"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_apigatewayv2_stage" "example" {
  api_id = exampleAwsApigatewayv2Api.id
  name   = "example-stage"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Stage;
import com.pulumi.aws.apigatewayv2.StageArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Stage("example", StageArgs.builder()
            .apiId(exampleAwsApigatewayv2Api.id())
            .name("example-stage")
            .build());

    }
}
resources:
  example:
    type: aws:apigatewayv2:Stage
    properties:
      apiId: ${exampleAwsApigatewayv2Api.id}
      name: example-stage

Import

Using pulumi import, import aws.apigatewayv2.Stage using the API identifier and stage name. For example:

$ pulumi import aws:apigatewayv2/stage:Stage example aabbccddee/example-stage

> Note: The API Gateway managed stage created as part of quick_create cannot be imported.

Constructors

Stage(String name, {StageArgs? args, CustomResourceOptions? options})
Creates a new Stage. name The Pulumi resource name. args Arguments used to configure this Stage. The set of arguments for Stage. options Resource options controlling this resource's behavior.
Stage.reference(String urn)
Creates a typed reference to an existing Stage resource.

Properties

accessLogSettings ↔ Output<StageAccessLogSettings?>
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
latefinal
apiId ↔ Output<String>
API identifier.
latefinal
arn ↔ Output<String>
ARN of the stage.
latefinal
autoDeploy ↔ Output<bool?>
Whether updates to an API automatically trigger a new deployment. Defaults to false. Applicable for HTTP APIs.
latefinal
childResources → Set<Resource>
finalinherited
clientCertificateId ↔ Output<String?>
Identifier of a client certificate for the stage. Use the aws.apigateway.ClientCertificate resource to configure a client certificate. Supported only for WebSocket APIs.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultRouteSettings ↔ Output<StageDefaultRouteSettings?>
Default route settings for the stage.
latefinal
deploymentId ↔ Output<String>
Deployment identifier of the stage. Use the aws.apigatewayv2.Deployment resource to configure a deployment.
latefinal
description ↔ Output<String?>
Description for the stage. Must be less than or equal to 1024 characters in length.
latefinal
executionArn ↔ Output<String>
ARN prefix to be used in an aws.lambda.Permission's sourceArn attribute. For WebSocket APIs this attribute can additionally be used in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
invokeUrl ↔ Output<String>
URL to invoke the API pointing to the stage, e.g., wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage, or https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the stage. Must be between 1 and 128 characters in length.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
routeSettings ↔ Output<List<StageRouteSetting>?>
Route settings for the stage.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageVariables ↔ Output<Map<String, String>?>
Map that defines the stage variables for the stage.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the stage. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {StageState? state, CustomResourceOptions? options}) → Stage
Gets an existing Stage resource's state with the given name and id.