@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeploymentInfo extends Object implements Serializable, Cloneable, StructuredPojo
Information about a deployment.
Constructor and Description |
---|
DeploymentInfo() |
Modifier and Type | Method and Description |
---|---|
DeploymentInfo |
clone() |
boolean |
equals(Object obj) |
String |
getAdditionalDeploymentStatusInfo()
Provides information about the results of a deployment, such as whether instances in the original environment in
a blue/green deployment were not terminated.
|
String |
getApplicationName()
The application name.
|
AutoRollbackConfiguration |
getAutoRollbackConfiguration()
Information about the automatic rollback configuration associated with the deployment.
|
BlueGreenDeploymentConfiguration |
getBlueGreenDeploymentConfiguration()
Information about blue/green deployment options for this deployment.
|
Date |
getCompleteTime()
A timestamp that indicates when the deployment was complete.
|
String |
getComputePlatform()
The destination platform type for the deployment (
Lambda , Server , or ECS ). |
Date |
getCreateTime()
A timestamp that indicates when the deployment was created.
|
String |
getCreator()
The means by which the deployment was created:
|
String |
getDeploymentConfigName()
The deployment configuration name.
|
String |
getDeploymentGroupName()
The deployment group name.
|
String |
getDeploymentId()
The unique ID of a deployment.
|
DeploymentOverview |
getDeploymentOverview()
A summary of the deployment status of the instances in the deployment.
|
List<String> |
getDeploymentStatusMessages()
Messages that contain information about the status of a deployment.
|
DeploymentStyle |
getDeploymentStyle()
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.
|
String |
getDescription()
A comment about the deployment.
|
ErrorInformation |
getErrorInformation()
Information about any error associated with this deployment.
|
String |
getExternalId()
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this
deployment.
|
String |
getFileExistsBehavior()
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't
part of the previous successful deployment.
|
Boolean |
getIgnoreApplicationStopFailures()
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. |
Boolean |
getInstanceTerminationWaitTimeStarted()
Indicates whether the wait period set for the termination of instances in the original environment has started.
|
LoadBalancerInfo |
getLoadBalancerInfo()
Information about the load balancer used in the deployment.
|
AlarmConfiguration |
getOverrideAlarmConfiguration() |
RevisionLocation |
getPreviousRevision()
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
RelatedDeployments |
getRelatedDeployments() |
RevisionLocation |
getRevision()
Information about the location of stored application artifacts and the service from which to retrieve them.
|
RollbackInfo |
getRollbackInfo()
Information about a deployment rollback.
|
Date |
getStartTime()
A timestamp that indicates when the deployment was deployed to the deployment group.
|
String |
getStatus()
The current state of the deployment as a whole.
|
TargetInstances |
getTargetInstances()
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
Boolean |
getUpdateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
int |
hashCode() |
Boolean |
isIgnoreApplicationStopFailures()
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. |
Boolean |
isInstanceTerminationWaitTimeStarted()
Indicates whether the wait period set for the termination of instances in the original environment has started.
|
Boolean |
isUpdateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalDeploymentStatusInfo(String 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.
|
void |
setApplicationName(String applicationName)
The application name.
|
void |
setAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
|
void |
setBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
|
void |
setCompleteTime(Date completeTime)
A timestamp that indicates when the deployment was complete.
|
void |
setComputePlatform(ComputePlatform computePlatform)
The destination platform type for the deployment (
Lambda , Server , or ECS ). |
void |
setComputePlatform(String computePlatform)
The destination platform type for the deployment (
Lambda , Server , or ECS ). |
void |
setCreateTime(Date createTime)
A timestamp that indicates when the deployment was created.
|
void |
setCreator(DeploymentCreator creator)
The means by which the deployment was created:
|
void |
setCreator(String creator)
The means by which the deployment was created:
|
void |
setDeploymentConfigName(String deploymentConfigName)
The deployment configuration name.
|
void |
setDeploymentGroupName(String deploymentGroupName)
The deployment group name.
|
void |
setDeploymentId(String deploymentId)
The unique ID of a deployment.
|
void |
setDeploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
|
void |
setDeploymentStatusMessages(Collection<String> deploymentStatusMessages)
Messages that contain information about the status of a deployment.
|
void |
setDeploymentStyle(DeploymentStyle 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.
|
void |
setDescription(String description)
A comment about the deployment.
|
void |
setErrorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
|
void |
setExternalId(String externalId)
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this
deployment.
|
void |
setFileExistsBehavior(FileExistsBehavior fileExistsBehavior)
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't
part of the previous successful deployment.
|
void |
setFileExistsBehavior(String fileExistsBehavior)
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't
part of the previous successful deployment.
|
void |
setIgnoreApplicationStopFailures(Boolean 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. |
void |
setInstanceTerminationWaitTimeStarted(Boolean instanceTerminationWaitTimeStarted)
Indicates whether the wait period set for the termination of instances in the original environment has started.
|
void |
setLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
|
void |
setOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration) |
void |
setPreviousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
void |
setRelatedDeployments(RelatedDeployments relatedDeployments) |
void |
setRevision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
|
void |
setRollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
|
void |
setStartTime(Date startTime)
A timestamp that indicates when the deployment was deployed to the deployment group.
|
void |
setStatus(DeploymentStatus status)
The current state of the deployment as a whole.
|
void |
setStatus(String status)
The current state of the deployment as a whole.
|
void |
setTargetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
void |
setUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
String |
toString()
Returns a string representation of this object.
|
DeploymentInfo |
withAdditionalDeploymentStatusInfo(String 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.
|
DeploymentInfo |
withApplicationName(String applicationName)
The application name.
|
DeploymentInfo |
withAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
|
DeploymentInfo |
withBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
|
DeploymentInfo |
withCompleteTime(Date completeTime)
A timestamp that indicates when the deployment was complete.
|
DeploymentInfo |
withComputePlatform(ComputePlatform computePlatform)
The destination platform type for the deployment (
Lambda , Server , or ECS ). |
DeploymentInfo |
withComputePlatform(String computePlatform)
The destination platform type for the deployment (
Lambda , Server , or ECS ). |
DeploymentInfo |
withCreateTime(Date createTime)
A timestamp that indicates when the deployment was created.
|
DeploymentInfo |
withCreator(DeploymentCreator creator)
The means by which the deployment was created:
|
DeploymentInfo |
withCreator(String creator)
The means by which the deployment was created:
|
DeploymentInfo |
withDeploymentConfigName(String deploymentConfigName)
The deployment configuration name.
|
DeploymentInfo |
withDeploymentGroupName(String deploymentGroupName)
The deployment group name.
|
DeploymentInfo |
withDeploymentId(String deploymentId)
The unique ID of a deployment.
|
DeploymentInfo |
withDeploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
|
DeploymentInfo |
withDeploymentStatusMessages(Collection<String> deploymentStatusMessages)
Messages that contain information about the status of a deployment.
|
DeploymentInfo |
withDeploymentStatusMessages(String... deploymentStatusMessages)
Messages that contain information about the status of a deployment.
|
DeploymentInfo |
withDeploymentStyle(DeploymentStyle 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.
|
DeploymentInfo |
withDescription(String description)
A comment about the deployment.
|
DeploymentInfo |
withErrorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
|
DeploymentInfo |
withExternalId(String externalId)
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this
deployment.
|
DeploymentInfo |
withFileExistsBehavior(FileExistsBehavior fileExistsBehavior)
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't
part of the previous successful deployment.
|
DeploymentInfo |
withFileExistsBehavior(String fileExistsBehavior)
Information about how CodeDeploy handles files that already exist in a deployment target location but weren't
part of the previous successful deployment.
|
DeploymentInfo |
withIgnoreApplicationStopFailures(Boolean 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. |
DeploymentInfo |
withInstanceTerminationWaitTimeStarted(Boolean instanceTerminationWaitTimeStarted)
Indicates whether the wait period set for the termination of instances in the original environment has started.
|
DeploymentInfo |
withLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
|
DeploymentInfo |
withOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration) |
DeploymentInfo |
withPreviousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
DeploymentInfo |
withRelatedDeployments(RelatedDeployments relatedDeployments) |
DeploymentInfo |
withRevision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
|
DeploymentInfo |
withRollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
|
DeploymentInfo |
withStartTime(Date startTime)
A timestamp that indicates when the deployment was deployed to the deployment group.
|
DeploymentInfo |
withStatus(DeploymentStatus status)
The current state of the deployment as a whole.
|
DeploymentInfo |
withStatus(String status)
The current state of the deployment as a whole.
|
DeploymentInfo |
withTargetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
DeploymentInfo |
withUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
public void setApplicationName(String applicationName)
The application name.
applicationName
- The application name.public String getApplicationName()
The application name.
public DeploymentInfo withApplicationName(String applicationName)
The application name.
applicationName
- The application name.public void setDeploymentGroupName(String deploymentGroupName)
The deployment group name.
deploymentGroupName
- The deployment group name.public String getDeploymentGroupName()
The deployment group name.
public DeploymentInfo withDeploymentGroupName(String deploymentGroupName)
The deployment group name.
deploymentGroupName
- The deployment group name.public void setDeploymentConfigName(String deploymentConfigName)
The deployment configuration name.
deploymentConfigName
- The deployment configuration name.public String getDeploymentConfigName()
The deployment configuration name.
public DeploymentInfo withDeploymentConfigName(String deploymentConfigName)
The deployment configuration name.
deploymentConfigName
- The deployment configuration name.public void setDeploymentId(String deploymentId)
The unique ID of a deployment.
deploymentId
- The unique ID of a deployment.public String getDeploymentId()
The unique ID of a deployment.
public DeploymentInfo withDeploymentId(String deploymentId)
The unique ID of a deployment.
deploymentId
- The unique ID of a deployment.public void setPreviousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
previousRevision
- Information about the application revision that was deployed to the deployment group before the most
recent successful deployment.public RevisionLocation getPreviousRevision()
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
public DeploymentInfo withPreviousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
previousRevision
- Information about the application revision that was deployed to the deployment group before the most
recent successful deployment.public void setRevision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
revision
- Information about the location of stored application artifacts and the service from which to retrieve
them.public RevisionLocation getRevision()
Information about the location of stored application artifacts and the service from which to retrieve them.
public DeploymentInfo withRevision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
revision
- Information about the location of stored application artifacts and the service from which to retrieve
them.public void setStatus(String status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
public String getStatus()
The current state of the deployment as a whole.
DeploymentStatus
public DeploymentInfo withStatus(String status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
public void setStatus(DeploymentStatus status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
public DeploymentInfo withStatus(DeploymentStatus status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
public void setErrorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
errorInformation
- Information about any error associated with this deployment.public ErrorInformation getErrorInformation()
Information about any error associated with this deployment.
public DeploymentInfo withErrorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
errorInformation
- Information about any error associated with this deployment.public void setCreateTime(Date createTime)
A timestamp that indicates when the deployment was created.
createTime
- A timestamp that indicates when the deployment was created.public Date getCreateTime()
A timestamp that indicates when the deployment was created.
public DeploymentInfo withCreateTime(Date createTime)
A timestamp that indicates when the deployment was created.
createTime
- A timestamp that indicates when the deployment was created.public void setStartTime(Date 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.
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 Date getStartTime()
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.
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 DeploymentInfo withStartTime(Date 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.
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 void setCompleteTime(Date completeTime)
A timestamp that indicates when the deployment was complete.
completeTime
- A timestamp that indicates when the deployment was complete.public Date getCompleteTime()
A timestamp that indicates when the deployment was complete.
public DeploymentInfo withCompleteTime(Date completeTime)
A timestamp that indicates when the deployment was complete.
completeTime
- A timestamp that indicates when the deployment was complete.public void setDeploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
deploymentOverview
- A summary of the deployment status of the instances in the deployment.public DeploymentOverview getDeploymentOverview()
A summary of the deployment status of the instances in the deployment.
public DeploymentInfo withDeploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
deploymentOverview
- A summary of the deployment status of the instances in the deployment.public void setDescription(String description)
A comment about the deployment.
description
- A comment about the deployment.public String getDescription()
A comment about the deployment.
public DeploymentInfo withDescription(String description)
A comment about the deployment.
description
- A comment about the deployment.public void setCreator(String 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.
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.
DeploymentCreator
public String getCreator()
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.
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.
DeploymentCreator
public DeploymentInfo withCreator(String 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.
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.
DeploymentCreator
public void setCreator(DeploymentCreator 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.
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.
DeploymentCreator
public DeploymentInfo withCreator(DeploymentCreator 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.
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.
DeploymentCreator
public void setIgnoreApplicationStopFailures(Boolean 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.
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 Boolean getIgnoreApplicationStopFailures()
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.
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 DeploymentInfo withIgnoreApplicationStopFailures(Boolean 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.
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 Boolean isIgnoreApplicationStopFailures()
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.
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 void setAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
autoRollbackConfiguration
- Information about the automatic rollback configuration associated with the deployment.public AutoRollbackConfiguration getAutoRollbackConfiguration()
Information about the automatic rollback configuration associated with the deployment.
public DeploymentInfo withAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
autoRollbackConfiguration
- Information about the automatic rollback configuration associated with the deployment.public void setUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
updateOutdatedInstancesOnly
- Indicates whether only instances that are not running the latest application revision are to be deployed
to.public Boolean getUpdateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
public DeploymentInfo withUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
updateOutdatedInstancesOnly
- Indicates whether only instances that are not running the latest application revision are to be deployed
to.public Boolean isUpdateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
public void setRollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
rollbackInfo
- Information about a deployment rollback.public RollbackInfo getRollbackInfo()
Information about a deployment rollback.
public DeploymentInfo withRollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
rollbackInfo
- Information about a deployment rollback.public void setDeploymentStyle(DeploymentStyle 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.
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 DeploymentStyle getDeploymentStyle()
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 DeploymentInfo withDeploymentStyle(DeploymentStyle 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.
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 void setTargetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
targetInstances
- Information about the instances that belong to the replacement environment in a blue/green deployment.public TargetInstances getTargetInstances()
Information about the instances that belong to the replacement environment in a blue/green deployment.
public DeploymentInfo withTargetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
targetInstances
- Information about the instances that belong to the replacement environment in a blue/green deployment.public void setInstanceTerminationWaitTimeStarted(Boolean 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.
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 Boolean getInstanceTerminationWaitTimeStarted()
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 DeploymentInfo withInstanceTerminationWaitTimeStarted(Boolean 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.
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 Boolean isInstanceTerminationWaitTimeStarted()
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 void setBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
blueGreenDeploymentConfiguration
- Information about blue/green deployment options for this deployment.public BlueGreenDeploymentConfiguration getBlueGreenDeploymentConfiguration()
Information about blue/green deployment options for this deployment.
public DeploymentInfo withBlueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
blueGreenDeploymentConfiguration
- Information about blue/green deployment options for this deployment.public void setLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
loadBalancerInfo
- Information about the load balancer used in the deployment.public LoadBalancerInfo getLoadBalancerInfo()
Information about the load balancer used in the deployment.
public DeploymentInfo withLoadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
loadBalancerInfo
- Information about the load balancer used in the deployment.public void setAdditionalDeploymentStatusInfo(String 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.
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 String getAdditionalDeploymentStatusInfo()
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 DeploymentInfo withAdditionalDeploymentStatusInfo(String 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.
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 void setFileExistsBehavior(String 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.
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.
FileExistsBehavior
public String getFileExistsBehavior()
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.
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.
FileExistsBehavior
public DeploymentInfo withFileExistsBehavior(String 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.
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.
FileExistsBehavior
public void setFileExistsBehavior(FileExistsBehavior 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.
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.
FileExistsBehavior
public DeploymentInfo withFileExistsBehavior(FileExistsBehavior 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.
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.
FileExistsBehavior
public List<String> getDeploymentStatusMessages()
Messages that contain information about the status of a deployment.
public void setDeploymentStatusMessages(Collection<String> deploymentStatusMessages)
Messages that contain information about the status of a deployment.
deploymentStatusMessages
- Messages that contain information about the status of a deployment.public DeploymentInfo withDeploymentStatusMessages(String... deploymentStatusMessages)
Messages that contain information about the status of a deployment.
NOTE: This method appends the values to the existing list (if any). Use
setDeploymentStatusMessages(java.util.Collection)
or
withDeploymentStatusMessages(java.util.Collection)
if you want to override the existing values.
deploymentStatusMessages
- Messages that contain information about the status of a deployment.public DeploymentInfo withDeploymentStatusMessages(Collection<String> deploymentStatusMessages)
Messages that contain information about the status of a deployment.
deploymentStatusMessages
- Messages that contain information about the status of a deployment.public void setComputePlatform(String computePlatform)
The destination platform type for the deployment (Lambda
, Server
, or ECS
).
computePlatform
- The destination platform type for the deployment (Lambda
, Server
, or
ECS
).ComputePlatform
public String getComputePlatform()
The destination platform type for the deployment (Lambda
, Server
, or ECS
).
Lambda
, Server
, or
ECS
).ComputePlatform
public DeploymentInfo withComputePlatform(String computePlatform)
The destination platform type for the deployment (Lambda
, Server
, or ECS
).
computePlatform
- The destination platform type for the deployment (Lambda
, Server
, or
ECS
).ComputePlatform
public void setComputePlatform(ComputePlatform computePlatform)
The destination platform type for the deployment (Lambda
, Server
, or ECS
).
computePlatform
- The destination platform type for the deployment (Lambda
, Server
, or
ECS
).ComputePlatform
public DeploymentInfo withComputePlatform(ComputePlatform computePlatform)
The destination platform type for the deployment (Lambda
, Server
, or ECS
).
computePlatform
- The destination platform type for the deployment (Lambda
, Server
, or
ECS
).ComputePlatform
public void setExternalId(String externalId)
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
externalId
- The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this
deployment.public String getExternalId()
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
public DeploymentInfo withExternalId(String externalId)
The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
externalId
- The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this
deployment.public void setRelatedDeployments(RelatedDeployments relatedDeployments)
relatedDeployments
- public RelatedDeployments getRelatedDeployments()
public DeploymentInfo withRelatedDeployments(RelatedDeployments relatedDeployments)
relatedDeployments
- public void setOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration)
overrideAlarmConfiguration
- public AlarmConfiguration getOverrideAlarmConfiguration()
public DeploymentInfo withOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration)
overrideAlarmConfiguration
- public String toString()
toString
in class Object
Object.toString()
public DeploymentInfo clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.