Interface ICfnStageProps

Properties for defining a CfnStage.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnStageProps

Syntax (vb)

Public Interface ICfnStageProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html

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 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" }
    }
};

Synopsis

Properties

AccessLogSetting	Access log settings, including the access log format and access log destination ARN.
CacheClusterEnabled	Specifies whether a cache cluster is enabled for the stage.
CacheClusterSize	The stage's cache capacity in GB.
CanarySetting	Settings for the canary deployment in this stage.
ClientCertificateId	The identifier of a client certificate for an API stage.
DeploymentId	The identifier of the Deployment that the stage points to.
Description	The stage's description.
DocumentationVersion	The version of the associated API documentation.
MethodSettings	A map that defines the method settings for a Stage resource.
RestApiId	The string identifier of the associated RestApi.
StageName	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
Tags	The collection of tags.
TracingEnabled	Specifies whether active tracing with X-ray is enabled for the Stage.
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.

Properties

AccessLogSetting

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

virtual object AccessLogSetting { get; }

Property Value

System.Object

Remarks

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

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.

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

CacheClusterSize

The stage's cache capacity in GB.

virtual string CacheClusterSize { get; }

Property Value

System.String

Remarks

For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .

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

CanarySetting

Settings for the canary deployment in this stage.

virtual object CanarySetting { get; }

Property Value

System.Object

Remarks

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

ClientCertificateId

The identifier of a client certificate for an API stage.

virtual string ClientCertificateId { get; }

Property Value

System.String

Remarks

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

DeploymentId

The identifier of the Deployment that the stage points to.

virtual string DeploymentId { get; }

Property Value

System.String

Remarks

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

Description

The stage's description.

virtual string Description { get; }

Property Value

System.String

Remarks

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

DocumentationVersion

The version of the associated API documentation.

virtual string DocumentationVersion { get; }

Property Value

System.String

Remarks

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

MethodSettings

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

virtual object MethodSettings { get; }

Property Value

System.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.

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