AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::Service Class Reference

#include <Service.h>

Public Member Functions

 Service ()
 
 Service (Aws::Utils::Json::JsonView jsonValue)
 
Serviceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetServiceArn () const
 
bool ServiceArnHasBeenSet () const
 
void SetServiceArn (const Aws::String &value)
 
void SetServiceArn (Aws::String &&value)
 
void SetServiceArn (const char *value)
 
ServiceWithServiceArn (const Aws::String &value)
 
ServiceWithServiceArn (Aws::String &&value)
 
ServiceWithServiceArn (const char *value)
 
const Aws::StringGetServiceName () const
 
bool ServiceNameHasBeenSet () const
 
void SetServiceName (const Aws::String &value)
 
void SetServiceName (Aws::String &&value)
 
void SetServiceName (const char *value)
 
ServiceWithServiceName (const Aws::String &value)
 
ServiceWithServiceName (Aws::String &&value)
 
ServiceWithServiceName (const char *value)
 
const Aws::StringGetClusterArn () const
 
bool ClusterArnHasBeenSet () const
 
void SetClusterArn (const Aws::String &value)
 
void SetClusterArn (Aws::String &&value)
 
void SetClusterArn (const char *value)
 
ServiceWithClusterArn (const Aws::String &value)
 
ServiceWithClusterArn (Aws::String &&value)
 
ServiceWithClusterArn (const char *value)
 
const Aws::Vector< LoadBalancer > & GetLoadBalancers () const
 
bool LoadBalancersHasBeenSet () const
 
void SetLoadBalancers (const Aws::Vector< LoadBalancer > &value)
 
void SetLoadBalancers (Aws::Vector< LoadBalancer > &&value)
 
ServiceWithLoadBalancers (const Aws::Vector< LoadBalancer > &value)
 
ServiceWithLoadBalancers (Aws::Vector< LoadBalancer > &&value)
 
ServiceAddLoadBalancers (const LoadBalancer &value)
 
ServiceAddLoadBalancers (LoadBalancer &&value)
 
const Aws::Vector< ServiceRegistry > & GetServiceRegistries () const
 
bool ServiceRegistriesHasBeenSet () const
 
void SetServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
void SetServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
ServiceWithServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
ServiceWithServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
ServiceAddServiceRegistries (const ServiceRegistry &value)
 
