Package software.amazon.awssdk.services.ecs.model

Interface Deployment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Deployment.Builder,Deployment>, SdkBuilder<Deployment.Builder,Deployment>, SdkPojo
Enclosing class:
Deployment
public static interface Deployment.Builder extends SdkPojo, CopyableBuilder<Deployment.Builder,Deployment>

  • Method Details

    • id

      Deployment.Builder id(String id)

      The ID of the deployment.

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

    • status

      Deployment.Builder status(String status)

      The status of the deployment. The following describes each state.

      PRIMARY

      The most recent deployment of a service.

      ACTIVE

      A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

      INACTIVE

      A deployment that has been completely replaced.

      Parameters:
      status - The status of the deployment. The following describes each state.

      PRIMARY

      The most recent deployment of a service.

      ACTIVE

      A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

      INACTIVE

      A deployment that has been completely replaced.

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

    • taskDefinition

      Deployment.Builder taskDefinition(String taskDefinition)

      The most recent task definition that was specified for the tasks in the service to use.

      Parameters:
      taskDefinition - The most recent task definition that was specified for the tasks in the service to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredCount

      Deployment.Builder desiredCount(Integer desiredCount)

      The most recent desired count of tasks that was specified for the service to deploy or maintain.

      Parameters:
      desiredCount - The most recent desired count of tasks that was specified for the service to deploy or maintain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingCount

      Deployment.Builder pendingCount(Integer pendingCount)

      The number of tasks in the deployment that are in the PENDING status.

      Parameters:
      pendingCount - The number of tasks in the deployment that are in the PENDING status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runningCount

      Deployment.Builder runningCount(Integer runningCount)

      The number of tasks in the deployment that are in the RUNNING status.

      Parameters:
      runningCount - The number of tasks in the deployment that are in the RUNNING status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failedTasks

      Deployment.Builder failedTasks(Integer failedTasks)

      The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

      Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

      Parameters:
      failedTasks - The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

      Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

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

    • createdAt

      Deployment.Builder createdAt(Instant createdAt)

      The Unix timestamp for the time when the service deployment was created.

      Parameters:
      createdAt - The Unix timestamp for the time when the service deployment was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Deployment.Builder updatedAt(Instant updatedAt)

      The Unix timestamp for the time when the service deployment was last updated.

      Parameters:
      updatedAt - The Unix timestamp for the time when the service deployment was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderStrategy

      Deployment.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

      The capacity provider strategy that the deployment is using.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy that the deployment is using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderStrategy

      Deployment.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

      The capacity provider strategy that the deployment is using.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy that the deployment is using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderStrategy

      Deployment.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)

      The capacity provider strategy that the deployment is using.

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

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

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

    • launchType

      Deployment.Builder launchType(String launchType)

      The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      launchType - The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • launchType

      Deployment.Builder launchType(LaunchType launchType)

      The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      launchType - The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platformVersion

      Deployment.Builder platformVersion(String platformVersion)

      The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformFamily

      Deployment.Builder platformFamily(String platformFamily)

      The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

      All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

      Parameters:
      platformFamily - The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

      All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

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

    • networkConfiguration

      Deployment.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

      Parameters:
      networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      default Deployment.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

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

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

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

    • rolloutState

      Deployment.Builder rolloutState(String rolloutState)

      The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.

      The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

      Parameters:
      rolloutState -

      The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.

      The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

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

    • rolloutState

      Deployment.Builder rolloutState(DeploymentRolloutState rolloutState)

      The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.

      The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

      Parameters:
      rolloutState -

      The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.

      The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

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

    • rolloutStateReason

      Deployment.Builder rolloutStateReason(String rolloutStateReason)

      A description of the rollout state of a deployment.

      Parameters:
      rolloutStateReason - A description of the rollout state of a deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceConnectConfiguration

      Deployment.Builder serviceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)

      The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

      The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      serviceConnectConfiguration - The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

      The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

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

    • serviceConnectConfiguration

      default Deployment.Builder serviceConnectConfiguration(Consumer<ServiceConnectConfiguration.Builder> serviceConnectConfiguration)

      The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

      The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

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

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

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

    • serviceConnectResources

      Deployment.Builder serviceConnectResources(Collection<ServiceConnectServiceResource> serviceConnectResources)

      The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

      Parameters:
      serviceConnectResources - The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceConnectResources

      Deployment.Builder serviceConnectResources(ServiceConnectServiceResource... serviceConnectResources)

      The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

      Parameters:
      serviceConnectResources - The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceConnectResources

      Deployment.Builder serviceConnectResources(Consumer<ServiceConnectServiceResource.Builder>... serviceConnectResources)

      The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

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

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

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

    • volumeConfigurations

      Deployment.Builder volumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      Deployment.Builder volumeConfigurations(ServiceVolumeConfiguration... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      Deployment.Builder volumeConfigurations(Consumer<ServiceVolumeConfiguration.Builder>... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

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

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

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