Class StageState

Inheritance
System.Object
InputArgs
ResourceArgs
StageState
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 sealed class StageState : ResourceArgs

Constructors

View Source

StageState()

Declaration
public StageState()

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 Input<StageAccessLogSettingsGetArgs> AccessLogSettings { get; set; }
Property Value
Type Description
Input<StageAccessLogSettingsGetArgs>
View Source

ApiId

The API identifier.

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

Arn

The ARN of the stage.

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

AutoDeploy

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

Declaration
public Input<bool> AutoDeploy { get; set; }
Property Value
Type Description
Input<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 Input<string> ClientCertificateId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

DefaultRouteSettings

The default route settings for the stage.

Declaration
public Input<StageDefaultRouteSettingsGetArgs> DefaultRouteSettings { get; set; }
Property Value
Type Description
Input<StageDefaultRouteSettingsGetArgs>
View Source

DeploymentId

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

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

Description

The description for the stage.

Declaration
public Input<string> Description { get; set; }
Property Value
Type Description
Input<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 Input<string> ExecutionArn { get; set; }
Property Value
Type Description
Input<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 Input<string> InvokeUrl { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

The name of the stage.

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

RouteSettings

Route settings for the stage.

Declaration
public InputList<StageRouteSettingGetArgs> RouteSettings { get; set; }
Property Value
Type Description
InputList<StageRouteSettingGetArgs>
View Source

StageVariables

A map that defines the stage variables for the stage.

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

Tags

A map of tags to assign to the stage.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>