Class CfnDeployment
A CloudFormation AWS::ApiGatewayV2::Deployment
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnDeployment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDeployment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::Deployment
resource creates a deployment for an API.
CloudformationResource: AWS::ApiGatewayV2::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.APIGatewayv2;
var cfnDeployment = new CfnDeployment(this, "MyCfnDeployment", new CfnDeploymentProps {
ApiId = "apiId",
// the properties below are optional
Description = "description",
StageName = "stageName"
});
Synopsis
Constructors
CfnDeployment(Construct, String, ICfnDeploymentProps) | Create a new |
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 |
Properties
ApiId | The API identifier. |
AttrDeploymentId | The deployment ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description for the deployment resource. |
StageName | The name of an existing stage to associate with the deployment. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeployment(Construct, String, ICfnDeploymentProps)
Create a new AWS::ApiGatewayV2::Deployment
.
public CfnDeployment(Construct scope, string id, ICfnDeploymentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDeploymentProps
- resource properties.
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
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
AttrDeploymentId
The deployment ID.
public virtual string AttrDeploymentId { get; }
Property Value
System.String
Remarks
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
Description
The description for the deployment resource.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
StageName
The name of an existing stage to associate with the deployment.
public virtual string StageName { get; set; }
Property Value
System.String
Remarks
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>