AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Information about a deployment.

Inheritance Hierarchy

System.Object
  Amazon.CodeDeploy.Model.DeploymentInfo

Namespace: Amazon.CodeDeploy.Model
Assembly: AWSSDK.CodeDeploy.dll
Version: 3.x.y.z

Syntax

C#
public class DeploymentInfo

The DeploymentInfo type exposes the following members

Constructors

NameDescription
Public Method DeploymentInfo()

Properties

NameTypeDescription
Public Property AdditionalDeploymentStatusInfo System.String

Gets and sets the property AdditionalDeploymentStatusInfo.

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

The application name.

Public Property AutoRollbackConfiguration Amazon.CodeDeploy.Model.AutoRollbackConfiguration

Gets and sets the property AutoRollbackConfiguration.

Information about the automatic rollback configuration associated with the deployment.

Public Property BlueGreenDeploymentConfiguration Amazon.CodeDeploy.Model.BlueGreenDeploymentConfiguration

Gets and sets the property BlueGreenDeploymentConfiguration.

Information about blue/green deployment options for this deployment.

Public Property CompleteTime System.DateTime

Gets and sets the property CompleteTime.

A timestamp that indicates when the deployment was complete.

Public Property ComputePlatform Amazon.CodeDeploy.ComputePlatform

Gets and sets the property ComputePlatform.

The destination platform type for the deployment (Lambda, Server, or ECS).

Public Property CreateTime System.DateTime

Gets and sets the property CreateTime.

A timestamp that indicates when the deployment was created.

Public Property Creator Amazon.CodeDeploy.DeploymentCreator

Gets and sets the property Creator.

The means by which the deployment was created:

  • user: A user created the deployment.

  • autoscaling: Amazon EC2 Auto Scaling created the deployment.

  • codeDeployRollback: A rollback process created the deployment.

  • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

Public Property DeploymentConfigName System.String

Gets and sets the property DeploymentConfigName.

The deployment configuration name.

Public Property DeploymentGroupName System.String

Gets and sets the property DeploymentGroupName.

The deployment group name.

Public Property DeploymentId System.String

Gets and sets the property DeploymentId.

The unique ID of a deployment.

Public Property DeploymentOverview Amazon.CodeDeploy.Model.DeploymentOverview

Gets and sets the property DeploymentOverview.

A summary of the deployment status of the instances in the deployment.

Public Property DeploymentStatusMessages System.Collections.Generic.List<System.String>

Gets and sets the property DeploymentStatusMessages.

Messages that contain information about the status of a deployment.

Public Property DeploymentStyle Amazon.CodeDeploy.Model.DeploymentStyle

Gets and sets the property DeploymentStyle.

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

Public Property Description System.String

Gets and sets the property Description.

A comment about the deployment.

Public Property ErrorInformation Amazon.CodeDeploy.Model.ErrorInformation

Gets and sets the property ErrorInformation.

Information about any error associated with this deployment.

Public Property ExternalId System.String

Gets and sets the property ExternalId.

The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

Public Property FileExistsBehavior Amazon.CodeDeploy.FileExistsBehavior

Gets and sets the property FileExistsBehavior.

Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

Public Property IgnoreApplicationStopFailures System.Boolean

Gets and sets the property 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. 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 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.

Public Property InstanceTerminationWaitTimeStarted System.Boolean

Gets and sets the property InstanceTerminationWaitTimeStarted.

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

Public Property LoadBalancerInfo Amazon.CodeDeploy.Model.LoadBalancerInfo

Gets and sets the property LoadBalancerInfo.

Information about the load balancer used in the deployment.

Public Property OverrideAlarmConfiguration Amazon.CodeDeploy.Model.AlarmConfiguration

Gets and sets the property OverrideAlarmConfiguration.

Public Property PreviousRevision Amazon.CodeDeploy.Model.RevisionLocation

Gets and sets the property PreviousRevision.

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

Public Property RelatedDeployments Amazon.CodeDeploy.Model.RelatedDeployments

Gets and sets the property RelatedDeployments.

Public Property Revision Amazon.CodeDeploy.Model.RevisionLocation

Gets and sets the property Revision.

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

Public Property RollbackInfo Amazon.CodeDeploy.Model.RollbackInfo

Gets and sets the property RollbackInfo.

Information about a deployment rollback.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

Public Property Status Amazon.CodeDeploy.DeploymentStatus

Gets and sets the property Status.

The current state of the deployment as a whole.

Public Property TargetInstances Amazon.CodeDeploy.Model.TargetInstances

Gets and sets the property TargetInstances.

Information about the instances that belong to the replacement environment in a blue/green deployment.

Public Property UpdateOutdatedInstancesOnly System.Boolean

Gets and sets the property UpdateOutdatedInstancesOnly.

Indicates whether only instances that are not running the latest application revision are to be deployed to.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5