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

Interface CreateDeploymentRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Enclosing class:

CreateDeploymentRequest

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

Method Summary

Modifier and Type	Method	Description
CreateDeploymentRequest.Builder	applicationName(String applicationName)	The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
CreateDeploymentRequest.Builder	autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)	Configuration information for an automatic rollback that is added when a deployment is created.
CreateDeploymentRequest.Builder	deploymentConfigName(String deploymentConfigName)	The name of a deployment configuration associated with the applicable IAM user or AWS account.
CreateDeploymentRequest.Builder	deploymentGroupName(String deploymentGroupName)	The name of the deployment group.
CreateDeploymentRequest.Builder	description(String description)	A comment about the deployment.
CreateDeploymentRequest.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.
CreateDeploymentRequest.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.
CreateDeploymentRequest.Builder	ignoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)	If set to 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.
CreateDeploymentRequest.Builder	revision(RevisionLocation revision)	The type and location of the revision to deploy.
CreateDeploymentRequest.Builder	targetInstances(TargetInstances targetInstances)	Information about the instances that will belong to the replacement environment in a blue/green deployment.
CreateDeploymentRequest.Builder	updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)	Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

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

CreateDeploymentRequest.Builder applicationName(String applicationName)

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Parameters:

applicationName - The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

Returns:

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

deploymentGroupName

CreateDeploymentRequest.Builder deploymentGroupName(String deploymentGroupName)

The name of the deployment group.

Parameters:

deploymentGroupName - The name of the deployment group.

Returns:

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

revision

CreateDeploymentRequest.Builder revision(RevisionLocation revision)

The type and location of the revision to deploy.

Parameters:

revision - The type and location of the revision to deploy.

Returns:

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

deploymentConfigName

CreateDeploymentRequest.Builder deploymentConfigName(String deploymentConfigName)

The name of a deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

Parameters:

deploymentConfigName - The name of a deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

Returns:

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

description

CreateDeploymentRequest.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.

ignoreApplicationStopFailures

CreateDeploymentRequest.Builder ignoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)

If set to 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 set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

Parameters:

ignoreApplicationStopFailures - If set to 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 set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, 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.

targetInstances

CreateDeploymentRequest.Builder targetInstances(TargetInstances targetInstances)

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

Parameters:

targetInstances - Information about the instances that will 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.

autoRollbackConfiguration

CreateDeploymentRequest.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

Configuration information for an automatic rollback that is added when a deployment is created.

Parameters:

autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment is created.

Returns:

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

updateOutdatedInstancesOnly

CreateDeploymentRequest.Builder updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

Parameters:

updateOutdatedInstancesOnly - Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

Returns:

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

fileExistsBehavior

CreateDeploymentRequest.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.

The fileExistsBehavior parameter takes any of the following values:

• 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.

The fileExistsBehavior parameter takes any of the following values:

• 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

CreateDeploymentRequest.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.

The fileExistsBehavior parameter takes any of the following values:

• 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.

The fileExistsBehavior parameter takes any of the following values:

• 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