Interface ServiceDeployment.Builder

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

  • Method Details

    • serviceDeploymentArn

      ServiceDeployment.Builder serviceDeploymentArn(String serviceDeploymentArn)

      The ARN of the service deployment.

      Parameters:
      serviceDeploymentArn - The ARN of the service deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceArn

      ServiceDeployment.Builder serviceArn(String serviceArn)

      The ARN of the service for this service deployment.

      Parameters:
      serviceArn - The ARN of the service for this service deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterArn

      ServiceDeployment.Builder clusterArn(String clusterArn)

      The ARN of the cluster that hosts the service.

      Parameters:
      clusterArn - The ARN of the cluster that hosts the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      ServiceDeployment.Builder createdAt(Instant createdAt)

      The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      Parameters:
      createdAt - The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      ServiceDeployment.Builder startedAt(Instant startedAt)

      The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      Parameters:
      startedAt - The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • finishedAt

      ServiceDeployment.Builder finishedAt(Instant finishedAt)

      The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      Parameters:
      finishedAt - The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppedAt

      ServiceDeployment.Builder stoppedAt(Instant stoppedAt)

      The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      The service deployment stops when any of the following actions happen:

      • A user manually stops the deployment

      • The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.

      Parameters:
      stoppedAt - The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      The service deployment stops when any of the following actions happen:

      • A user manually stops the deployment

      • The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.

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

    • updatedAt

      ServiceDeployment.Builder updatedAt(Instant updatedAt)

      The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

      Parameters:
      updatedAt - The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceServiceRevisions

      ServiceDeployment.Builder sourceServiceRevisions(Collection<ServiceRevisionSummary> sourceServiceRevisions)

      The currently deployed workload configuration.

      Parameters:
      sourceServiceRevisions - The currently deployed workload configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceServiceRevisions

      ServiceDeployment.Builder sourceServiceRevisions(ServiceRevisionSummary... sourceServiceRevisions)

      The currently deployed workload configuration.

      Parameters:
      sourceServiceRevisions - The currently deployed workload configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceServiceRevisions

      ServiceDeployment.Builder sourceServiceRevisions(Consumer<ServiceRevisionSummary.Builder>... sourceServiceRevisions)

      The currently deployed workload configuration.

      This is a convenience method that creates an instance of the ServiceRevisionSummary.Builder avoiding the need to create one manually via ServiceRevisionSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceServiceRevisions(List<ServiceRevisionSummary>).

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

    • targetServiceRevision

      ServiceDeployment.Builder targetServiceRevision(ServiceRevisionSummary targetServiceRevision)

      The workload configuration being deployed.

      Parameters:
      targetServiceRevision - The workload configuration being deployed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetServiceRevision

      default ServiceDeployment.Builder targetServiceRevision(Consumer<ServiceRevisionSummary.Builder> targetServiceRevision)

      The workload configuration being deployed.

      This is a convenience method that creates an instance of the ServiceRevisionSummary.Builder avoiding the need to create one manually via ServiceRevisionSummary.builder().

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

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

    • status

      ServiceDeployment.Builder status(String status)

      The service deployment state.

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

    • status

      ServiceDeployment.Builder status(ServiceDeploymentStatus status)

      The service deployment state.

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

    • statusReason

      ServiceDeployment.Builder statusReason(String statusReason)

      Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.

      Parameters:
      statusReason - Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleStage

      ServiceDeployment.Builder lifecycleStage(String lifecycleStage)

      The current lifecycle stage of the deployment. Possible values include:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • SCALE_UP

        The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

      • BAKE_TIME

        The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.

      • CLEAN_UP

        The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.

      Parameters:
      lifecycleStage - The current lifecycle stage of the deployment. Possible values include:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • SCALE_UP

        The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

      • BAKE_TIME

        The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.

      • CLEAN_UP

        The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.

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

    • lifecycleStage

      ServiceDeployment.Builder lifecycleStage(ServiceDeploymentLifecycleStage lifecycleStage)

      The current lifecycle stage of the deployment. Possible values include:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • SCALE_UP

        The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

      • BAKE_TIME

        The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.

      • CLEAN_UP

        The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.

      Parameters:
      lifecycleStage - The current lifecycle stage of the deployment. Possible values include:

      • RECONCILE_SERVICE

        The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

      • PRE_SCALE_UP

        The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • SCALE_UP

        The stage when the green service revision scales up to 100% and launches new tasks. The green service revision is not serving any traffic at this point.

      • POST_SCALE_UP

        The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

      • TEST_TRAFFIC_SHIFT

        The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

      • POST_TEST_TRAFFIC_SHIFT

        The test traffic shift is complete. The green service revision handles 100% of the test traffic.

      • PRODUCTION_TRAFFIC_SHIFT

        Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

      • POST_PRODUCTION_TRAFFIC_SHIFT

        The production traffic shift is complete.

      • BAKE_TIME

        The stage when both blue and green service revisions are running simultaneously after the production traffic has shifted.

      • CLEAN_UP

        The stage when the blue service revision has completely scaled down to 0 running tasks. The green service revision is now the production service revision after this stage.

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

    • deploymentConfiguration

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

    • deploymentConfiguration

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

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

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

    • rollback

      ServiceDeployment.Builder rollback(Rollback rollback)

      The rollback options the service deployment uses when the deployment fails.

      Parameters:
      rollback - The rollback options the service deployment uses when the deployment fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollback

      default ServiceDeployment.Builder rollback(Consumer<Rollback.Builder> rollback)

      The rollback options the service deployment uses when the deployment fails.

      This is a convenience method that creates an instance of the Rollback.Builder avoiding the need to create one manually via Rollback.builder().

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

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

    • deploymentCircuitBreaker

      ServiceDeployment.Builder deploymentCircuitBreaker(ServiceDeploymentCircuitBreaker deploymentCircuitBreaker)

      The circuit breaker configuration that determines a service deployment failed.

      Parameters:
      deploymentCircuitBreaker - The circuit breaker configuration that determines a service deployment failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentCircuitBreaker

      default ServiceDeployment.Builder deploymentCircuitBreaker(Consumer<ServiceDeploymentCircuitBreaker.Builder> deploymentCircuitBreaker)

      The circuit breaker configuration that determines a service deployment failed.

      This is a convenience method that creates an instance of the ServiceDeploymentCircuitBreaker.Builder avoiding the need to create one manually via ServiceDeploymentCircuitBreaker.builder().

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

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

    • alarms

      ServiceDeployment.Builder alarms(ServiceDeploymentAlarms alarms)

      The CloudWatch alarms that determine when a service deployment fails.

      Parameters:
      alarms - The CloudWatch alarms that determine when a service deployment fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarms

      default ServiceDeployment.Builder alarms(Consumer<ServiceDeploymentAlarms.Builder> alarms)

      The CloudWatch alarms that determine when a service deployment fails.

      This is a convenience method that creates an instance of the ServiceDeploymentAlarms.Builder avoiding the need to create one manually via ServiceDeploymentAlarms.builder().

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

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