Class CfnDeployment.StageDescriptionProperty
- 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 class CfnDeployment.StageDescriptionProperty : CfnDeployment.IStageDescriptionProperty- Inheritance
-
CfnDeployment.StageDescriptionProperty
- Implements
- Inherited Members
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
ExampleMetadata: fixture=_generated
Constructors
StageDescriptionProperty()
public StageDescriptionProperty()Properties
AccessLogSetting
Specifies settings for logging access in this stage.
public object? AccessLogSetting { get; set; }Property Value
Remarks
CacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
public object? CacheClusterEnabled { get; set; }Property Value
Remarks
CacheClusterSize
The size of the stage's cache cluster.
public string? CacheClusterSize { get; set; }Property Value
Remarks
For more information, see cacheClusterSize in the API Gateway API Reference .
CacheDataEncrypted
Indicates whether the cached responses are encrypted.
public object? CacheDataEncrypted { get; set; }Property Value
Remarks
CacheTtlInSeconds
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
public double? CacheTtlInSeconds { get; set; }Property Value
Remarks
CachingEnabled
Indicates whether responses are cached and returned for requests.
public object? CachingEnabled { get; set; }Property Value
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 .
CanarySetting
Specifies settings for the canary deployment in this stage.
public object? CanarySetting { get; set; }Property Value
Remarks
ClientCertificateId
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
public string? ClientCertificateId { get; set; }Property Value
Remarks
DataTraceEnabled
Indicates whether data trace logging is enabled for methods in the stage.
public object? DataTraceEnabled { get; set; }Property Value
Remarks
API Gateway pushes these logs to Amazon CloudWatch Logs.
Description
A description of the purpose of the stage.
public string? Description { get; set; }Property Value
Remarks
DocumentationVersion
The version identifier of the API documentation snapshot.
public string? DocumentationVersion { get; set; }Property Value
Remarks
LoggingLevel
The logging level for this method.
public string? LoggingLevel { get; set; }Property Value
Remarks
For valid values, see the loggingLevel property of the MethodSetting resource in the Amazon API Gateway API Reference .
MethodSettings
Configures settings for all of the stage's methods.
public object? MethodSettings { get; set; }Property Value
Remarks
MetricsEnabled
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
public object? MetricsEnabled { get; set; }Property Value
Remarks
Tags
An array of arbitrary tags (key-value pairs) to associate with the stage.
public ICfnTag[]? Tags { get; set; }Property Value
- ICfnTag[]
Remarks
ThrottlingBurstLimit
The target request burst rate limit.
public double? ThrottlingBurstLimit { get; set; }Property Value
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 .
ThrottlingRateLimit
The target request steady-state rate limit.
public double? ThrottlingRateLimit { get; set; }Property Value
Remarks
For more information, see Manage API Request Throttling in the API Gateway Developer Guide .
TracingEnabled
Specifies whether active tracing with X-ray is enabled for this stage.
public object? TracingEnabled { get; set; }Property Value
Remarks
For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .
Variables
A map that defines the stage variables.
public object? Variables { get; set; }Property Value
Remarks
Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .