Class CfnDeploymentPropsMixin

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

Inheritance
object
Mixin
CfnDeploymentPropsMixin
Implements
IMixin
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDeploymentPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnDeploymentPropsMixin Inherits Mixin Implements IMixin
Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

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.ApiGateway;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnDeploymentPropsMixin = new CfnDeploymentPropsMixin(new CfnDeploymentMixinProps {
                 DeploymentCanarySettings = new DeploymentCanarySettingsProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Description = "description",
                 RestApiId = "restApiId",
                 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"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnDeploymentPropsMixin(ICfnDeploymentMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGateway::Deployment.

Properties

CFN_PROPERTY_KEYS

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.
Props

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.
Strategy

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.
Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnDeploymentPropsMixin(ICfnDeploymentMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::ApiGateway::Deployment.

public CfnDeploymentPropsMixin(ICfnDeploymentMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnDeploymentMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

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.ApiGateway;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnDeploymentPropsMixin = new CfnDeploymentPropsMixin(new CfnDeploymentMixinProps {
                 DeploymentCanarySettings = new DeploymentCanarySettingsProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Description = "description",
                 RestApiId = "restApiId",
                 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"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

protected virtual ICfnDeploymentMixinProps Props { get; }
Property Value

ICfnDeploymentMixinProps

Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

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.ApiGateway;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnDeploymentPropsMixin = new CfnDeploymentPropsMixin(new CfnDeploymentMixinProps {
                 DeploymentCanarySettings = new DeploymentCanarySettingsProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Description = "description",
                 RestApiId = "restApiId",
                 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"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

protected virtual IMergeStrategy Strategy { get; }
Property Value

IMergeStrategy

Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

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.ApiGateway;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnDeploymentPropsMixin = new CfnDeploymentPropsMixin(new CfnDeploymentMixinProps {
                 DeploymentCanarySettings = new DeploymentCanarySettingsProperty {
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Description = "description",
                 RestApiId = "restApiId",
                 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"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Overrides
Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Remarks

The stage acts as an environment.

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

CloudformationResource: AWS::ApiGateway::Deployment

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin