@Generated(value="software.amazon.awssdk:codegen") public class DeploymentInfo extends Object implements StructuredPojo, ToCopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>
Information about a deployment.
Modifier and Type | Class and Description |
---|---|
static interface |
DeploymentInfo.Builder |
Modifier and Type | Method and Description |
---|---|
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.
|
String |
applicationName()
The application name.
|
AutoRollbackConfiguration |
autoRollbackConfiguration()
Information about the automatic rollback configuration associated with the deployment.
|
BlueGreenDeploymentConfiguration |
blueGreenDeploymentConfiguration()
Information about blue/green deployment options for this deployment.
|
static DeploymentInfo.Builder |
builder() |
Instant |
completeTime()
A timestamp indicating when the deployment was complete.
|
Instant |
createTime()
A timestamp indicating when the deployment was created.
|
DeploymentCreator |
creator()
The means by which the deployment was created:
|
String |
creatorString()
The means by which the deployment was created:
|
String |
deploymentConfigName()
The deployment configuration name.
|
String |
deploymentGroupName()
The deployment group name.
|
String |
deploymentId()
The deployment ID.
|
DeploymentOverview |
deploymentOverview()
A summary of the deployment status of the instances in the deployment.
|
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.
|
String |
description()
A comment about the deployment.
|
boolean |
equals(Object obj) |
ErrorInformation |
errorInformation()
Information about any error associated with this deployment.
|
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 |
fileExistsBehaviorString()
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) |
int |
hashCode() |
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.
|
Boolean |
instanceTerminationWaitTimeStarted()
Indicates whether the wait period set for the termination of instances in the original environment has started.
|
LoadBalancerInfo |
loadBalancerInfo()
Information about the load balancer used in the deployment.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
RevisionLocation |
previousRevision()
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
RevisionLocation |
revision()
Information about the location of stored application artifacts and the service from which to retrieve them.
|
RollbackInfo |
rollbackInfo()
Information about a deployment rollback.
|
static Class<? extends DeploymentInfo.Builder> |
serializableBuilderClass() |
Instant |
startTime()
A timestamp indicating when the deployment was deployed to the deployment group.
|
DeploymentStatus |
status()
The current state of the deployment as a whole.
|
String |
statusString()
The current state of the deployment as a whole.
|
TargetInstances |
targetInstances()
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
DeploymentInfo.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
updateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
copy
public String applicationName()
The application name.
public String deploymentGroupName()
The deployment group name.
public String deploymentConfigName()
The deployment configuration name.
public String deploymentId()
The deployment ID.
public RevisionLocation previousRevision()
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
public RevisionLocation revision()
Information about the location of stored application artifacts and the service from which to retrieve them.
public DeploymentStatus status()
The current state of the deployment as a whole.
If the service returns an enum value that is not available in the current SDK version, status
will
return DeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
DeploymentStatus
public String statusString()
The current state of the deployment as a whole.
If the service returns an enum value that is not available in the current SDK version, status
will
return DeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
DeploymentStatus
public ErrorInformation errorInformation()
Information about any error associated with this deployment.
public Instant createTime()
A timestamp indicating when the deployment was created.
public Instant 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.
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.
public Instant completeTime()
A timestamp indicating when the deployment was complete.
public DeploymentOverview deploymentOverview()
A summary of the deployment status of the instances in the deployment.
public String description()
A comment about the deployment.
public 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.
If the service returns an enum value that is not available in the current SDK version, creator
will
return DeploymentCreator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
creatorString()
.
user: A user created the deployment.
autoscaling: Auto Scaling created the deployment.
codeDeployRollback: A rollback process created the deployment.
DeploymentCreator
public String creatorString()
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.
If the service returns an enum value that is not available in the current SDK version, creator
will
return DeploymentCreator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
creatorString()
.
user: A user created the deployment.
autoscaling: Auto Scaling created the deployment.
codeDeployRollback: A rollback process created the deployment.
DeploymentCreator
public 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.
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.
public AutoRollbackConfiguration autoRollbackConfiguration()
Information about the automatic rollback configuration associated with the deployment.
public Boolean updateOutdatedInstancesOnly()
Indicates whether only instances that are not running the latest application revision are to be deployed to.
public RollbackInfo rollbackInfo()
Information about a deployment rollback.
public 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.
public TargetInstances targetInstances()
Information about the instances that belong to the replacement environment in a blue/green deployment.
public 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.
public BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration()
Information about blue/green deployment options for this deployment.
public LoadBalancerInfo loadBalancerInfo()
Information about the load balancer used in the deployment.
public 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.
public 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.
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 fileExistsBehaviorString()
.
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 String fileExistsBehaviorString()
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.
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 fileExistsBehaviorString()
.
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 DeploymentInfo.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>
public static DeploymentInfo.Builder builder()
public static Class<? extends DeploymentInfo.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.