Struct aws_sdk_ecs::types::Deployment

#[non_exhaustive]
pub struct Deployment {

    pub id: Option<String>,
    pub status: Option<String>,
    pub task_definition: Option<String>,
    pub desired_count: i32,
    pub pending_count: i32,
    pub running_count: i32,
    pub failed_tasks: i32,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
    pub launch_type: Option<LaunchType>,
    pub platform_version: Option<String>,
    pub platform_family: Option<String>,
    pub network_configuration: Option<NetworkConfiguration>,
    pub rollout_state: Option<DeploymentRolloutState>,
    pub rollout_state_reason: Option<String>,
    pub service_connect_configuration: Option<ServiceConnectConfiguration>,
    pub service_connect_resources: Option<Vec<ServiceConnectServiceResource>>,
}

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The ID of the deployment.

status: Option<String>

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.

task_definition: Option<String>

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

desired_count: i32

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

pending_count: i32

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

running_count: i32

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

failed_tasks: i32

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.

created_at: Option<DateTime>

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

updated_at: Option<DateTime>

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

capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>

The capacity provider strategy that the deployment is using.

launch_type: Option<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.

platform_version: Option<String>

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.

platform_family: Option<String>

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

network_configuration: Option<NetworkConfiguration>

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

rollout_state: Option<DeploymentRolloutState>

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.

rollout_state_reason: Option<String>

A description of the rollout state of a deployment.

service_connect_configuration: Option<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.

service_connect_resources: Option<Vec<ServiceConnectServiceResource>>

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.

Implementations

impl Deployment

pub fn id(&self) -> Option<&str>

The ID of the deployment.

pub fn status(&self) -> Option<&str>

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.

pub fn task_definition(&self) -> Option<&str>

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

pub fn desired_count(&self) -> i32

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

pub fn pending_count(&self) -> i32

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

pub fn running_count(&self) -> i32

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

pub fn failed_tasks(&self) -> i32

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.

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn updated_at(&self) -> Option<&DateTime>

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

pub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]

The capacity provider strategy that the deployment is using.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capacity_provider_strategy.is_none().

pub fn launch_type(&self) -> Option<&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.

pub fn platform_version(&self) -> Option<&str>

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.

pub fn platform_family(&self) -> Option<&str>

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

pub fn network_configuration(&self) -> Option<&NetworkConfiguration>

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

pub fn rollout_state(&self) -> Option<&DeploymentRolloutState>

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.

pub fn rollout_state_reason(&self) -> Option<&str>

A description of the rollout state of a deployment.

pub fn service_connect_configuration( &self ) -> Option<&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.

pub fn service_connect_resources(&self) -> &[ServiceConnectServiceResource]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .service_connect_resources.is_none().

impl Deployment

pub fn builder() -> DeploymentBuilder

Creates a new builder-style object to manufacture Deployment.

Trait Implementations

impl Clone for Deployment

fn clone(&self) -> Deployment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Deployment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Deployment

fn eq(&self, other: &Deployment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Deployment