Class Stage

Inheritance
System.Object
Construct
Resource
Stage
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class Stage : Resource, IStage, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Stage
    Inherits Resource
    Implements IStage, IResource, IConstruct, IDependable
Remarks

ExampleMetadata: infused

Examples
// production stage
var prdLogGroup = new LogGroup(this, "PrdLogs");
var api = new RestApi(this, "books", new RestApiProps {
    DeployOptions = new StageOptions {
        AccessLogDestination = new LogGroupLogDestination(prdLogGroup),
        AccessLogFormat = AccessLogFormat.JsonWithStandardFields()
    }
});
var deployment = new Deployment(this, "Deployment", new DeploymentProps { Api = api });

// development stage
var devLogGroup = new LogGroup(this, "DevLogs");
new Stage(this, "dev", new StageProps {
    Deployment = deployment,
    AccessLogDestination = new LogGroupLogDestination(devLogGroup),
    AccessLogFormat = AccessLogFormat.JsonWithStandardFields(new JsonWithStandardFieldProps {
        Caller = false,
        HttpMethod = true,
        Ip = true,
        Protocol = true,
        RequestTime = true,
        ResourcePath = true,
        ResponseLength = true,
        Status = true,
        User = true
    })
});

Synopsis

Constructors

Stage(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
Stage(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
Stage(Construct, String, IStageProps)

Properties

RestApi

RestApi to which this stage is associated.
StageArn

Returns the resource ARN for this stage:.
StageName

Name of this stage.

Methods

UrlForPath(String)

Returns the invoke URL for a certain path.

Constructors

Stage(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Stage(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Stage(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Stage(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Stage(Construct, String, IStageProps)

public Stage(Construct scope, string id, IStageProps props)
Parameters
scope Constructs.Construct
id System.String
props IStageProps

Properties

RestApi

RestApi to which this stage is associated.

public virtual IRestApi RestApi { get; }
Property Value

IRestApi

StageArn

Returns the resource ARN for this stage:.

public virtual string StageArn { get; }
Property Value

System.String

Remarks

arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}

Note that this is separate from the execute-api ARN for methods and resources within this stage.

Attribute: true

StageName

Name of this stage.

public virtual string StageName { get; }
Property Value

System.String

Methods

UrlForPath(String)

Returns the invoke URL for a certain path.

public virtual string UrlForPath(string path = null)
Parameters
path System.String

The resource path.

Returns

System.String

Implements

Constructs.IConstruct