Table of Contents

Interface CfnDeployment.IStageDescriptionProperty

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.

public interface CfnDeployment.IStageDescriptionProperty

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var stageDescriptionProperty = new StageDescriptionProperty {
                 AccessLogSetting = new AccessLogSettingProperty {
                     DestinationArn = "destinationArn",
                     Format = "format"
                 },
                 CacheClusterEnabled = false,
                 CacheClusterSize = "cacheClusterSize",
                 CacheDataEncrypted = false,
                 CacheTtlInSeconds = 123,
                 CachingEnabled = false,
                 CanarySetting = new CanarySettingProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 ClientCertificateId = "clientCertificateId",
                 DataTraceEnabled = false,
                 Description = "description",
                 DocumentationVersion = "documentationVersion",
                 LoggingLevel = "loggingLevel",
                 MethodSettings = new [] { new MethodSettingProperty {
                     CacheDataEncrypted = false,
                     CacheTtlInSeconds = 123,
                     CachingEnabled = false,
                     DataTraceEnabled = false,
                     HttpMethod = "httpMethod",
                     LoggingLevel = "loggingLevel",
                     MetricsEnabled = false,
                     ResourcePath = "resourcePath",
                     ThrottlingBurstLimit = 123,
                     ThrottlingRateLimit = 123
                 } },
                 MetricsEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 ThrottlingBurstLimit = 123,
                 ThrottlingRateLimit = 123,
                 TracingEnabled = false,
                 Variables = new Dictionary<string, string> {
                     { "variablesKey", "variables" }
                 }
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html

ExampleMetadata: fixture=_generated

Properties

AccessLogSetting

Specifies settings for logging access in this stage.

object? AccessLogSetting { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting

CacheClusterEnabled

Specifies whether a cache cluster is enabled for the stage.

object? CacheClusterEnabled { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled

CacheClusterSize

The size of the stage's cache cluster.

string? CacheClusterSize { get; }

Property Value

string

Remarks

For more information, see cacheClusterSize in the API Gateway API Reference .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

object? CacheDataEncrypted { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted

CacheTtlInSeconds

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

double? CacheTtlInSeconds { get; }

Property Value

double?

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds

CachingEnabled

Indicates whether responses are cached and returned for requests.

object? CachingEnabled { get; }

Property Value

object

Remarks

You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled

CanarySetting

Specifies settings for the canary deployment in this stage.

object? CanarySetting { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting

ClientCertificateId

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

string? ClientCertificateId { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid

DataTraceEnabled

Indicates whether data trace logging is enabled for methods in the stage.

object? DataTraceEnabled { get; }

Property Value

object

Remarks

API Gateway pushes these logs to Amazon CloudWatch Logs.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled

Description

A description of the purpose of the stage.

string? Description { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description

DocumentationVersion

The version identifier of the API documentation snapshot.

string? DocumentationVersion { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion

LoggingLevel

The logging level for this method.

string? LoggingLevel { get; }

Property Value

string

Remarks

For valid values, see the loggingLevel property of the MethodSetting resource in the Amazon API Gateway API Reference .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel

MethodSettings

Configures settings for all of the stage's methods.

object? MethodSettings { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings

MetricsEnabled

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

object? MetricsEnabled { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled

Tags

An array of arbitrary tags (key-value pairs) to associate with the stage.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags

ThrottlingBurstLimit

The target request burst rate limit.

double? ThrottlingBurstLimit { get; }

Property Value

double?

Remarks

This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit

ThrottlingRateLimit

The target request steady-state rate limit.

double? ThrottlingRateLimit { get; }

Property Value

double?

Remarks

For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit

TracingEnabled

Specifies whether active tracing with X-ray is enabled for this stage.

object? TracingEnabled { get; }

Property Value

object

Remarks

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled

Variables

A map that defines the stage variables.

object? Variables { get; }

Property Value

object

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables