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 indicating when the deployment was complete.

Public Property CreateTime System.DateTime

Gets and sets the property CreateTime.

A timestamp indicating 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: Auto Scaling created the deployment.

  • codeDeployRollback: A rollback process created the deployment.

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 deployment ID.

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 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 FileExistsBehavior Amazon.CodeDeploy.FileExistsBehavior

Gets and sets the property FileExistsBehavior.

Information about how AWS 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 the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.

If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

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 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 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 indicating when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end 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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms