#[non_exhaustive]pub struct Service {Show 32 fields
pub service_arn: Option<String>,
pub service_name: Option<String>,
pub cluster_arn: Option<String>,
pub load_balancers: Option<Vec<LoadBalancer>>,
pub service_registries: Option<Vec<ServiceRegistry>>,
pub status: Option<String>,
pub desired_count: i32,
pub running_count: i32,
pub pending_count: i32,
pub launch_type: Option<LaunchType>,
pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
pub platform_version: Option<String>,
pub platform_family: Option<String>,
pub task_definition: Option<String>,
pub deployment_configuration: Option<DeploymentConfiguration>,
pub task_sets: Option<Vec<TaskSet>>,
pub deployments: Option<Vec<Deployment>>,
pub role_arn: Option<String>,
pub events: Option<Vec<ServiceEvent>>,
pub created_at: Option<DateTime>,
pub placement_constraints: Option<Vec<PlacementConstraint>>,
pub placement_strategy: Option<Vec<PlacementStrategy>>,
pub network_configuration: Option<NetworkConfiguration>,
pub health_check_grace_period_seconds: Option<i32>,
pub scheduling_strategy: Option<SchedulingStrategy>,
pub deployment_controller: Option<DeploymentController>,
pub tags: Option<Vec<Tag>>,
pub created_by: Option<String>,
pub enable_ecs_managed_tags: bool,
pub propagate_tags: Option<PropagateTags>,
pub enable_execute_command: bool,
pub availability_zone_rebalancing: Option<AvailabilityZoneRebalancing>,
}Expand description
Details on a service within a cluster.
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.service_arn: Option<String>The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
service_name: Option<String>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
cluster_arn: Option<String>The Amazon Resource Name (ARN) of the cluster that hosts the service.
load_balancers: Option<Vec<LoadBalancer>>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
service_registries: Option<Vec<ServiceRegistry>>The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
status: Option<String>The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
desired_count: i32The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService.
running_count: i32The number of tasks in the cluster that are in the RUNNING state.
pending_count: i32The number of tasks in the cluster that are in the PENDING state.
launch_type: Option<LaunchType>The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
platform_version: Option<String>The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. 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 run 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).
task_definition: Option<String>The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
deployment_configuration: Option<DeploymentConfiguration>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
task_sets: Option<Vec<TaskSet>>Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
deployments: Option<Vec<Deployment>>The current state of deployments for the service.
role_arn: Option<String>The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
events: Option<Vec<ServiceEvent>>The event stream for your service. A maximum of 100 of the latest events are displayed.
created_at: Option<DateTime>The Unix timestamp for the time when the service was created.
placement_constraints: Option<Vec<PlacementConstraint>>The placement constraints for the tasks in the service.
placement_strategy: Option<Vec<PlacementStrategy>>The placement strategy that determines how tasks for the service are placed.
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.
health_check_grace_period_seconds: Option<i32>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
scheduling_strategy: Option<SchedulingStrategy>The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
-
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. -
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMONscheduling strategy.
deployment_controller: Option<DeploymentController>The deployment controller type the service is using.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
created_by: Option<String>The principal that created the service.
Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
enable_execute_command: boolDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
availability_zone_rebalancing: Option<AvailabilityZoneRebalancing>Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
Implementations§
Source§impl Service
impl Service
Sourcepub fn service_arn(&self) -> Option<&str>
pub fn service_arn(&self) -> Option<&str>
The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
Sourcepub fn service_name(&self) -> Option<&str>
pub fn service_name(&self) -> Option<&str>
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
Sourcepub fn cluster_arn(&self) -> Option<&str>
pub fn cluster_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the cluster that hosts the service.
Sourcepub fn load_balancers(&self) -> &[LoadBalancer]
pub fn load_balancers(&self) -> &[LoadBalancer]
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container 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 .load_balancers.is_none().
Sourcepub fn service_registries(&self) -> &[ServiceRegistry]
pub fn service_registries(&self) -> &[ServiceRegistry]
The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
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_registries.is_none().
Sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
Sourcepub fn desired_count(&self) -> i32
pub fn desired_count(&self) -> i32
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService.
Sourcepub fn running_count(&self) -> i32
pub fn running_count(&self) -> i32
The number of tasks in the cluster that are in the RUNNING state.
Sourcepub fn pending_count(&self) -> i32
pub fn pending_count(&self) -> i32
The number of tasks in the cluster that are in the PENDING state.
Sourcepub fn launch_type(&self) -> Option<&LaunchType>
pub fn launch_type(&self) -> Option<&LaunchType>
The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
Sourcepub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]
pub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]
The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
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 platform_version(&self) -> Option<&str>
pub fn platform_version(&self) -> Option<&str>
The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. 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 run 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 task_definition(&self) -> Option<&str>
pub fn task_definition(&self) -> Option<&str>
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
Sourcepub fn deployment_configuration(&self) -> Option<&DeploymentConfiguration>
pub fn deployment_configuration(&self) -> Option<&DeploymentConfiguration>
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Sourcepub fn task_sets(&self) -> &[TaskSet]
pub fn task_sets(&self) -> &[TaskSet]
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .task_sets.is_none().
Sourcepub fn deployments(&self) -> &[Deployment]
pub fn deployments(&self) -> &[Deployment]
The current state of deployments for the service.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .deployments.is_none().
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
Sourcepub fn events(&self) -> &[ServiceEvent]
pub fn events(&self) -> &[ServiceEvent]
The event stream for your service. A maximum of 100 of the latest events are displayed.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .events.is_none().
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The Unix timestamp for the time when the service was created.
Sourcepub fn placement_constraints(&self) -> &[PlacementConstraint]
pub fn placement_constraints(&self) -> &[PlacementConstraint]
The placement constraints for the tasks in the service.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .placement_constraints.is_none().
Sourcepub fn placement_strategy(&self) -> &[PlacementStrategy]
pub fn placement_strategy(&self) -> &[PlacementStrategy]
The placement strategy that determines how tasks for the service are placed.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .placement_strategy.is_none().
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 health_check_grace_period_seconds(&self) -> Option<i32>
pub fn health_check_grace_period_seconds(&self) -> Option<i32>
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
Sourcepub fn scheduling_strategy(&self) -> Option<&SchedulingStrategy>
pub fn scheduling_strategy(&self) -> Option<&SchedulingStrategy>
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
-
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. -
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMONscheduling strategy.
Sourcepub fn deployment_controller(&self) -> Option<&DeploymentController>
pub fn deployment_controller(&self) -> Option<&DeploymentController>
The deployment controller type the service is using.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Sourcepub fn created_by(&self) -> Option<&str>
pub fn created_by(&self) -> Option<&str>
The principal that created the service.
Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
Sourcepub fn enable_execute_command(&self) -> bool
pub fn enable_execute_command(&self) -> bool
Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
Sourcepub fn availability_zone_rebalancing(
&self,
) -> Option<&AvailabilityZoneRebalancing>
pub fn availability_zone_rebalancing( &self, ) -> Option<&AvailabilityZoneRebalancing>
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
Trait Implementations§
impl StructuralPartialEq for Service
Auto Trait Implementations§
impl Freeze for Service
impl RefUnwindSafe for Service
impl Send for Service
impl Sync for Service
impl Unpin for Service
impl UnwindSafe for Service
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);