Struct aws_sdk_ecs::model::Service

source · [−]

#[non_exhaustive]
pub struct Service {Show 31 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,
}

Expand description

Details on a service within a cluster

Fields (Non-exhaustive)

This struct is marked as 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.

service_arn: Option<String>

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

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

running_count: i32

The number of tasks in the cluster that are in the RUNNING state.

pending_count: i32

The 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 DAEMON scheduling strategy.

deployment_controller: Option<DeploymentController>

The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service uses the ECS deployment controller type.

tags: Option<Vec<Tag>>

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.

enable_ecs_managed_tags: bool

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.

propagate_tags: Option<PropagateTags>

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: bool

Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.

Struct aws_sdk_ecs::model::Service

Fields (Non-exhaustive)

Implementations

impl Service

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

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

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

pub fn load_balancers(&self) -> Option<&[LoadBalancer]>

pub fn service_registries(&self) -> Option<&[ServiceRegistry]>

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

pub fn desired_count(&self) -> i32

pub fn running_count(&self) -> i32

pub fn pending_count(&self) -> i32

pub fn launch_type(&self) -> Option<&LaunchType>

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

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

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

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

pub fn deployment_configuration(&self) -> Option<&DeploymentConfiguration>

pub fn task_sets(&self) -> Option<&[TaskSet]>

pub fn deployments(&self) -> Option<&[Deployment]>

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

pub fn events(&self) -> Option<&[ServiceEvent]>

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

pub fn placement_constraints(&self) -> Option<&[PlacementConstraint]>

pub fn placement_strategy(&self) -> Option<&[PlacementStrategy]>

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

pub fn health_check_grace_period_seconds(&self) -> Option<i32>

pub fn scheduling_strategy(&self) -> Option<&SchedulingStrategy>

pub fn deployment_controller(&self) -> Option<&DeploymentController>

pub fn tags(&self) -> Option<&[Tag]>

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

pub fn enable_ecs_managed_tags(&self) -> bool

pub fn propagate_tags(&self) -> Option<&PropagateTags>

pub fn enable_execute_command(&self) -> bool

impl Service

pub fn builder() -> Builder

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

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

impl Debug for Service

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

impl PartialEq<Service> for Service

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

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

impl StructuralPartialEq for Service

Auto Trait Implementations

impl RefUnwindSafe for Service

impl Send for Service

impl Sync for Service

impl Unpin for Service

impl UnwindSafe for Service

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn load_balancers(&self) -> Option<&[LoadBalancer ]>

pub fn service_registries(&self) -> Option<&[ServiceRegistry ]>

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

pub fn task_sets(&self) -> Option<&[TaskSet ]>

pub fn deployments(&self) -> Option<&[Deployment ]>

pub fn events(&self) -> Option<&[ServiceEvent ]>

pub fn placement_constraints(&self) -> Option<&[PlacementConstraint ]>

pub fn placement_strategy(&self) -> Option<&[PlacementStrategy ]>

pub fn tags(&self) -> Option<&[Tag ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,