#[non_exhaustive]pub struct Deployment {Show 21 fields
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>>,
pub volume_configurations: Option<Vec<ServiceVolumeConfiguration>>,
pub fargate_ephemeral_storage: Option<DeploymentEphemeralStorage>,
pub vpc_lattice_configurations: Option<Vec<VpcLatticeConfiguration>>,
}Expand description
The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
PRIMARYdeployment. - 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: i32The most recent desired count of tasks that was specified for the service to deploy or maintain.
pending_count: i32The number of tasks in the deployment that are in the PENDING status.
running_count: i32The number of tasks in the deployment that are in the RUNNING status.
failed_tasks: i32The 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.
volume_configurations: Option<Vec<ServiceVolumeConfiguration>>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.
fargate_ephemeral_storage: Option<DeploymentEphemeralStorage>The Fargate ephemeral storage settings for the deployment.
vpc_lattice_configurations: Option<Vec<VpcLatticeConfiguration>>The VPC Lattice configuration for the service deployment.
Implementations§
Source§impl Deployment
impl Deployment
Sourcepub fn status(&self) -> Option<&str>
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
PRIMARYdeployment. - INACTIVE
-
A deployment that has been completely replaced.
Sourcepub fn task_definition(&self) -> Option<&str>
pub fn task_definition(&self) -> Option<&str>
The most recent task definition that was specified for the tasks in the service to use.
Sourcepub fn desired_count(&self) -> i32
pub fn desired_count(&self) -> i32
The most recent desired count of tasks that was specified for the service to deploy or maintain.
Sourcepub fn pending_count(&self) -> i32
pub fn pending_count(&self) -> i32
The number of tasks in the deployment that are in the PENDING status.
Sourcepub fn running_count(&self) -> i32
pub fn running_count(&self) -> i32
The number of tasks in the deployment that are in the RUNNING status.
Sourcepub fn failed_tasks(&self) -> i32
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.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The Unix timestamp for the time when the service deployment was created.
Sourcepub fn updated_at(&self) -> Option<&DateTime>
pub fn updated_at(&self) -> Option<&DateTime>
The Unix timestamp for the time when the service deployment was last updated.
Sourcepub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]
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().
Sourcepub fn launch_type(&self) -> Option<&LaunchType>
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.
Sourcepub fn platform_version(&self) -> Option<&str>
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.
Sourcepub fn platform_family(&self) -> Option<&str>
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..
Sourcepub fn network_configuration(&self) -> Option<&NetworkConfiguration>
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.
Sourcepub fn rollout_state(&self) -> Option<&DeploymentRolloutState>
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.
Sourcepub fn rollout_state_reason(&self) -> Option<&str>
pub fn rollout_state_reason(&self) -> Option<&str>
A description of the rollout state of a deployment.
Sourcepub fn service_connect_configuration(
&self,
) -> Option<&ServiceConnectConfiguration>
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.
Sourcepub fn service_connect_resources(&self) -> &[ServiceConnectServiceResource]
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().
Sourcepub fn volume_configurations(&self) -> &[ServiceVolumeConfiguration]
pub fn volume_configurations(&self) -> &[ServiceVolumeConfiguration]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .volume_configurations.is_none().
Sourcepub fn fargate_ephemeral_storage(&self) -> Option<&DeploymentEphemeralStorage>
pub fn fargate_ephemeral_storage(&self) -> Option<&DeploymentEphemeralStorage>
The Fargate ephemeral storage settings for the deployment.
Sourcepub fn vpc_lattice_configurations(&self) -> &[VpcLatticeConfiguration]
pub fn vpc_lattice_configurations(&self) -> &[VpcLatticeConfiguration]
The VPC Lattice configuration for the service deployment.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_lattice_configurations.is_none().
Source§impl Deployment
impl Deployment
Sourcepub fn builder() -> DeploymentBuilder
pub fn builder() -> DeploymentBuilder
Creates a new builder-style object to manufacture Deployment.
Trait Implementations§
Source§impl Clone for Deployment
impl Clone for Deployment
Source§fn clone(&self) -> Deployment
fn clone(&self) -> Deployment
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for Deployment
impl Debug for Deployment
Source§impl PartialEq for Deployment
impl PartialEq for Deployment
impl StructuralPartialEq for Deployment
Auto Trait Implementations§
impl Freeze for Deployment
impl RefUnwindSafe for Deployment
impl Send for Deployment
impl Sync for Deployment
impl Unpin for Deployment
impl UnwindSafe for Deployment
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);