Class CfnDeploymentProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnDeployment.

public class CfnDeploymentProps : ICfnDeploymentProps

Inheritance

object

CfnDeploymentProps

Implements

ICfnDeploymentProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 cfnDeploymentProps = new CfnDeploymentProps {
                 RestApiId = "restApiId",

                 // the properties below are optional
                 DeploymentCanarySettings = new DeploymentCanarySettingsProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Description = "description",
                 StageDescription = 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" }
                     }
                 },
                 StageName = "stageName"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html

ExampleMetadata: fixture=_generated

Constructors

CfnDeploymentProps()

public CfnDeploymentProps()

Properties

DeploymentCanarySettings

The input configuration for a canary deployment.

public object? DeploymentCanarySettings { get; set; }

Property Value

object

Remarks

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

Description

The description for the Deployment resource to create.

public string? Description { get; set; }

Property Value

string

Remarks

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

RestApiId

The string identifier of the associated RestApi.

public string RestApiId { get; set; }

Property Value

string

Remarks

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

StageDescription

The description of the Stage resource for the Deployment resource to create.

public object? StageDescription { get; set; }

Property Value

object

Remarks

To specify a stage description, you must also provide a stage name.

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

StageName

The name of the Stage resource for the Deployment resource to create.

public string? StageName { get; set; }

Property Value

string

Remarks

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