Class CfnDeploymentProps
Properties for defining a CfnDeployment
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeploymentProps : Object, ICfnDeploymentProps
Syntax (vb)
Public Class CfnDeploymentProps
Inherits Object
Implements ICfnDeploymentProps
Remarks
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 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"
};
Synopsis
Constructors
CfnDeploymentProps() |
Properties
DeploymentCanarySettings | The input configuration for a canary deployment. |
Description | The description for the Deployment resource to create. |
RestApiId | The string identifier of the associated RestApi. |
StageDescription | The description of the Stage resource for the Deployment resource to create. |
StageName | The name of the Stage resource for the Deployment resource to create. |
Constructors
CfnDeploymentProps()
public CfnDeploymentProps()
Properties
DeploymentCanarySettings
The input configuration for a canary deployment.
public object DeploymentCanarySettings { get; set; }
Property Value
System.Object
Remarks
Description
The description for the Deployment resource to create.
public string Description { get; set; }
Property Value
System.String
Remarks
RestApiId
The string identifier of the associated RestApi.
public string RestApiId { get; set; }
Property Value
System.String
Remarks
StageDescription
The description of the Stage resource for the Deployment resource to create.
public object StageDescription { get; set; }
Property Value
System.Object
Remarks
To specify a stage description, you must also provide a stage name.
StageName
The name of the Stage resource for the Deployment resource to create.
public string StageName { get; set; }
Property Value
System.String