public static interface DeploymentInfo.Builder extends CopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>
Modifier and Type | Method and Description |
---|---|
DeploymentInfo.Builder |
additionalDeploymentStatusInfo(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.
|
DeploymentInfo.Builder |
applicationName(String applicationName)
The application name.
|
DeploymentInfo.Builder |
autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
|
default DeploymentInfo.Builder |
autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
|
DeploymentInfo.Builder |
blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
|
default DeploymentInfo.Builder |
blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
|
DeploymentInfo.Builder |
completeTime(Instant completeTime)
A timestamp indicating when the deployment was complete.
|
DeploymentInfo.Builder |
createTime(Instant createTime)
A timestamp indicating when the deployment was created.
|
DeploymentInfo.Builder |
creator(DeploymentCreator creator)
The means by which the deployment was created:
|
DeploymentInfo.Builder |
creator(String creator)
The means by which the deployment was created:
|
DeploymentInfo.Builder |
deploymentConfigName(String deploymentConfigName)
The deployment configuration name.
|
DeploymentInfo.Builder |
deploymentGroupName(String deploymentGroupName)
The deployment group name.
|
DeploymentInfo.Builder |
deploymentId(String deploymentId)
The deployment ID.
|
default DeploymentInfo.Builder |
deploymentOverview(Consumer<DeploymentOverview.Builder> deploymentOverview)
A summary of the deployment status of the instances in the deployment.
|
DeploymentInfo.Builder |
deploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
|
default DeploymentInfo.Builder |
deploymentStyle(Consumer<DeploymentStyle.Builder> 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.
|
DeploymentInfo.Builder |
deploymentStyle(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.
|
DeploymentInfo.Builder |
description(String description)
A comment about the deployment.
|
default DeploymentInfo.Builder |
errorInformation(Consumer<ErrorInformation.Builder> errorInformation)
Information about any error associated with this deployment.
|
DeploymentInfo.Builder |
errorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
|
DeploymentInfo.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.
|
DeploymentInfo.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.
|
DeploymentInfo.Builder |
ignoreApplicationStopFailures(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.
|
DeploymentInfo.Builder |
instanceTerminationWaitTimeStarted(Boolean instanceTerminationWaitTimeStarted)
Indicates whether the wait period set for the termination of instances in the original environment has
started.
|
default DeploymentInfo.Builder |
loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo)
Information about the load balancer used in the deployment.
|
DeploymentInfo.Builder |
loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
|
default DeploymentInfo.Builder |
previousRevision(Consumer<RevisionLocation.Builder> previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
DeploymentInfo.Builder |
previousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent
successful deployment.
|
default DeploymentInfo.Builder |
revision(Consumer<RevisionLocation.Builder> revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
|
DeploymentInfo.Builder |
revision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
|
default DeploymentInfo.Builder |
rollbackInfo(Consumer<RollbackInfo.Builder> rollbackInfo)
Information about a deployment rollback.
|
DeploymentInfo.Builder |
rollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
|
DeploymentInfo.Builder |
startTime(Instant startTime)
A timestamp indicating when the deployment was deployed to the deployment group.
|
DeploymentInfo.Builder |
status(DeploymentStatus status)
The current state of the deployment as a whole.
|
DeploymentInfo.Builder |
status(String status)
The current state of the deployment as a whole.
|
default DeploymentInfo.Builder |
targetInstances(Consumer<TargetInstances.Builder> targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
DeploymentInfo.Builder |
targetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
DeploymentInfo.Builder |
updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
|
copy
apply, build
DeploymentInfo.Builder applicationName(String applicationName)
The application name.
applicationName
- The application name.DeploymentInfo.Builder deploymentGroupName(String deploymentGroupName)
The deployment group name.
deploymentGroupName
- The deployment group name.DeploymentInfo.Builder deploymentConfigName(String deploymentConfigName)
The deployment configuration name.
deploymentConfigName
- The deployment configuration name.DeploymentInfo.Builder deploymentId(String deploymentId)
The deployment ID.
deploymentId
- The deployment ID.DeploymentInfo.Builder previousRevision(RevisionLocation previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
previousRevision
- Information about the application revision that was deployed to the deployment group before the most
recent successful deployment.default DeploymentInfo.Builder previousRevision(Consumer<RevisionLocation.Builder> previousRevision)
Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
This is a convenience that creates an instance of theRevisionLocation.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 previousRevision(RevisionLocation)
.previousRevision
- a consumer that will call methods on RevisionLocation.Builder
previousRevision(RevisionLocation)
DeploymentInfo.Builder revision(RevisionLocation revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
revision
- Information about the location of stored application artifacts and the service from which to retrieve
them.default DeploymentInfo.Builder revision(Consumer<RevisionLocation.Builder> revision)
Information about the location of stored application artifacts and the service from which to retrieve them.
This is a convenience that creates an instance of theRevisionLocation.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)
.revision
- a consumer that will call methods on RevisionLocation.Builder
revision(RevisionLocation)
DeploymentInfo.Builder status(String status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
,
DeploymentStatus
DeploymentInfo.Builder status(DeploymentStatus status)
The current state of the deployment as a whole.
status
- The current state of the deployment as a whole.DeploymentStatus
,
DeploymentStatus
DeploymentInfo.Builder errorInformation(ErrorInformation errorInformation)
Information about any error associated with this deployment.
errorInformation
- Information about any error associated with this deployment.default DeploymentInfo.Builder errorInformation(Consumer<ErrorInformation.Builder> errorInformation)
Information about any error associated with this deployment.
This is a convenience that creates an instance of theErrorInformation.Builder
avoiding the need to
create one manually via ErrorInformation.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to errorInformation(ErrorInformation)
.errorInformation
- a consumer that will call methods on ErrorInformation.Builder
errorInformation(ErrorInformation)
DeploymentInfo.Builder createTime(Instant createTime)
A timestamp indicating when the deployment was created.
createTime
- A timestamp indicating when the deployment was created.DeploymentInfo.Builder startTime(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.
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.
DeploymentInfo.Builder completeTime(Instant completeTime)
A timestamp indicating when the deployment was complete.
completeTime
- A timestamp indicating when the deployment was complete.DeploymentInfo.Builder deploymentOverview(DeploymentOverview deploymentOverview)
A summary of the deployment status of the instances in the deployment.
deploymentOverview
- A summary of the deployment status of the instances in the deployment.default DeploymentInfo.Builder deploymentOverview(Consumer<DeploymentOverview.Builder> deploymentOverview)
A summary of the deployment status of the instances in the deployment.
This is a convenience that creates an instance of theDeploymentOverview.Builder
avoiding the need to
create one manually via DeploymentOverview.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to deploymentOverview(DeploymentOverview)
.deploymentOverview
- a consumer that will call methods on DeploymentOverview.Builder
deploymentOverview(DeploymentOverview)
DeploymentInfo.Builder description(String description)
A comment about the deployment.
description
- A comment about the deployment.DeploymentInfo.Builder creator(String 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.
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.
DeploymentCreator
,
DeploymentCreator
DeploymentInfo.Builder creator(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.
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.
DeploymentCreator
,
DeploymentCreator
DeploymentInfo.Builder ignoreApplicationStopFailures(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.
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.
DeploymentInfo.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
autoRollbackConfiguration
- Information about the automatic rollback configuration associated with the deployment.default DeploymentInfo.Builder autoRollbackConfiguration(Consumer<AutoRollbackConfiguration.Builder> autoRollbackConfiguration)
Information about the automatic rollback configuration associated with the deployment.
This is a convenience that creates an instance of theAutoRollbackConfiguration.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)
.autoRollbackConfiguration
- a consumer that will call methods on AutoRollbackConfiguration.Builder
autoRollbackConfiguration(AutoRollbackConfiguration)
DeploymentInfo.Builder updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)
Indicates whether only instances that are not running the latest application revision are to be deployed to.
updateOutdatedInstancesOnly
- Indicates whether only instances that are not running the latest application revision are to be
deployed to.DeploymentInfo.Builder rollbackInfo(RollbackInfo rollbackInfo)
Information about a deployment rollback.
rollbackInfo
- Information about a deployment rollback.default DeploymentInfo.Builder rollbackInfo(Consumer<RollbackInfo.Builder> rollbackInfo)
Information about a deployment rollback.
This is a convenience that creates an instance of theRollbackInfo.Builder
avoiding the need to
create one manually via RollbackInfo.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to rollbackInfo(RollbackInfo)
.rollbackInfo
- a consumer that will call methods on RollbackInfo.Builder
rollbackInfo(RollbackInfo)
DeploymentInfo.Builder deploymentStyle(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.
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.default DeploymentInfo.Builder deploymentStyle(Consumer<DeploymentStyle.Builder> 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.
This is a convenience that creates an instance of theDeploymentStyle.Builder
avoiding the need to
create one manually via DeploymentStyle.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to deploymentStyle(DeploymentStyle)
.deploymentStyle
- a consumer that will call methods on DeploymentStyle.Builder
deploymentStyle(DeploymentStyle)
DeploymentInfo.Builder targetInstances(TargetInstances targetInstances)
Information about the instances that belong to the replacement environment in a blue/green deployment.
targetInstances
- Information about the instances that belong to the replacement environment in a blue/green deployment.default DeploymentInfo.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 theTargetInstances.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)
.targetInstances
- a consumer that will call methods on TargetInstances.Builder
targetInstances(TargetInstances)
DeploymentInfo.Builder instanceTerminationWaitTimeStarted(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.
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.DeploymentInfo.Builder blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
blueGreenDeploymentConfiguration
- Information about blue/green deployment options for this deployment.default DeploymentInfo.Builder blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration)
Information about blue/green deployment options for this deployment.
This is a convenience that creates an instance of theBlueGreenDeploymentConfiguration.Builder
avoiding the need to create one manually via BlueGreenDeploymentConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to
blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration)
.blueGreenDeploymentConfiguration
- a consumer that will call methods on BlueGreenDeploymentConfiguration.Builder
blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration)
DeploymentInfo.Builder loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)
Information about the load balancer used in the deployment.
loadBalancerInfo
- Information about the load balancer used in the deployment.default DeploymentInfo.Builder loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo)
Information about the load balancer used in the deployment.
This is a convenience that creates an instance of theLoadBalancerInfo.Builder
avoiding the need to
create one manually via LoadBalancerInfo.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to loadBalancerInfo(LoadBalancerInfo)
.loadBalancerInfo
- a consumer that will call methods on LoadBalancerInfo.Builder
loadBalancerInfo(LoadBalancerInfo)
DeploymentInfo.Builder additionalDeploymentStatusInfo(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.
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.DeploymentInfo.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.
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
- 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.
FileExistsBehavior
,
FileExistsBehavior
DeploymentInfo.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.
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
- 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.
FileExistsBehavior
,
FileExistsBehavior
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.