ServiceAddServiceRegistries (ServiceRegistry &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ServiceWithStatus (const Aws::String &value)
 
ServiceWithStatus (Aws::String &&value)
 
ServiceWithStatus (const char *value)
 
int GetDesiredCount () const
 
bool DesiredCountHasBeenSet () const
 
void SetDesiredCount (int value)
 
ServiceWithDesiredCount (int value)
 
int GetRunningCount () const
 
bool RunningCountHasBeenSet () const
 
void SetRunningCount (int value)
 
ServiceWithRunningCount (int value)
 
int GetPendingCount () const
 
bool PendingCountHasBeenSet () const
 
void SetPendingCount (int value)
 
ServiceWithPendingCount (int value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
ServiceWithLaunchType (const LaunchType &value)
 
ServiceWithLaunchType (LaunchType &&value)
 
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy () const
 
bool CapacityProviderStrategyHasBeenSet () const
 
void SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
void SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
ServiceWithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
ServiceWithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
ServiceAddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
ServiceAddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
ServiceWithPlatformVersion (const Aws::String &value)
 
ServiceWithPlatformVersion (Aws::String &&value)
 
ServiceWithPlatformVersion (const char *value)
 
const Aws::StringGetTaskDefinition () const
 
bool TaskDefinitionHasBeenSet () const
 
void SetTaskDefinition (const Aws::String &value)
 
void SetTaskDefinition (Aws::String &&value)
 
void SetTaskDefinition (const char *value)
 
ServiceWithTaskDefinition (const Aws::String &value)
 
ServiceWithTaskDefinition (Aws::String &&value)
 
ServiceWithTaskDefinition (const char *value)
 
const DeploymentConfigurationGetDeploymentConfiguration () const
 
bool DeploymentConfigurationHasBeenSet () const
 
void SetDeploymentConfiguration (const DeploymentConfiguration &value)
 
void SetDeploymentConfiguration (DeploymentConfiguration &&value)
 
ServiceWithDeploymentConfiguration (const DeploymentConfiguration &value)
 
ServiceWithDeploymentConfiguration (DeploymentConfiguration &&value)
 
const Aws::Vector< TaskSet > & GetTaskSets () const
 
bool TaskSetsHasBeenSet () const
 
void SetTaskSets (const Aws::Vector< TaskSet > &value)
 
void SetTaskSets (Aws::Vector< TaskSet > &&value)
 
ServiceWithTaskSets (const Aws::Vector< TaskSet > &value)
 
ServiceWithTaskSets (Aws::Vector< TaskSet > &&value)
 
ServiceAddTaskSets (const TaskSet &value)
 
ServiceAddTaskSets (TaskSet &&value)
 
const Aws::Vector< Deployment > & GetDeployments () const
 
bool DeploymentsHasBeenSet () const
 
void SetDeployments (const Aws::Vector< Deployment > &value)
 
void SetDeployments (Aws::Vector< Deployment > &&value)
 
ServiceWithDeployments (const Aws::Vector< Deployment > &value)
 
ServiceWithDeployments (Aws::Vector< Deployment > &&value)
 
ServiceAddDeployments (const Deployment &value)
 
ServiceAddDeployments (Deployment &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
ServiceWithRoleArn (const Aws::String &value)
 
ServiceWithRoleArn (Aws::String &&value)
 
ServiceWithRoleArn (const char *value)
 
const Aws::Vector< ServiceEvent > & GetEvents () const
 
bool EventsHasBeenSet () const
 
void SetEvents (const Aws::Vector< ServiceEvent > &value)
 
void SetEvents (Aws::Vector< ServiceEvent > &&value)
 
ServiceWithEvents (const Aws::Vector< ServiceEvent > &value)
 
ServiceWithEvents (Aws::Vector< ServiceEvent > &&value)
 
ServiceAddEvents (const ServiceEvent &value)
 
ServiceAddEvents (ServiceEvent &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
ServiceWithCreatedAt (const Aws::Utils::DateTime &value)
 
ServiceWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< PlacementConstraint > & GetPlacementConstraints () const
 
bool PlacementConstraintsHasBeenSet () const
 
void SetPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
void SetPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
ServiceWithPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
ServiceWithPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
ServiceAddPlacementConstraints (const PlacementConstraint &value)
 
ServiceAddPlacementConstraints (PlacementConstraint &&value)
 
const Aws::Vector< PlacementStrategy > & GetPlacementStrategy () const
 
bool PlacementStrategyHasBeenSet () const
 
void SetPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
void SetPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
ServiceWithPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
ServiceWithPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
ServiceAddPlacementStrategy (const PlacementStrategy &value)
 
ServiceAddPlacementStrategy (PlacementStrategy &&value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
ServiceWithNetworkConfiguration (const NetworkConfiguration &value)
 
ServiceWithNetworkConfiguration (NetworkConfiguration &&value)
 
int GetHealthCheckGracePeriodSeconds () const
 
bool HealthCheckGracePeriodSecondsHasBeenSet () const
 
void SetHealthCheckGracePeriodSeconds (int value)
 
ServiceWithHealthCheckGracePeriodSeconds (int value)
 
const SchedulingStrategyGetSchedulingStrategy () const
 
bool SchedulingStrategyHasBeenSet () const
 
void SetSchedulingStrategy (const SchedulingStrategy &value)
 
void SetSchedulingStrategy (SchedulingStrategy &&value)
 
ServiceWithSchedulingStrategy (const SchedulingStrategy &value)
 
ServiceWithSchedulingStrategy (SchedulingStrategy &&value)
 
const DeploymentControllerGetDeploymentController () const
 
bool DeploymentControllerHasBeenSet () const
 
void SetDeploymentController (const DeploymentController &value)
 
void SetDeploymentController (DeploymentController &&value)
 
ServiceWithDeploymentController (const DeploymentController &value)
 
ServiceWithDeploymentController (DeploymentController &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
ServiceWithTags (const Aws::Vector< Tag > &value)
 
ServiceWithTags (Aws::Vector< Tag > &&value)
 
ServiceAddTags (const Tag &value)
 
ServiceAddTags (Tag &&value)
 
const Aws::StringGetCreatedBy () const
 
bool CreatedByHasBeenSet () const
 
void SetCreatedBy (const Aws::String &value)
 
void SetCreatedBy (Aws::String &&value)
 
void SetCreatedBy (const char *value)
 
ServiceWithCreatedBy (const Aws::String &value)
 
ServiceWithCreatedBy (Aws::String &&value)
 
ServiceWithCreatedBy (const char *value)
 
bool GetEnableECSManagedTags () const
 
bool EnableECSManagedTagsHasBeenSet () const
 
void SetEnableECSManagedTags (bool value)
 
ServiceWithEnableECSManagedTags (bool value)
 
const PropagateTagsGetPropagateTags () const
 
bool PropagateTagsHasBeenSet () const
 
void SetPropagateTags (const PropagateTags &value)
 
void SetPropagateTags (PropagateTags &&value)
 
ServiceWithPropagateTags (const PropagateTags &value)
 
ServiceWithPropagateTags (PropagateTags &&value)
 

Detailed Description

Details on a service within a cluster

See Also:

AWS API Reference

Definition at line 48 of file Service.h.

Constructor & Destructor Documentation

◆ Service() [1/2]

Aws::ECS::Model::Service::Service ( )

◆ Service() [2/2]

Aws::ECS::Model::Service::Service ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

Service& Aws::ECS::Model::Service::AddCapacityProviderStrategy ( const CapacityProviderStrategyItem value)
inline

The capacity provider strategy associated with the service.

Definition at line 580 of file Service.h.

◆ AddCapacityProviderStrategy() [2/2]

Service& Aws::ECS::Model::Service::AddCapacityProviderStrategy ( CapacityProviderStrategyItem &&  value)
inline

The capacity provider strategy associated with the service.

Definition at line 585 of file Service.h.

◆ AddDeployments() [1/2]

Service& Aws::ECS::Model::Service::AddDeployments ( const Deployment value)
inline

The current state of deployments for the service.

Definition at line 869 of file Service.h.

◆ AddDeployments() [2/2]

Service& Aws::ECS::Model::Service::AddDeployments ( Deployment &&  value)
inline

The current state of deployments for the service.

Definition at line 874 of file Service.h.

◆ AddEvents() [1/2]

Service& Aws::ECS::Model::Service::AddEvents ( const ServiceEvent value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 974 of file Service.h.

◆ AddEvents() [2/2]

Service& Aws::ECS::Model::Service::AddEvents ( ServiceEvent &&  value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 980 of file Service.h.

◆ AddLoadBalancers() [1/2]

Service& Aws::ECS::Model::Service::AddLoadBalancers ( const LoadBalancer value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 283 of file Service.h.

◆ AddLoadBalancers() [2/2]

Service& Aws::ECS::Model::Service::AddLoadBalancers ( LoadBalancer &&  value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 290 of file Service.h.

◆ AddPlacementConstraints() [1/2]

Service& Aws::ECS::Model::Service::AddPlacementConstraints ( const PlacementConstraint value)
inline

The placement constraints for the tasks in the service.

Definition at line 1047 of file Service.h.

◆ AddPlacementConstraints() [2/2]

Service& Aws::ECS::Model::Service::AddPlacementConstraints ( PlacementConstraint &&  value)
inline

The placement constraints for the tasks in the service.

Definition at line 1052 of file Service.h.

◆ AddPlacementStrategy() [1/2]

Service& Aws::ECS::Model::Service::AddPlacementStrategy ( const PlacementStrategy value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1095 of file Service.h.

◆ AddPlacementStrategy() [2/2]

Service& Aws::ECS::Model::Service::AddPlacementStrategy ( PlacementStrategy &&  value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1101 of file Service.h.

◆ AddServiceRegistries() [1/2]

Service& Aws::ECS::Model::Service::AddServiceRegistries ( const ServiceRegistry value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 347 of file Service.h.

◆ AddServiceRegistries() [2/2]

Service& Aws::ECS::Model::Service::AddServiceRegistries ( ServiceRegistry &&  value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 355 of file Service.h.

◆ AddTags() [1/2]

Service& Aws::ECS::Model::Service::AddTags ( const Tag value)
inline

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, both of which you define.

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

Definition at line 1460 of file Service.h.

◆ AddTags() [2/2]

Service& Aws::ECS::Model::Service::AddTags ( Tag &&  value)
inline

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, both of which you define.

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

Definition at line 1480 of file Service.h.

◆ AddTaskSets() [1/2]

Service& Aws::ECS::Model::Service::AddTaskSets ( const TaskSet value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 825 of file Service.h.

◆ AddTaskSets() [2/2]

Service& Aws::ECS::Model::Service::AddTaskSets ( TaskSet &&  value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 833 of file Service.h.

◆ CapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::Service::CapacityProviderStrategyHasBeenSet ( ) const
inline

The capacity provider strategy associated with the service.

Definition at line 555 of file Service.h.

◆ ClusterArnHasBeenSet()

bool Aws::ECS::Model::Service::ClusterArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 203 of file Service.h.

◆ CreatedAtHasBeenSet()

bool Aws::ECS::Model::Service::CreatedAtHasBeenSet ( ) const
inline

The Unix timestamp for when the service was created.

Definition at line 991 of file Service.h.

◆ CreatedByHasBeenSet()

bool Aws::ECS::Model::Service::CreatedByHasBeenSet ( ) const
inline

The principal that created the service.

Definition at line 1491 of file Service.h.

◆ DeploymentConfigurationHasBeenSet()

bool Aws::ECS::Model::Service::DeploymentConfigurationHasBeenSet ( ) const
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 744 of file Service.h.

◆ DeploymentControllerHasBeenSet()

bool Aws::ECS::Model::Service::DeploymentControllerHasBeenSet ( ) const
inline

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

Definition at line 1291 of file Service.h.

◆ DeploymentsHasBeenSet()

bool Aws::ECS::Model::Service::DeploymentsHasBeenSet ( ) const
inline

The current state of deployments for the service.

Definition at line 844 of file Service.h.

◆ DesiredCountHasBeenSet()

bool Aws::ECS::Model::Service::DesiredCountHasBeenSet ( ) const
inline

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.

Definition at line 419 of file Service.h.

◆ EnableECSManagedTagsHasBeenSet()

bool Aws::ECS::Model::Service::EnableECSManagedTagsHasBeenSet ( ) const
inline

Specifies whether to enable 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.

Definition at line 1540 of file Service.h.

◆ EventsHasBeenSet()

bool Aws::ECS::Model::Service::EventsHasBeenSet ( ) const
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 944 of file Service.h.

◆ GetCapacityProviderStrategy()

const Aws::Vector<CapacityProviderStrategyItem>& Aws::ECS::Model::Service::GetCapacityProviderStrategy ( ) const
inline

The capacity provider strategy associated with the service.

Definition at line 550 of file Service.h.

◆ GetClusterArn()

const Aws::String& Aws::ECS::Model::Service::GetClusterArn ( ) const
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 198 of file Service.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::ECS::Model::Service::GetCreatedAt ( ) const
inline

The Unix timestamp for when the service was created.

Definition at line 986 of file Service.h.

◆ GetCreatedBy()

const Aws::String& Aws::ECS::Model::Service::GetCreatedBy ( ) const
inline

The principal that created the service.

Definition at line 1486 of file Service.h.

◆ GetDeploymentConfiguration()

const DeploymentConfiguration& Aws::ECS::Model::Service::GetDeploymentConfiguration ( ) const
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 738 of file Service.h.

◆ GetDeploymentController()

const DeploymentController& Aws::ECS::Model::Service::GetDeploymentController ( ) const
inline

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

Definition at line 1284 of file Service.h.

◆ GetDeployments()

const Aws::Vector<Deployment>& Aws::ECS::Model::Service::GetDeployments ( ) const
inline

The current state of deployments for the service.

Definition at line 839 of file Service.h.

◆ GetDesiredCount()

int Aws::ECS::Model::Service::GetDesiredCount ( ) const
inline

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.

Definition at line 412 of file Service.h.

◆ GetEnableECSManagedTags()

bool Aws::ECS::Model::Service::GetEnableECSManagedTags ( ) const
inline

Specifies whether to enable 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.

Definition at line 1531 of file Service.h.

◆ GetEvents()

const Aws::Vector<ServiceEvent>& Aws::ECS::Model::Service::GetEvents ( ) const
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 938 of file Service.h.

◆ GetHealthCheckGracePeriodSeconds()

int Aws::ECS::Model::Service::GetHealthCheckGracePeriodSeconds ( ) const
inline

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.

Definition at line 1152 of file Service.h.

◆ GetLaunchType()

const LaunchType& Aws::ECS::Model::Service::GetLaunchType ( ) const
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 494 of file Service.h.

◆ GetLoadBalancers()

const Aws::Vector<LoadBalancer>& Aws::ECS::Model::Service::GetLoadBalancers ( ) const
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 241 of file Service.h.

◆ GetNetworkConfiguration()

const NetworkConfiguration& Aws::ECS::Model::Service::GetNetworkConfiguration ( ) const
inline

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

Definition at line 1109 of file Service.h.

◆ GetPendingCount()

int Aws::ECS::Model::Service::GetPendingCount ( ) const
inline

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

Definition at line 465 of file Service.h.

◆ GetPlacementConstraints()

const Aws::Vector<PlacementConstraint>& Aws::ECS::Model::Service::GetPlacementConstraints ( ) const
inline

The placement constraints for the tasks in the service.

Definition at line 1017 of file Service.h.

◆ GetPlacementStrategy()

const Aws::Vector<PlacementStrategy>& Aws::ECS::Model::Service::GetPlacementStrategy ( ) const
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1059 of file Service.h.

◆ GetPlatformVersion()

const Aws::String& Aws::ECS::Model::Service::GetPlatformVersion ( ) const
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 597 of file Service.h.

◆ GetPropagateTags()

const PropagateTags& Aws::ECS::Model::Service::GetPropagateTags ( ) const
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1565 of file Service.h.

◆ GetRoleArn()

const Aws::String& Aws::ECS::Model::Service::GetRoleArn ( ) const
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 882 of file Service.h.

◆ GetRunningCount()

int Aws::ECS::Model::Service::GetRunningCount ( ) const
inline

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

Definition at line 440 of file Service.h.

◆ GetSchedulingStrategy()

const SchedulingStrategy& Aws::ECS::Model::Service::GetSchedulingStrategy ( ) const
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1191 of file Service.h.

◆ GetServiceArn()

const Aws::String& Aws::ECS::Model::Service::GetServiceArn ( ) const
inline

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

Definition at line 64 of file Service.h.

◆ GetServiceName()

const Aws::String& Aws::ECS::Model::Service::GetServiceName ( ) const
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 136 of file Service.h.

◆ GetServiceRegistries()

const Aws::Vector<ServiceRegistry>& Aws::ECS::Model::Service::GetServiceRegistries ( ) const
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 299 of file Service.h.

◆ GetStatus()

const Aws::String& Aws::ECS::Model::Service::GetStatus ( ) const
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 362 of file Service.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::Service::GetTags ( ) const
inline

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, both of which you define.

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

Definition at line 1340 of file Service.h.

◆ GetTaskDefinition()

const Aws::String& Aws::ECS::Model::Service::GetTaskDefinition ( ) const
inline

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.

Definition at line 682 of file Service.h.

◆ GetTaskSets()

const Aws::Vector<TaskSet>& Aws::ECS::Model::Service::GetTaskSets ( ) const
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 777 of file Service.h.

◆ HealthCheckGracePeriodSecondsHasBeenSet()

bool Aws::ECS::Model::Service::HealthCheckGracePeriodSecondsHasBeenSet ( ) const
inline

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.

Definition at line 1159 of file Service.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::Service::Jsonize ( ) const

◆ LaunchTypeHasBeenSet()

bool Aws::ECS::Model::Service::LaunchTypeHasBeenSet ( ) const
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 504 of file Service.h.

◆ LoadBalancersHasBeenSet()

bool Aws::ECS::Model::Service::LoadBalancersHasBeenSet ( ) const
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 248 of file Service.h.

◆ NetworkConfigurationHasBeenSet()

bool Aws::ECS::Model::Service::NetworkConfigurationHasBeenSet ( ) const
inline

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

Definition at line 1116 of file Service.h.

◆ operator=()

Service& Aws::ECS::Model::Service::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PendingCountHasBeenSet()

bool Aws::ECS::Model::Service::PendingCountHasBeenSet ( ) const
inline

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

Definition at line 471 of file Service.h.

◆ PlacementConstraintsHasBeenSet()

bool Aws::ECS::Model::Service::PlacementConstraintsHasBeenSet ( ) const
inline

The placement constraints for the tasks in the service.

Definition at line 1022 of file Service.h.

◆ PlacementStrategyHasBeenSet()

bool Aws::ECS::Model::Service::PlacementStrategyHasBeenSet ( ) const
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1065 of file Service.h.

◆ PlatformVersionHasBeenSet()

bool Aws::ECS::Model::Service::PlatformVersionHasBeenSet ( ) const
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 608 of file Service.h.

◆ PropagateTagsHasBeenSet()

bool Aws::ECS::Model::Service::PropagateTagsHasBeenSet ( ) const
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1571 of file Service.h.

◆ RoleArnHasBeenSet()

bool Aws::ECS::Model::Service::RoleArnHasBeenSet ( ) const
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 889 of file Service.h.

◆ RunningCountHasBeenSet()

bool Aws::ECS::Model::Service::RunningCountHasBeenSet ( ) const
inline

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

Definition at line 446 of file Service.h.

◆ SchedulingStrategyHasBeenSet()

bool Aws::ECS::Model::Service::SchedulingStrategyHasBeenSet ( ) const
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1208 of file Service.h.

◆ ServiceArnHasBeenSet()

bool Aws::ECS::Model::Service::ServiceArnHasBeenSet ( ) const
inline

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

Definition at line 73 of file Service.h.

◆ ServiceNameHasBeenSet()

bool Aws::ECS::Model::Service::ServiceNameHasBeenSet ( ) const
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 144 of file Service.h.

◆ ServiceRegistriesHasBeenSet()

bool Aws::ECS::Model::Service::ServiceRegistriesHasBeenSet ( ) const
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 307 of file Service.h.

◆ SetCapacityProviderStrategy() [1/2]

void Aws::ECS::Model::Service::SetCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy associated with the service.

Definition at line 560 of file Service.h.

◆ SetCapacityProviderStrategy() [2/2]

void Aws::ECS::Model::Service::SetCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy associated with the service.

Definition at line 565 of file Service.h.

◆ SetClusterArn() [1/3]

void Aws::ECS::Model::Service::SetClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 208 of file Service.h.

◆ SetClusterArn() [2/3]

void Aws::ECS::Model::Service::SetClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 213 of file Service.h.

◆ SetClusterArn() [3/3]

void Aws::ECS::Model::Service::SetClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 218 of file Service.h.

◆ SetCreatedAt() [1/2]

void Aws::ECS::Model::Service::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the service was created.

Definition at line 996 of file Service.h.

◆ SetCreatedAt() [2/2]

void Aws::ECS::Model::Service::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the service was created.

Definition at line 1001 of file Service.h.

◆ SetCreatedBy() [1/3]

void Aws::ECS::Model::Service::SetCreatedBy ( const Aws::String value)
inline

The principal that created the service.

Definition at line 1496 of file Service.h.

◆ SetCreatedBy() [2/3]

void Aws::ECS::Model::Service::SetCreatedBy ( Aws::String &&  value)
inline

The principal that created the service.

Definition at line 1501 of file Service.h.

◆ SetCreatedBy() [3/3]

void Aws::ECS::Model::Service::SetCreatedBy ( const char *  value)
inline

The principal that created the service.

Definition at line 1506 of file Service.h.

◆ SetDeploymentConfiguration() [1/2]

void Aws::ECS::Model::Service::SetDeploymentConfiguration ( const DeploymentConfiguration value)
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 750 of file Service.h.

◆ SetDeploymentConfiguration() [2/2]

void Aws::ECS::Model::Service::SetDeploymentConfiguration ( DeploymentConfiguration &&  value)
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 756 of file Service.h.

◆ SetDeploymentController() [1/2]

void Aws::ECS::Model::Service::SetDeploymentController ( const DeploymentController value)
inline

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

Definition at line 1298 of file Service.h.

◆ SetDeploymentController() [2/2]

void Aws::ECS::Model::Service::SetDeploymentController ( DeploymentController &&  value)
inline

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

Definition at line 1305 of file Service.h.

◆ SetDeployments() [1/2]

void Aws::ECS::Model::Service::SetDeployments ( const Aws::Vector< Deployment > &  value)
inline

The current state of deployments for the service.

Definition at line 849 of file Service.h.

◆ SetDeployments() [2/2]

void Aws::ECS::Model::Service::SetDeployments ( Aws::Vector< Deployment > &&  value)
inline

The current state of deployments for the service.

Definition at line 854 of file Service.h.

◆ SetDesiredCount()

void Aws::ECS::Model::Service::SetDesiredCount ( int  value)
inline

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.

Definition at line 426 of file Service.h.

◆ SetEnableECSManagedTags()

void Aws::ECS::Model::Service::SetEnableECSManagedTags ( bool  value)
inline

Specifies whether to enable 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.

Definition at line 1549 of file Service.h.

◆ SetEvents() [1/2]

void Aws::ECS::Model::Service::SetEvents ( const Aws::Vector< ServiceEvent > &  value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 950 of file Service.h.

◆ SetEvents() [2/2]

void Aws::ECS::Model::Service::SetEvents ( Aws::Vector< ServiceEvent > &&  value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 956 of file Service.h.

◆ SetHealthCheckGracePeriodSeconds()

void Aws::ECS::Model::Service::SetHealthCheckGracePeriodSeconds ( int  value)
inline

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.

Definition at line 1166 of file Service.h.

◆ SetLaunchType() [1/2]

void Aws::ECS::Model::Service::SetLaunchType ( const LaunchType value)
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 514 of file Service.h.

◆ SetLaunchType() [2/2]

void Aws::ECS::Model::Service::SetLaunchType ( LaunchType &&  value)
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 524 of file Service.h.

◆ SetLoadBalancers() [1/2]

void Aws::ECS::Model::Service::SetLoadBalancers ( const Aws::Vector< LoadBalancer > &  value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 255 of file Service.h.

◆ SetLoadBalancers() [2/2]

void Aws::ECS::Model::Service::SetLoadBalancers ( Aws::Vector< LoadBalancer > &&  value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 262 of file Service.h.

◆ SetNetworkConfiguration() [1/2]

void Aws::ECS::Model::Service::SetNetworkConfiguration ( const NetworkConfiguration value)
inline

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

Definition at line 1123 of file Service.h.

◆ SetNetworkConfiguration() [2/2]

void Aws::ECS::Model::Service::SetNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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

Definition at line 1130 of file Service.h.

◆ SetPendingCount()

void Aws::ECS::Model::Service::SetPendingCount ( int  value)
inline

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

Definition at line 477 of file Service.h.

◆ SetPlacementConstraints() [1/2]

void Aws::ECS::Model::Service::SetPlacementConstraints ( const Aws::Vector< PlacementConstraint > &  value)
inline

The placement constraints for the tasks in the service.

Definition at line 1027 of file Service.h.

◆ SetPlacementConstraints() [2/2]

void Aws::ECS::Model::Service::SetPlacementConstraints ( Aws::Vector< PlacementConstraint > &&  value)
inline

The placement constraints for the tasks in the service.

Definition at line 1032 of file Service.h.

◆ SetPlacementStrategy() [1/2]

void Aws::ECS::Model::Service::SetPlacementStrategy ( const Aws::Vector< PlacementStrategy > &  value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1071 of file Service.h.

◆ SetPlacementStrategy() [2/2]

void Aws::ECS::Model::Service::SetPlacementStrategy ( Aws::Vector< PlacementStrategy > &&  value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1077 of file Service.h.

◆ SetPlatformVersion() [1/3]

void Aws::ECS::Model::Service::SetPlatformVersion ( const Aws::String value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 619 of file Service.h.

◆ SetPlatformVersion() [2/3]

void Aws::ECS::Model::Service::SetPlatformVersion ( Aws::String &&  value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 630 of file Service.h.

◆ SetPlatformVersion() [3/3]

void Aws::ECS::Model::Service::SetPlatformVersion ( const char *  value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 641 of file Service.h.

◆ SetPropagateTags() [1/2]

void Aws::ECS::Model::Service::SetPropagateTags ( const PropagateTags value)
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1577 of file Service.h.

◆ SetPropagateTags() [2/2]

void Aws::ECS::Model::Service::SetPropagateTags ( PropagateTags &&  value)
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1583 of file Service.h.

◆ SetRoleArn() [1/3]

void Aws::ECS::Model::Service::SetRoleArn ( const Aws::String value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 896 of file Service.h.

◆ SetRoleArn() [2/3]

void Aws::ECS::Model::Service::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 903 of file Service.h.

◆ SetRoleArn() [3/3]

void Aws::ECS::Model::Service::SetRoleArn ( const char *  value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 910 of file Service.h.

◆ SetRunningCount()

void Aws::ECS::Model::Service::SetRunningCount ( int  value)
inline

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

Definition at line 452 of file Service.h.

◆ SetSchedulingStrategy() [1/2]

void Aws::ECS::Model::Service::SetSchedulingStrategy ( const SchedulingStrategy value)
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1225 of file Service.h.

◆ SetSchedulingStrategy() [2/2]

void Aws::ECS::Model::Service::SetSchedulingStrategy ( SchedulingStrategy &&  value)
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1242 of file Service.h.

◆ SetServiceArn() [1/3]

void Aws::ECS::Model::Service::SetServiceArn ( const Aws::String value)
inline

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

Definition at line 82 of file Service.h.

◆ SetServiceArn() [2/3]

void Aws::ECS::Model::Service::SetServiceArn ( Aws::String &&  value)
inline

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

Definition at line 91 of file Service.h.

◆ SetServiceArn() [3/3]

void Aws::ECS::Model::Service::SetServiceArn ( const char *  value)
inline

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

Definition at line 100 of file Service.h.

◆ SetServiceName() [1/3]

void Aws::ECS::Model::Service::SetServiceName ( const Aws::String value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 152 of file Service.h.

◆ SetServiceName() [2/3]

void Aws::ECS::Model::Service::SetServiceName ( Aws::String &&  value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 160 of file Service.h.

◆ SetServiceName() [3/3]

void Aws::ECS::Model::Service::SetServiceName ( const char *  value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 168 of file Service.h.

◆ SetServiceRegistries() [1/2]

void Aws::ECS::Model::Service::SetServiceRegistries ( const Aws::Vector< ServiceRegistry > &  value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 315 of file Service.h.

◆ SetServiceRegistries() [2/2]

void Aws::ECS::Model::Service::SetServiceRegistries ( Aws::Vector< ServiceRegistry > &&  value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 323 of file Service.h.

◆ SetStatus() [1/3]

void Aws::ECS::Model::Service::SetStatus ( const Aws::String value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 374 of file Service.h.

◆ SetStatus() [2/3]

void Aws::ECS::Model::Service::SetStatus ( Aws::String &&  value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 380 of file Service.h.

◆ SetStatus() [3/3]

void Aws::ECS::Model::Service::SetStatus ( const char *  value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 386 of file Service.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::Service::SetTags ( const Aws::Vector< Tag > &  value)
inline

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, both of which you define.

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

Definition at line 1380 of file Service.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::Service::SetTags ( Aws::Vector< Tag > &&  value)
inline

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, both of which you define.

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

Definition at line 1400 of file Service.h.

◆ SetTaskDefinition() [1/3]

void Aws::ECS::Model::Service::SetTaskDefinition ( const Aws::String value)
inline

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.

Definition at line 696 of file Service.h.

◆ SetTaskDefinition() [2/3]

void Aws::ECS::Model::Service::SetTaskDefinition ( Aws::String &&  value)
inline

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.

Definition at line 703 of file Service.h.

◆ SetTaskDefinition() [3/3]

void Aws::ECS::Model::Service::SetTaskDefinition ( const char *  value)
inline

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.

Definition at line 710 of file Service.h.

◆ SetTaskSets() [1/2]

void Aws::ECS::Model::Service::SetTaskSets ( const Aws::Vector< TaskSet > &  value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 793 of file Service.h.

◆ SetTaskSets() [2/2]

void Aws::ECS::Model::Service::SetTaskSets ( Aws::Vector< TaskSet > &&  value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 801 of file Service.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::Service::StatusHasBeenSet ( ) const
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 368 of file Service.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::Service::TagsHasBeenSet ( ) const
inline

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, both of which you define.

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

Definition at line 1360 of file Service.h.

◆ TaskDefinitionHasBeenSet()

bool Aws::ECS::Model::Service::TaskDefinitionHasBeenSet ( ) const
inline

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.

Definition at line 689 of file Service.h.

◆ TaskSetsHasBeenSet()

bool Aws::ECS::Model::Service::TaskSetsHasBeenSet ( ) const
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 785 of file Service.h.

◆ WithCapacityProviderStrategy() [1/2]

Service& Aws::ECS::Model::Service::WithCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy associated with the service.

Definition at line 570 of file Service.h.

◆ WithCapacityProviderStrategy() [2/2]

Service& Aws::ECS::Model::Service::WithCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy associated with the service.

Definition at line 575 of file Service.h.

◆ WithClusterArn() [1/3]

Service& Aws::ECS::Model::Service::WithClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 223 of file Service.h.

◆ WithClusterArn() [2/3]

Service& Aws::ECS::Model::Service::WithClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 228 of file Service.h.

◆ WithClusterArn() [3/3]

Service& Aws::ECS::Model::Service::WithClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Definition at line 233 of file Service.h.

◆ WithCreatedAt() [1/2]

Service& Aws::ECS::Model::Service::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the service was created.

Definition at line 1006 of file Service.h.

◆ WithCreatedAt() [2/2]

Service& Aws::ECS::Model::Service::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the service was created.

Definition at line 1011 of file Service.h.

◆ WithCreatedBy() [1/3]

Service& Aws::ECS::Model::Service::WithCreatedBy ( const Aws::String value)
inline

The principal that created the service.

Definition at line 1511 of file Service.h.

◆ WithCreatedBy() [2/3]

Service& Aws::ECS::Model::Service::WithCreatedBy ( Aws::String &&  value)
inline

The principal that created the service.

Definition at line 1516 of file Service.h.

◆ WithCreatedBy() [3/3]

Service& Aws::ECS::Model::Service::WithCreatedBy ( const char *  value)
inline

The principal that created the service.

Definition at line 1521 of file Service.h.

◆ WithDeploymentConfiguration() [1/2]

Service& Aws::ECS::Model::Service::WithDeploymentConfiguration ( const DeploymentConfiguration value)
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 762 of file Service.h.

◆ WithDeploymentConfiguration() [2/2]

Service& Aws::ECS::Model::Service::WithDeploymentConfiguration ( DeploymentConfiguration &&  value)
inline

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Definition at line 768 of file Service.h.

◆ WithDeploymentController() [1/2]

Service& Aws::ECS::Model::Service::WithDeploymentController ( const DeploymentController value)
inline

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

Definition at line 1312 of file Service.h.

◆ WithDeploymentController() [2/2]

Service& Aws::ECS::Model::Service::WithDeploymentController ( DeploymentController &&  value)
inline

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

Definition at line 1319 of file Service.h.

◆ WithDeployments() [1/2]

Service& Aws::ECS::Model::Service::WithDeployments ( const Aws::Vector< Deployment > &  value)
inline

The current state of deployments for the service.

Definition at line 859 of file Service.h.

◆ WithDeployments() [2/2]

Service& Aws::ECS::Model::Service::WithDeployments ( Aws::Vector< Deployment > &&  value)
inline

The current state of deployments for the service.

Definition at line 864 of file Service.h.

◆ WithDesiredCount()

Service& Aws::ECS::Model::Service::WithDesiredCount ( int  value)
inline

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.

Definition at line 433 of file Service.h.

◆ WithEnableECSManagedTags()

Service& Aws::ECS::Model::Service::WithEnableECSManagedTags ( bool  value)
inline

Specifies whether to enable 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.

Definition at line 1558 of file Service.h.

◆ WithEvents() [1/2]

Service& Aws::ECS::Model::Service::WithEvents ( const Aws::Vector< ServiceEvent > &  value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 962 of file Service.h.

◆ WithEvents() [2/2]

Service& Aws::ECS::Model::Service::WithEvents ( Aws::Vector< ServiceEvent > &&  value)
inline

The event stream for your service. A maximum of 100 of the latest events are displayed.

Definition at line 968 of file Service.h.

◆ WithHealthCheckGracePeriodSeconds()

Service& Aws::ECS::Model::Service::WithHealthCheckGracePeriodSeconds ( int  value)
inline

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.

Definition at line 1173 of file Service.h.

◆ WithLaunchType() [1/2]

Service& Aws::ECS::Model::Service::WithLaunchType ( const LaunchType value)
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 534 of file Service.h.

◆ WithLaunchType() [2/2]

Service& Aws::ECS::Model::Service::WithLaunchType ( LaunchType &&  value)
inline

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 544 of file Service.h.

◆ WithLoadBalancers() [1/2]

Service& Aws::ECS::Model::Service::WithLoadBalancers ( const Aws::Vector< LoadBalancer > &  value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 269 of file Service.h.

◆ WithLoadBalancers() [2/2]

Service& Aws::ECS::Model::Service::WithLoadBalancers ( Aws::Vector< LoadBalancer > &&  value)
inline

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Definition at line 276 of file Service.h.

◆ WithNetworkConfiguration() [1/2]

Service& Aws::ECS::Model::Service::WithNetworkConfiguration ( const NetworkConfiguration value)
inline

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

Definition at line 1137 of file Service.h.

◆ WithNetworkConfiguration() [2/2]

Service& Aws::ECS::Model::Service::WithNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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

Definition at line 1144 of file Service.h.

◆ WithPendingCount()

Service& Aws::ECS::Model::Service::WithPendingCount ( int  value)
inline

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

Definition at line 483 of file Service.h.

◆ WithPlacementConstraints() [1/2]

Service& Aws::ECS::Model::Service::WithPlacementConstraints ( const Aws::Vector< PlacementConstraint > &  value)
inline

The placement constraints for the tasks in the service.

Definition at line 1037 of file Service.h.

◆ WithPlacementConstraints() [2/2]

Service& Aws::ECS::Model::Service::WithPlacementConstraints ( Aws::Vector< PlacementConstraint > &&  value)
inline

The placement constraints for the tasks in the service.

Definition at line 1042 of file Service.h.

◆ WithPlacementStrategy() [1/2]

Service& Aws::ECS::Model::Service::WithPlacementStrategy ( const Aws::Vector< PlacementStrategy > &  value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1083 of file Service.h.

◆ WithPlacementStrategy() [2/2]

Service& Aws::ECS::Model::Service::WithPlacementStrategy ( Aws::Vector< PlacementStrategy > &&  value)
inline

The placement strategy that determines how tasks for the service are placed.

Definition at line 1089 of file Service.h.

◆ WithPlatformVersion() [1/3]

Service& Aws::ECS::Model::Service::WithPlatformVersion ( const Aws::String value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 652 of file Service.h.

◆ WithPlatformVersion() [2/3]

Service& Aws::ECS::Model::Service::WithPlatformVersion ( Aws::String &&  value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 663 of file Service.h.

◆ WithPlatformVersion() [3/3]

Service& Aws::ECS::Model::Service::WithPlatformVersion ( const char *  value)
inline

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 674 of file Service.h.

◆ WithPropagateTags() [1/2]

Service& Aws::ECS::Model::Service::WithPropagateTags ( const PropagateTags value)
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1589 of file Service.h.

◆ WithPropagateTags() [2/2]

Service& Aws::ECS::Model::Service::WithPropagateTags ( PropagateTags &&  value)
inline

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Definition at line 1595 of file Service.h.

◆ WithRoleArn() [1/3]

Service& Aws::ECS::Model::Service::WithRoleArn ( const Aws::String value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 917 of file Service.h.

◆ WithRoleArn() [2/3]

Service& Aws::ECS::Model::Service::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 924 of file Service.h.

◆ WithRoleArn() [3/3]

Service& Aws::ECS::Model::Service::WithRoleArn ( const char *  value)
inline

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Definition at line 931 of file Service.h.

◆ WithRunningCount()

Service& Aws::ECS::Model::Service::WithRunningCount ( int  value)
inline

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

Definition at line 458 of file Service.h.

◆ WithSchedulingStrategy() [1/2]

Service& Aws::ECS::Model::Service::WithSchedulingStrategy ( const SchedulingStrategy value)
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1259 of file Service.h.

◆ WithSchedulingStrategy() [2/2]

Service& Aws::ECS::Model::Service::WithSchedulingStrategy ( SchedulingStrategy &&  value)
inline

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Definition at line 1276 of file Service.h.

◆ WithServiceArn() [1/3]

Service& Aws::ECS::Model::Service::WithServiceArn ( const Aws::String value)
inline

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

Definition at line 109 of file Service.h.

◆ WithServiceArn() [2/3]

Service& Aws::ECS::Model::Service::WithServiceArn ( Aws::String &&  value)
inline

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

Definition at line 118 of file Service.h.

◆ WithServiceArn() [3/3]

Service& Aws::ECS::Model::Service::WithServiceArn ( const char *  value)
inline

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

Definition at line 127 of file Service.h.

◆ WithServiceName() [1/3]

Service& Aws::ECS::Model::Service::WithServiceName ( const Aws::String value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 176 of file Service.h.

◆ WithServiceName() [2/3]

Service& Aws::ECS::Model::Service::WithServiceName ( Aws::String &&  value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 184 of file Service.h.

◆ WithServiceName() [3/3]

Service& Aws::ECS::Model::Service::WithServiceName ( const char *  value)
inline

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 192 of file Service.h.

◆ WithServiceRegistries() [1/2]

Service& Aws::ECS::Model::Service::WithServiceRegistries ( const Aws::Vector< ServiceRegistry > &  value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 331 of file Service.h.

◆ WithServiceRegistries() [2/2]

Service& Aws::ECS::Model::Service::WithServiceRegistries ( Aws::Vector< ServiceRegistry > &&  value)
inline

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Definition at line 339 of file Service.h.

◆ WithStatus() [1/3]

Service& Aws::ECS::Model::Service::WithStatus ( const Aws::String value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 392 of file Service.h.

◆ WithStatus() [2/3]

Service& Aws::ECS::Model::Service::WithStatus ( Aws::String &&  value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 398 of file Service.h.

◆ WithStatus() [3/3]

Service& Aws::ECS::Model::Service::WithStatus ( const char *  value)
inline

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Definition at line 404 of file Service.h.

◆ WithTags() [1/2]

Service& Aws::ECS::Model::Service::WithTags ( const Aws::Vector< Tag > &  value)
inline

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, both of which you define.

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

Definition at line 1420 of file Service.h.

◆ WithTags() [2/2]

Service& Aws::ECS::Model::Service::WithTags ( Aws::Vector< Tag > &&  value)
inline

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, both of which you define.

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

Definition at line 1440 of file Service.h.

◆ WithTaskDefinition() [1/3]

Service& Aws::ECS::Model::Service::WithTaskDefinition ( const Aws::String value)
inline

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.

Definition at line 717 of file Service.h.

◆ WithTaskDefinition() [2/3]

Service& Aws::ECS::Model::Service::WithTaskDefinition ( Aws::String &&  value)
inline

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.

Definition at line 724 of file Service.h.

◆ WithTaskDefinition() [3/3]

Service& Aws::ECS::Model::Service::WithTaskDefinition ( const char *  value)
inline

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.

Definition at line 731 of file Service.h.

◆ WithTaskSets() [1/2]

Service& Aws::ECS::Model::Service::WithTaskSets ( const Aws::Vector< TaskSet > &  value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 809 of file Service.h.

◆ WithTaskSets() [2/2]

Service& Aws::ECS::Model::Service::WithTaskSets ( Aws::Vector< TaskSet > &&  value)
inline

Information about a set of Amazon ECS tasks in either an AWS 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.

Definition at line 817 of file Service.h.


The documentation for this class was generated from the following file: