Class CfnDeployment
The AWS::ApiGateway::Deployment
resource deploys an API Gateway RestApi
resource to a stage so that clients can call the API over the internet.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeployment : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDeployment
Inherits CfnResource
Implements IInspectable
Remarks
The stage acts as an environment.
CloudformationResource: AWS::ApiGateway::Deployment
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 cfnDeployment = new CfnDeployment(this, "MyCfnDeployment", 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
CfnDeployment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeployment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeployment(Construct, String, ICfnDeploymentProps) |
Properties
AttrDeploymentId | The ID for the deployment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeployment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeployment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeployment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeployment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeployment(Construct, String, ICfnDeploymentProps)
public CfnDeployment(Construct scope, string id, ICfnDeploymentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeploymentProps
Resource properties.
Properties
AttrDeploymentId
The ID for the deployment.
public virtual string AttrDeploymentId { get; }
Property Value
System.String
Remarks
For example: abc123
.
CloudformationAttribute: DeploymentId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeploymentCanarySettings
The input configuration for a canary deployment.
public virtual object DeploymentCanarySettings { get; set; }
Property Value
System.Object
Description
The description for the Deployment resource to create.
public virtual string Description { get; set; }
Property Value
System.String
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }
Property Value
System.String
StageDescription
The description of the Stage resource for the Deployment resource to create.
public virtual object StageDescription { get; set; }
Property Value
System.Object
StageName
The name of the Stage resource for the Deployment resource to create.
public virtual string StageName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>