Class CfnStageProps

Properties for defining a CfnStage.

Inheritance

System.Object

CfnStageProps

Implements

ICfnStageProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStageProps : Object, ICfnStageProps

Syntax (vb)

Public Class CfnStageProps
    Inherits Object
    Implements ICfnStageProps

Remarks

Link: 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

Constructors

CfnStageProps()

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.

Constructors

CfnStageProps()

public CfnStageProps()

Properties

AccessLogSetting

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

public object AccessLogSetting { get; set; }

Property Value

System.Object

Remarks

Link: 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.

public object CacheClusterEnabled { get; set; }

Property Value

System.Object

Remarks

Link: 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.

public string CacheClusterSize { get; set; }

Property Value

System.String

Remarks

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

Link: 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.

public object CanarySetting { get; set; }

Property Value

System.Object

Remarks

Link: 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.

public string ClientCertificateId { get; set; }

Property Value

System.String

Remarks

Link: 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.

public string DeploymentId { get; set; }

Property Value

System.String

Remarks

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

Description

The stage's description.

public string Description { get; set; }

Property Value

System.String

Remarks

Link: 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.

public string DocumentationVersion { get; set; }

Property Value

System.String

Remarks

Link: 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.

public object MethodSettings { get; set; }

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.

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.

public string RestApiId { get; set; }

Property Value

System.String

Remarks

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

StageName

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

public string StageName { get; set; }

Property Value

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

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Each tag element is associated with a given resource.

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

TracingEnabled

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

public object TracingEnabled { get; set; }

Property Value

System.Object

Remarks

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

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.

public object Variables { get; set; }

Property Value

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

Implements

ICfnStageProps