Interface IStageOptions

Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStageOptions : IMethodDeploymentOptions
Syntax (vb)
Public Interface IStageOptions
    Inherits IMethodDeploymentOptions
Remarks

ExampleMetadata: infused

Examples
var logGroup = new LogGroup(this, "ApiGatewayAccessLogs");
var api = new RestApi(this, "books", new RestApiProps {
    DeployOptions = new StageOptions {
        AccessLogDestination = new LogGroupLogDestination(logGroup),
        AccessLogFormat = AccessLogFormat.Clf()
    }
});

Synopsis

Properties

AccessLogDestination

The CloudWatch Logs log group or Firehose delivery stream where to write access logs.
AccessLogFormat

A single line format of access logs of data, as specified by selected $content variables.
CacheClusterEnabled

Indicates whether cache clustering is enabled for the stage.
CacheClusterSize

The stage's cache cluster size.
ClientCertificateId

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
Description

A description of the purpose of the stage.
DocumentationVersion

The version identifier of the API documentation snapshot.
MethodOptions

Method deployment options for specific resources/methods.
StageName

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
TracingEnabled

Specifies whether Amazon X-Ray tracing is enabled for this method.
Variables

A map that defines the stage variables.

Properties

AccessLogDestination

The CloudWatch Logs log group or Firehose delivery stream where to write access logs.

virtual IAccessLogDestination AccessLogDestination { get; }
Property Value

IAccessLogDestination

Remarks

Default: - No destination

AccessLogFormat

A single line format of access logs of data, as specified by selected $content variables.

virtual AccessLogFormat AccessLogFormat { get; }
Property Value

AccessLogFormat

Remarks

The format must include either AccessLogFormat.contextRequestId() or AccessLogFormat.contextExtendedRequestId().

Default: - Common Log Format

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference

CacheClusterEnabled

Indicates whether cache clustering is enabled for the stage.

virtual Nullable<bool> CacheClusterEnabled { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - Disabled for the stage.

CacheClusterSize

The stage's cache cluster size.

virtual string CacheClusterSize { get; }
Property Value

System.String

Remarks

Default: 0.5

ClientCertificateId

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

virtual string ClientCertificateId { get; }
Property Value

System.String

Remarks

Default: - None.

Description

A description of the purpose of the stage.

virtual string Description { get; }
Property Value

System.String

Remarks

Default: - No description.

DocumentationVersion

The version identifier of the API documentation snapshot.

virtual string DocumentationVersion { get; }
Property Value

System.String

Remarks

Default: - No documentation version.

MethodOptions

Method deployment options for specific resources/methods.

virtual IDictionary<string, IMethodDeploymentOptions> MethodOptions { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, IMethodDeploymentOptions>

Remarks

These will override common options defined in StageOptions#methodOptions.

Default: - Common options will be used.

StageName

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

virtual string StageName { get; }
Property Value

System.String

Remarks

Default: - "prod"

TracingEnabled

Specifies whether Amazon X-Ray tracing is enabled for this method.

virtual Nullable<bool> TracingEnabled { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Variables

A map that defines the stage variables.

virtual IDictionary<string, string> Variables { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

Default: - No stage variables.