software.amazon.awssdk.services.codedeploy.model

Interface CreateDeploymentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodeDeployRequest.Builder, CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDeploymentRequest

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

Method Summary

Modifier and Type	Method and Description
CreateDeploymentRequest.Builder	applicationName(String applicationName) The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
CreateDeploymentRequest.Builder	autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment is created.
default CreateDeploymentRequest.Builder	autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> 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 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(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	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	ignoreApplicationStopFailures(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.
CreateDeploymentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDeploymentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateDeploymentRequest.Builder	revision(Consumer<RevisionLocation.Builder> revision) The type and location of the revision to deploy.
CreateDeploymentRequest.Builder	revision(RevisionLocation revision) The type and location of the revision to deploy.
default CreateDeploymentRequest.Builder	targetInstances(Consumer<TargetInstances.Builder> targetInstances) Information about the instances that belong to the replacement environment in a blue/green deployment.
CreateDeploymentRequest.Builder	targetInstances(TargetInstances targetInstances) Information about the instances that 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.services.codedeploy.model.CodeDeployRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

applicationName

CreateDeploymentRequest.Builder applicationName(String applicationName)

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

Parameters:

applicationName - The name of an AWS CodeDeploy application associated with the 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.

revision

default CreateDeploymentRequest.Builder revision(Consumer<RevisionLocation.Builder> revision)

The type and location of the revision to deploy.

This is a convenience that creates an instance of the RevisionLocation.Builder avoiding the need to create one manually via RevisionLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to revision(RevisionLocation).

Parameters:

revision - a consumer that will call methods on RevisionLocation.Builder

Returns:

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

See Also:

revision(RevisionLocation)

deploymentConfigName

CreateDeploymentRequest.Builder deploymentConfigName(String deploymentConfigName)

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

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

Parameters:

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

If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is 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 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 AWS 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.

Parameters:

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

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

targetInstances

default CreateDeploymentRequest.Builder targetInstances(Consumer<TargetInstances.Builder> targetInstances)

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

This is a convenience that creates an instance of the TargetInstances.Builder avoiding the need to create one manually via TargetInstances.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetInstances(TargetInstances).

Parameters:

targetInstances - a consumer that will call methods on TargetInstances.Builder

Returns:

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

See Also:

targetInstances(TargetInstances)

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.

autoRollbackConfiguration

default CreateDeploymentRequest.Builder autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> autoRollbackConfiguration)

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

This is a convenience that creates an instance of the AutoRollbackConfiguration.Builder avoiding the need to create one manually via AutoRollbackConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoRollbackConfiguration(AutoRollbackConfiguration).

Parameters:

autoRollbackConfiguration - a consumer that will call methods on AutoRollbackConfiguration.Builder

Returns:

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

See Also:

autoRollbackConfiguration(AutoRollbackConfiguration)

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

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, FileExistsBehavior

overrideConfiguration

CreateDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDeploymentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder