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

Class CreateDeploymentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codedeploy.model.CodeDeployRequest

software.amazon.awssdk.services.codedeploy.model.CreateDeploymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDeploymentRequest
extends CodeDeployRequest
implements ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Represents the input of a CreateDeployment operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDeploymentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of an CodeDeploy application associated with the user or Amazon Web Services account.
AutoRollbackConfiguration	autoRollbackConfiguration()	Configuration information for an automatic rollback that is added when a deployment is created.
static CreateDeploymentRequest.Builder	builder()
String	deploymentConfigName()	The name of a deployment configuration associated with the user or Amazon Web Services account.
String	deploymentGroupName()	The name of the deployment group.
String	description()	A comment about the deployment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
String	fileExistsBehaviorAsString()	Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
AlarmConfiguration	overrideAlarmConfiguration()	Allows you to specify information about alarms associated with a deployment.
RevisionLocation	revision()	The type and location of the revision to deploy.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentRequest.Builder>	serializableBuilderClass()
TargetInstances	targetInstances()	Information about the instances that belong to the replacement environment in a blue/green deployment.
CreateDeploymentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	updateOutdatedInstancesOnly()	Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationName

public final String applicationName()

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

Returns:

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

deploymentGroupName

public final String deploymentGroupName()

The name of the deployment group.

Returns:

The name of the deployment group.

revision

public final RevisionLocation revision()

The type and location of the revision to deploy.

Returns:

The type and location of the revision to deploy.

deploymentConfigName

public final String deploymentConfigName()

The name of a deployment configuration associated with the user or Amazon Web Services 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:

The name of a deployment configuration associated with the user or Amazon Web Services 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.

description

public final String description()

A comment about the deployment.

Returns:

A comment about the deployment.

ignoreApplicationStopFailures

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

Returns:

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.

targetInstances

public final TargetInstances targetInstances()

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

Returns:

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

autoRollbackConfiguration

public final AutoRollbackConfiguration autoRollbackConfiguration()

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

Returns:

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

updateOutdatedInstancesOnly

public final Boolean updateOutdatedInstancesOnly()

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

Returns:

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

fileExistsBehavior

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

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.

If the service returns an enum value that is not available in the current SDK version, fileExistsBehavior will return FileExistsBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileExistsBehaviorAsString().

Returns:

Information about how 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.

See Also:

FileExistsBehavior

fileExistsBehaviorAsString

public final String fileExistsBehaviorAsString()

Information about how 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.

If the service returns an enum value that is not available in the current SDK version, fileExistsBehavior will return FileExistsBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileExistsBehaviorAsString().

Returns:

Information about how 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.

See Also:

FileExistsBehavior

overrideAlarmConfiguration

public final AlarmConfiguration overrideAlarmConfiguration()

Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

Returns:

Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

toBuilder

public CreateDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Specified by:

toBuilder in class CodeDeployRequest

builder

public static CreateDeploymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDeploymentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo