Class CfnDeploymentGroup.DeploymentProperty

Deployment is a property of the DeploymentGroup resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete.

Inheritance

object

CfnDeploymentGroup.DeploymentProperty

Implements

CfnDeploymentGroup.IDeploymentProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodeDeploy

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeploymentGroup.DeploymentProperty : CfnDeploymentGroup.IDeploymentProperty

Syntax (vb)

Public Class CfnDeploymentGroup.DeploymentProperty Implements CfnDeploymentGroup.IDeploymentProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html

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.CodeDeploy;

             var deploymentProperty = new DeploymentProperty {
                 Revision = new RevisionLocationProperty {
                     GitHubLocation = new GitHubLocationProperty {
                         CommitId = "commitId",
                         Repository = "repository"
                     },
                     RevisionType = "revisionType",
                     S3Location = new S3LocationProperty {
                         Bucket = "bucket",
                         Key = "key",

                         // the properties below are optional
                         BundleType = "bundleType",
                         ETag = "eTag",
                         Version = "version"
                     }
                 },

                 // the properties below are optional
                 Description = "description",
                 IgnoreApplicationStopFailures = false
             };

Synopsis

Constructors

DeploymentProperty()

Properties

Description	A comment about the deployment.
IgnoreApplicationStopFailures	If true, then if an `ApplicationStop` , `BeforeBlockTraffic` , or `AfterBlockTraffic` deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.
Revision	Information about the location of stored application artifacts and the service from which to retrieve them.

Constructors

DeploymentProperty()

public DeploymentProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html

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.CodeDeploy;

             var deploymentProperty = new DeploymentProperty {
                 Revision = new RevisionLocationProperty {
                     GitHubLocation = new GitHubLocationProperty {
                         CommitId = "commitId",
                         Repository = "repository"
                     },
                     RevisionType = "revisionType",
                     S3Location = new S3LocationProperty {
                         Bucket = "bucket",
                         Key = "key",

                         // the properties below are optional
                         BundleType = "bundleType",
                         ETag = "eTag",
                         Version = "version"
                     }
                 },

                 // the properties below are optional
                 Description = "description",
                 IgnoreApplicationStopFailures = false
             };

Properties

Description

A comment about the deployment.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-codedeploy-deploymentgroup-deployment-description

IgnoreApplicationStopFailures

If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.

public object? IgnoreApplicationStopFailures { get; set; }

Property Value

object

Remarks

For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic . If AfterBlockTraffic fails, the deployment continues with ApplicationStop .

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures

Revision

Information about the location of stored application artifacts and the service from which to retrieve them.

public object Revision { get; set; }