Table of Contents

Interface ICfnStageProps

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

Properties for defining a CfnStage.

public interface ICfnStageProps

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 cfnStageProps = new CfnStageProps {
                 RestApiId = "restApiId",

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

Remarks

Properties

AccessLogSetting

Access log settings, including the access log format and access log destination ARN.

object? AccessLogSetting { get; }

Property Value

object

Remarks

CacheClusterEnabled

Specifies whether a cache cluster is enabled for the stage.

object? CacheClusterEnabled { get; }

Property Value

object

Remarks

CacheClusterSize

The stage's cache capacity in GB.

string? CacheClusterSize { get; }

Property Value

string

Remarks

CanarySetting

Settings for the canary deployment in this stage.

object? CanarySetting { get; }

Property Value

object

Remarks

ClientCertificateId

The identifier of a client certificate for an API stage.

string? ClientCertificateId { get; }

Property Value

string

Remarks

DeploymentId

The identifier of the Deployment that the stage points to.

string? DeploymentId { get; }

Property Value

string

Remarks

Description

The stage's description.

string? Description { get; }

Property Value

string

Remarks

DocumentationVersion

The version of the associated API documentation.

string? DocumentationVersion { get; }

Property Value

string

Remarks

MethodSettings

A map that defines the method settings for a Stage resource.

object? MethodSettings { get; }

Property Value

object

Remarks

Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings

RestApiId

The string identifier of the associated RestApi.

string RestApiId { get; }

Property Value

string

Remarks

StageName

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

string? StageName { get; }

Property Value

string

Remarks

Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename

Tags

The collection of tags.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

TracingEnabled

Specifies whether active tracing with X-ray is enabled for the Stage.

object? TracingEnabled { get; }

Property Value

object

Remarks

Variables

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

object? Variables { get; }

Property Value

object

Remarks

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables