Interface CfnDeployment.IStageDescriptionProperty
StageDescription
is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStageDescriptionProperty
Syntax (vb)
Public Interface IStageDescriptionProperty
Remarks
ExampleMetadata: fixture=_generated
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" }
}
};
Synopsis
Properties
AccessLogSetting | Specifies settings for logging access in this stage. |
CacheClusterEnabled | Specifies whether a cache cluster is enabled for the stage. |
CacheClusterSize | The size of the stage's cache cluster. |
CacheDataEncrypted | Indicates whether the cached responses are encrypted. |
CacheTtlInSeconds | The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. |
CachingEnabled | Indicates whether responses are cached and returned for requests. |
CanarySetting | Specifies settings for the canary deployment in this stage. |
ClientCertificateId | The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. |
DataTraceEnabled | Indicates whether data trace logging is enabled for methods in the stage. |
Description | A description of the purpose of the stage. |
DocumentationVersion | The version identifier of the API documentation snapshot. |
LoggingLevel | The logging level for this method. |
MethodSettings | Configures settings for all of the stage's methods. |
MetricsEnabled | Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. |
Tags | An array of arbitrary tags (key-value pairs) to associate with the stage. |
ThrottlingBurstLimit | The target request burst rate limit. |
ThrottlingRateLimit | The target request steady-state rate limit. |
TracingEnabled | Specifies whether active tracing with X-ray is enabled for this stage. |
Variables | A map that defines the stage variables. |
Properties
AccessLogSetting
Specifies settings for logging access in this stage.
virtual object AccessLogSetting { get; }
Property Value
System.Object
Remarks
CacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
virtual object CacheClusterEnabled { get; }
Property Value
System.Object
Remarks
To activate a method-level cache, set CachingEnabled
to true
for a method.
CacheClusterSize
The size of the stage's cache cluster.
virtual string CacheClusterSize { get; }
Property Value
System.String
Remarks
For more information, see cacheClusterSize in the API Gateway API Reference .
CacheDataEncrypted
Indicates whether the cached responses are encrypted.
virtual object CacheDataEncrypted { get; }
Property Value
System.Object
Remarks
CacheTtlInSeconds
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
virtual Nullable<double> CacheTtlInSeconds { get; }
Property Value
System.Nullable<System.Double>
Remarks
CachingEnabled
Indicates whether responses are cached and returned for requests.
virtual object CachingEnabled { get; }
Property Value
System.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 .
CanarySetting
Specifies settings for the canary deployment in this stage.
virtual object CanarySetting { get; }
Property Value
System.Object
Remarks
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
DataTraceEnabled
Indicates whether data trace logging is enabled for methods in the stage.
virtual object DataTraceEnabled { get; }
Property Value
System.Object
Remarks
API Gateway pushes these logs to Amazon CloudWatch Logs.
Description
A description of the purpose of the stage.
virtual string Description { get; }
Property Value
System.String
Remarks
DocumentationVersion
The version identifier of the API documentation snapshot.
virtual string DocumentationVersion { get; }
Property Value
System.String
Remarks
LoggingLevel
The logging level for this method.
virtual string LoggingLevel { get; }
Property Value
System.String
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.
virtual object MethodSettings { get; }
Property Value
System.Object
Remarks
MetricsEnabled
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
virtual object MetricsEnabled { get; }
Property Value
System.Object
Remarks
Tags
An array of arbitrary tags (key-value pairs) to associate with the stage.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
ThrottlingBurstLimit
The target request burst rate limit.
virtual Nullable<double> ThrottlingBurstLimit { get; }
Property Value
System.Nullable<System.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 .
ThrottlingRateLimit
The target request steady-state rate limit.
virtual Nullable<double> ThrottlingRateLimit { get; }
Property Value
System.Nullable<System.Double>
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.
virtual object TracingEnabled { get; }
Property Value
System.Object
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.
virtual object Variables { get; }
Property Value
System.Object
Remarks
Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+
.