Package software.amazon.awssdk.services.codedeploy.model

Interface DeploymentInfo.Builder

All Superinterfaces:

CopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>, SdkBuilder<DeploymentInfo.Builder,DeploymentInfo>

Enclosing class:

DeploymentInfo

public static interface DeploymentInfo.Builder
extends CopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>

Method Summary

Modifier and Type	Method	Description
DeploymentInfo.Builder	additionalDeploymentStatusInfo(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.Builder	applicationName(String applicationName)	The application name.
DeploymentInfo.Builder	autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)	Information about the automatic rollback configuration associated with the deployment.
DeploymentInfo.Builder	blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)	Information about blue/green deployment options for this deployment.
DeploymentInfo.Builder	completeTime(Date completeTime)	A timestamp indicating when the deployment was complete.
DeploymentInfo.Builder	createTime(Date createTime)	A timestamp indicating when the deployment was created.
DeploymentInfo.Builder	creator(String creator)	The means by which the deployment was created:
DeploymentInfo.Builder	creator(DeploymentCreator creator)	The means by which the deployment was created:
DeploymentInfo.Builder	deploymentConfigName(String deploymentConfigName)	The deployment configuration name.
DeploymentInfo.Builder	deploymentGroupName(String deploymentGroupName)	The deployment group name.
DeploymentInfo.Builder	deploymentId(String deploymentId)	The deployment ID.
DeploymentInfo.Builder	deploymentOverview(DeploymentOverview deploymentOverview)	A summary of the deployment status of the instances in the deployment.
DeploymentInfo.Builder	deploymentStyle(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.Builder	description(String description)	A comment about the deployment.
DeploymentInfo.Builder	errorInformation(ErrorInformation errorInformation)	Information about any error associated with this deployment.
DeploymentInfo.Builder	fileExistsBehavior(String 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.
DeploymentInfo.Builder	fileExistsBehavior(FileExistsBehavior 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.
DeploymentInfo.Builder	ignoreApplicationStopFailures(Boolean 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.
DeploymentInfo.Builder	instanceTerminationWaitTimeStarted(Boolean instanceTerminationWaitTimeStarted)	Indicates whether the wait period set for the termination of instances in the original environment has started.
DeploymentInfo.Builder	loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)	Information about the load balancer used in the deployment.
DeploymentInfo.Builder	previousRevision(RevisionLocation previousRevision)	Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
DeploymentInfo.Builder	revision(RevisionLocation revision)	Information about the location of stored application artifacts and the service from which to retrieve them.
DeploymentInfo.Builder	rollbackInfo(RollbackInfo rollbackInfo)	Information about a deployment rollback.
DeploymentInfo.Builder	startTime(Date startTime)	A timestamp indicating when the deployment was deployed to the deployment group.
DeploymentInfo.Builder	status(String status)	The current state of the deployment as a whole.
DeploymentInfo.Builder	status(DeploymentStatus status)	The current state of the deployment as a whole.
DeploymentInfo.Builder	targetInstances(TargetInstances targetInstances)	Information about the instances that belong to the replacement environment in a blue/green deployment.
DeploymentInfo.Builder	updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)	Indicates whether only instances that are not running the latest application revision are to be deployed to.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

applicationName

DeploymentInfo.Builder applicationName(String applicationName)

The application name.

Parameters:

applicationName - The application name.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentGroupName

DeploymentInfo.Builder deploymentGroupName(String deploymentGroupName)

The deployment group name.

Parameters:

deploymentGroupName - The deployment group name.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentConfigName

DeploymentInfo.Builder deploymentConfigName(String deploymentConfigName)

The deployment configuration name.

Parameters:

deploymentConfigName - The deployment configuration name.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentId

DeploymentInfo.Builder deploymentId(String deploymentId)

The deployment ID.

Parameters:

deploymentId - The deployment ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

previousRevision

DeploymentInfo.Builder previousRevision(RevisionLocation previousRevision)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

revision

DeploymentInfo.Builder revision(RevisionLocation revision)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

DeploymentInfo.Builder status(String status)

The current state of the deployment as a whole.

Parameters:

status - The current state of the deployment as a whole.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentStatus

status

DeploymentInfo.Builder status(DeploymentStatus status)

The current state of the deployment as a whole.

Parameters:

status - The current state of the deployment as a whole.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentStatus

errorInformation

DeploymentInfo.Builder errorInformation(ErrorInformation errorInformation)

Information about any error associated with this deployment.

Parameters:

errorInformation - Information about any error associated with this deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

createTime

DeploymentInfo.Builder createTime(Date createTime)

A timestamp indicating when the deployment was created.

Parameters:

createTime - A timestamp indicating when the deployment was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

DeploymentInfo.Builder startTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

completeTime

DeploymentInfo.Builder completeTime(Date completeTime)

A timestamp indicating when the deployment was complete.

Parameters:

completeTime - A timestamp indicating when the deployment was complete.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentOverview

DeploymentInfo.Builder deploymentOverview(DeploymentOverview deploymentOverview)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

description

DeploymentInfo.Builder description(String description)

A comment about the deployment.

Parameters:

description - A comment about the deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

creator

DeploymentInfo.Builder creator(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentCreator

creator

DeploymentInfo.Builder creator(DeploymentCreator 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeploymentCreator

ignoreApplicationStopFailures

DeploymentInfo.Builder ignoreApplicationStopFailures(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoRollbackConfiguration

DeploymentInfo.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

Information about the automatic rollback configuration associated with the deployment.

Parameters:

autoRollbackConfiguration - Information about the automatic rollback configuration associated with the deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

updateOutdatedInstancesOnly

DeploymentInfo.Builder updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

rollbackInfo

DeploymentInfo.Builder rollbackInfo(RollbackInfo rollbackInfo)

Information about a deployment rollback.

Parameters:

rollbackInfo - Information about a deployment rollback.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentStyle

DeploymentInfo.Builder deploymentStyle(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetInstances

DeploymentInfo.Builder targetInstances(TargetInstances targetInstances)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceTerminationWaitTimeStarted

DeploymentInfo.Builder instanceTerminationWaitTimeStarted(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

blueGreenDeploymentConfiguration

DeploymentInfo.Builder blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)

Information about blue/green deployment options for this deployment.

Parameters:

blueGreenDeploymentConfiguration - Information about blue/green deployment options for this deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

loadBalancerInfo

DeploymentInfo.Builder loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)

Information about the load balancer used in the deployment.

Parameters:

loadBalancerInfo - Information about the load balancer used in the deployment.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalDeploymentStatusInfo

DeploymentInfo.Builder additionalDeploymentStatusInfo(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileExistsBehavior

DeploymentInfo.Builder fileExistsBehavior(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileExistsBehavior

fileExistsBehavior

DeploymentInfo.Builder fileExistsBehavior(FileExistsBehavior 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileExistsBehavior