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.ApiGateway
Assembly: Pulumi.Aws.dll
Syntax
public sealed class StageState : ResourceArgs

Constructors

View Source

StageState()

Declaration
public StageState()

Properties

View Source

AccessLogSettings

Enables access logs for the API stage. Detailed below.

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

Arn

Amazon Resource Name (ARN)

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

CacheClusterEnabled

Specifies whether a cache cluster is enabled for the stage

Declaration
public Input<bool> CacheClusterEnabled { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

CacheClusterSize

The size of the cache cluster for the stage, if enabled. Allowed values include 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118 and 237.

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

ClientCertificateId

The identifier of a client certificate for the stage.

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

Deployment

The ID of the deployment that the stage points to

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

Description

The description of the stage

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

DocumentationVersion

The version of the associated API documentation

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

ExecutionArn

The execution ARN to be used in lambda_permission's source_arn when allowing API Gateway to invoke a Lambda function, e.g. arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod

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. https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod

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

RestApi

The ID of the associated REST API

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

StageName

The name of the stage

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

Tags

A map of tags to assign to the resource.

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

Variables

A map that defines the stage variables

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

XrayTracingEnabled

Whether active tracing with X-ray is enabled. Defaults to false.

Declaration
public Input<bool> XrayTracingEnabled { get; set; }
Property Value
Type Description
Input<System.Boolean>