@Generated(value="software.amazon.awssdk:codegen") public final class CreateDeploymentRequest extends CodeDeployRequest implements ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>
Represents the input of a CreateDeployment
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDeploymentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
applicationName()
The name of an AWS CodeDeploy application associated with the IAM user or AWS 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 IAM user or AWS account.
|
String |
deploymentGroupName()
The name of the deployment group.
|
String |
description()
A comment about the deployment.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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.
|
String |
fileExistsBehaviorAsString()
Information about how AWS 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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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. |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
overrideConfiguration
copy
public final String applicationName()
The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
public final String deploymentGroupName()
The name of the deployment group.
public final RevisionLocation revision()
The type and location of the revision to deploy.
public final 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.
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.
public final String description()
A comment about the deployment.
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 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.
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.
public final TargetInstances targetInstances()
Information about the instances that belong to the replacement environment in a blue/green deployment.
public final AutoRollbackConfiguration autoRollbackConfiguration()
Configuration information for an automatic rollback that is added when a deployment is created.
public final Boolean updateOutdatedInstancesOnly()
Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
public final 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.
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()
.
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.
FileExistsBehavior
public final String fileExistsBehaviorAsString()
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.
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()
.
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.
FileExistsBehavior
public CreateDeploymentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>
toBuilder
in class CodeDeployRequest
public static CreateDeploymentRequest.Builder builder()
public static Class<? extends CreateDeploymentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.