Show / Hide Table of Contents

Interface ICfnStageMixinProps

Properties for CfnStagePropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGatewayV2

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnStageMixinProps

Syntax (vb)

Public Interface ICfnStageMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-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.CfnPropertyMixins.AWS.ApiGatewayV2;

             var routeSettings;
             var stageVariables;
             var tags;

             var cfnStageMixinProps = new CfnStageMixinProps {
                 AccessLogSettings = new AccessLogSettingsProperty {
                     DestinationArn = "destinationArn",
                     Format = "format"
                 },
                 AccessPolicyId = "accessPolicyId",
                 ApiId = "apiId",
                 AutoDeploy = false,
                 ClientCertificateId = "clientCertificateId",
                 DefaultRouteSettings = new RouteSettingsProperty {
                     DataTraceEnabled = false,
                     DetailedMetricsEnabled = false,
                     LoggingLevel = "loggingLevel",
                     ThrottlingBurstLimit = 123,
                     ThrottlingRateLimit = 123
                 },
                 DeploymentId = "deploymentId",
                 Description = "description",
                 RouteSettings = routeSettings,
                 StageName = "stageName",
                 StageVariables = stageVariables,
                 Tags = tags
             };

Synopsis

Properties

AccessLogSettings	Settings for logging access in this stage.
AccessPolicyId	This parameter is not currently supported.
ApiId	The API identifier.
AutoDeploy	Specifies whether updates to an API automatically trigger a new deployment.
ClientCertificateId	The identifier of a client certificate for a `Stage` .
DefaultRouteSettings	The default route settings for the stage.
DeploymentId	The deployment identifier for the API stage.
Description	The description for the API stage.
RouteSettings	Route settings for the stage.
StageName	The stage name.
StageVariables	A map that defines the stage variables for a `Stage` .
Tags	The collection of tags.

Properties

AccessLogSettings

Settings for logging access in this stage.

object? AccessLogSettings { get; }

Property Value

Remarks

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

Type union: either IResolvable or CfnStagePropsMixin.IAccessLogSettingsProperty

AccessPolicyId

This parameter is not currently supported.

string? AccessPolicyId { get; }

Property Value

Remarks

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

ApiId

The API identifier.

string? ApiId { get; }

Property Value

Remarks

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

AutoDeploy

Specifies whether updates to an API automatically trigger a new deployment.

object? AutoDeploy { get; }

Property Value

Remarks

The default value is false .

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

Type union: either bool or IResolvable

ClientCertificateId

The identifier of a client certificate for a Stage .

string? ClientCertificateId { get; }

Property Value

Remarks

Supported only for WebSocket APIs.

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

DefaultRouteSettings

The default route settings for the stage.

object? DefaultRouteSettings { get; }

Property Value

Remarks

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

Type union: either IResolvable or CfnStagePropsMixin.IRouteSettingsProperty

DeploymentId

The deployment identifier for the API stage.

string? DeploymentId { get; }

Property Value

Remarks

Can't be updated if autoDeploy is enabled.

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

Description

The description for the API stage.

string? Description { get; }

Property Value

Remarks

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

RouteSettings

Route settings for the stage.

object? RouteSettings { get; }

Property Value

Remarks

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

StageName

The stage name.

string? StageName { get; }

Property Value

Remarks

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

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

StageVariables

A map that defines the stage variables for a Stage .

object? StageVariables { get; }

Property Value

Remarks

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

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

Tags

The collection of tags.

object? Tags { get; }

Property Value

Remarks

Each tag element is associated with a given resource.

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