Interface DeploymentInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>, SdkBuilder<DeploymentInfo.Builder,DeploymentInfo>, SdkPojo
Enclosing class:
DeploymentInfo
@Mutable @NotThreadSafe public static interface DeploymentInfo.Builder extends SdkPojo, CopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>

  • Method Details

    • applicationName

      DeploymentInfo.Builder applicationName(String applicationName)

      The application name.

      Parameters:
      applicationName - The application name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentGroupName

      DeploymentInfo.Builder deploymentGroupName(String deploymentGroupName)

      The deployment group name.

      Parameters:
      deploymentGroupName - The deployment group name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentConfigName

      DeploymentInfo.Builder deploymentConfigName(String deploymentConfigName)

      The deployment configuration name.

      Parameters:
      deploymentConfigName - The deployment configuration name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentId

      DeploymentInfo.Builder deploymentId(String deploymentId)

      The unique ID of a deployment.

      Parameters:
      deploymentId - The unique ID of a deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • previousRevision

      DeploymentInfo.Builder previousRevision(RevisionLocation previousRevision)

      Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

      Parameters:
      previousRevision - Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • previousRevision

      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 method 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 previousRevision(RevisionLocation).

      Parameters:
      previousRevision - 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

      DeploymentInfo.Builder revision(RevisionLocation revision)

      Information about the location of stored application artifacts and the service from which to retrieve them.

      Parameters:
      revision - Information about the location of stored application artifacts and the service from which to retrieve them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • revision

      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 method 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:

    • status

      DeploymentInfo.Builder status(String status)

      The current state of the deployment as a whole.

      Parameters:
      status - The current state of the deployment as a whole.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DeploymentInfo.Builder status(DeploymentStatus status)

      The current state of the deployment as a whole.

      Parameters:
      status - The current state of the deployment as a whole.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorInformation

      DeploymentInfo.Builder errorInformation(ErrorInformation errorInformation)

      Information about any error associated with this deployment.

      Parameters:
      errorInformation - Information about any error associated with this deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInformation

      default DeploymentInfo.Builder errorInformation(Consumer<ErrorInformation.Builder> errorInformation)

      Information about any error associated with this deployment.

      This is a convenience method that creates an instance of the ErrorInformation.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).

      Parameters:
      errorInformation - a consumer that will call methods on ErrorInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createTime

      DeploymentInfo.Builder createTime(Instant createTime)

      A timestamp that indicates when the deployment was created.

      Parameters:
      createTime - A timestamp that indicates when the deployment was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DeploymentInfo.Builder startTime(Instant startTime)

      A timestamp that indicates when the deployment was deployed to the deployment group.

      In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

      Parameters:
      startTime - A timestamp that indicates when the deployment was deployed to the deployment group.

      In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

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

    • completeTime

      DeploymentInfo.Builder completeTime(Instant completeTime)

      A timestamp that indicates when the deployment was complete.

      Parameters:
      completeTime - A timestamp that indicates when the deployment was complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentOverview

      DeploymentInfo.Builder deploymentOverview(DeploymentOverview deploymentOverview)

      A summary of the deployment status of the instances in the deployment.

      Parameters:
      deploymentOverview - A summary of the deployment status of the instances in the deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentOverview

      default DeploymentInfo.Builder deploymentOverview(Consumer<DeploymentOverview.Builder> deploymentOverview)

      A summary of the deployment status of the instances in the deployment.

      This is a convenience method that creates an instance of the DeploymentOverview.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).

      Parameters:
      deploymentOverview - a consumer that will call methods on DeploymentOverview.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

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

    • creator

      DeploymentInfo.Builder creator(String creator)

      The means by which the deployment was created:

      • user: A user created the deployment.

      • autoscaling: Amazon EC2 Auto Scaling created the deployment.

      • codeDeployRollback: A rollback process created the deployment.

      • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

      Parameters:
      creator - The means by which the deployment was created:

      • user: A user created the deployment.

      • autoscaling: Amazon EC2 Auto Scaling created the deployment.

      • codeDeployRollback: A rollback process created the deployment.

      • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

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

    • creator

      DeploymentInfo.Builder creator(DeploymentCreator creator)

      The means by which the deployment was created:

      • user: A user created the deployment.

      • autoscaling: Amazon EC2 Auto Scaling created the deployment.

      • codeDeployRollback: A rollback process created the deployment.

      • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

      Parameters:
      creator - The means by which the deployment was created:

      • user: A user created the deployment.

      • autoscaling: Amazon EC2 Auto Scaling created the deployment.

      • codeDeployRollback: A rollback process created the deployment.

      • CodeDeployAutoUpdate: An auto-update process created the deployment when it detected outdated Amazon EC2 instances.

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

    • ignoreApplicationStopFailures

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

    • autoRollbackConfiguration

      DeploymentInfo.Builder autoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

      Information about the automatic rollback configuration associated with the deployment.

      Parameters:
      autoRollbackConfiguration - Information about the automatic rollback configuration associated with the deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoRollbackConfiguration

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

      Information about the automatic rollback configuration associated with the deployment.

      This is a convenience method 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:

    • updateOutdatedInstancesOnly

      DeploymentInfo.Builder updateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)

      Indicates whether only instances that are not running the latest application revision are to be deployed to.

      Parameters:
      updateOutdatedInstancesOnly - Indicates whether only instances that are not running the latest application revision are to be deployed to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackInfo

      DeploymentInfo.Builder rollbackInfo(RollbackInfo rollbackInfo)

      Information about a deployment rollback.

      Parameters:
      rollbackInfo - Information about a deployment rollback.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackInfo

      default DeploymentInfo.Builder rollbackInfo(Consumer<RollbackInfo.Builder> rollbackInfo)

      Information about a deployment rollback.

      This is a convenience method that creates an instance of the RollbackInfo.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).

      Parameters:
      rollbackInfo - a consumer that will call methods on RollbackInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deploymentStyle

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentStyle

      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 method that creates an instance of the DeploymentStyle.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).

      Parameters:
      deploymentStyle - a consumer that will call methods on DeploymentStyle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetInstances

      DeploymentInfo.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 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 method 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:

    • instanceTerminationWaitTimeStarted

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blueGreenDeploymentConfiguration

      DeploymentInfo.Builder blueGreenDeploymentConfiguration(BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration)

      Information about blue/green deployment options for this deployment.

      Parameters:
      blueGreenDeploymentConfiguration - Information about blue/green deployment options for this deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blueGreenDeploymentConfiguration

      default DeploymentInfo.Builder blueGreenDeploymentConfiguration(Consumer<BlueGreenDeploymentConfiguration.Builder> blueGreenDeploymentConfiguration)

      Information about blue/green deployment options for this deployment.

      This is a convenience method that creates an instance of the BlueGreenDeploymentConfiguration.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).

      Parameters:
      blueGreenDeploymentConfiguration - a consumer that will call methods on BlueGreenDeploymentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loadBalancerInfo

      DeploymentInfo.Builder loadBalancerInfo(LoadBalancerInfo loadBalancerInfo)

      Information about the load balancer used in the deployment.

      Parameters:
      loadBalancerInfo - Information about the load balancer used in the deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadBalancerInfo

      default DeploymentInfo.Builder loadBalancerInfo(Consumer<LoadBalancerInfo.Builder> loadBalancerInfo)

      Information about the load balancer used in the deployment.

      This is a convenience method that creates an instance of the LoadBalancerInfo.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).

      Parameters:
      loadBalancerInfo - a consumer that will call methods on LoadBalancerInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalDeploymentStatusInfo

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileExistsBehavior

      DeploymentInfo.Builder fileExistsBehavior(String fileExistsBehavior)

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

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

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

    • fileExistsBehavior

      DeploymentInfo.Builder fileExistsBehavior(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.

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

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

    • deploymentStatusMessages

      DeploymentInfo.Builder deploymentStatusMessages(Collection<String> deploymentStatusMessages)

      Messages that contain information about the status of a deployment.

      Parameters:
      deploymentStatusMessages - Messages that contain information about the status of a deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentStatusMessages

      DeploymentInfo.Builder deploymentStatusMessages(String... deploymentStatusMessages)

      Messages that contain information about the status of a deployment.

      Parameters:
      deploymentStatusMessages - Messages that contain information about the status of a deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computePlatform

      DeploymentInfo.Builder computePlatform(String computePlatform)

      The destination platform type for the deployment (Lambda, Server, or ECS).

      Parameters:
      computePlatform - The destination platform type for the deployment (Lambda, Server, or ECS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • computePlatform

      DeploymentInfo.Builder computePlatform(ComputePlatform computePlatform)

      The destination platform type for the deployment (Lambda, Server, or ECS).

      Parameters:
      computePlatform - The destination platform type for the deployment (Lambda, Server, or ECS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • externalId

      DeploymentInfo.Builder externalId(String externalId)

      The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.

      Parameters:
      externalId - The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedDeployments

      DeploymentInfo.Builder relatedDeployments(RelatedDeployments relatedDeployments)
      Sets the value of the RelatedDeployments property for this object.
      Parameters:
      relatedDeployments - The new value for the RelatedDeployments property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedDeployments

      default DeploymentInfo.Builder relatedDeployments(Consumer<RelatedDeployments.Builder> relatedDeployments)
      Sets the value of the RelatedDeployments property for this object. This is a convenience method that creates an instance of the RelatedDeployments.Builder avoiding the need to create one manually via RelatedDeployments.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relatedDeployments(RelatedDeployments).

      Parameters:
      relatedDeployments - a consumer that will call methods on RelatedDeployments.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideAlarmConfiguration

      DeploymentInfo.Builder overrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration)
      Sets the value of the OverrideAlarmConfiguration property for this object.
      Parameters:
      overrideAlarmConfiguration - The new value for the OverrideAlarmConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideAlarmConfiguration

      default DeploymentInfo.Builder overrideAlarmConfiguration(Consumer<AlarmConfiguration.Builder> overrideAlarmConfiguration)
      Sets the value of the OverrideAlarmConfiguration property for this object. This is a convenience method that creates an instance of the AlarmConfiguration.Builder avoiding the need to create one manually via AlarmConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideAlarmConfiguration(AlarmConfiguration).

      Parameters:
      overrideAlarmConfiguration - a consumer that will call methods on AlarmConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: