Show / Hide Table of Contents

Interface IStageProps

Inherited Members
IStageOptions.AccessLogDestination
IStageOptions.AccessLogFormat
IStageOptions.CacheClusterEnabled
IStageOptions.CacheClusterSize
IStageOptions.ClientCertificateId
IStageOptions.Description
IStageOptions.DocumentationVersion
IStageOptions.MethodOptions
IStageOptions.StageName
IStageOptions.TracingEnabled
IStageOptions.Variables
IMethodDeploymentOptions.CacheDataEncrypted
IMethodDeploymentOptions.CacheTtl
IMethodDeploymentOptions.CachingEnabled
IMethodDeploymentOptions.DataTraceEnabled
IMethodDeploymentOptions.LoggingLevel
IMethodDeploymentOptions.MetricsEnabled
IMethodDeploymentOptions.ThrottlingBurstLimit
IMethodDeploymentOptions.ThrottlingRateLimit
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStageProps : IStageOptions, IMethodDeploymentOptions
Syntax (vb)
Public Interface IStageProps
    Inherits IStageOptions, IMethodDeploymentOptions
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

Properties

Deployment

The deployment that this stage points to [disable-awslint:ref-via-interface].

Properties

Deployment

The deployment that this stage points to [disable-awslint:ref-via-interface].

Deployment Deployment { get; }
Property Value

Deployment

Back to top Generated by DocFX