#include <CreateServiceRequest.h>

Inheritance diagram for Aws::ECS::Model::CreateServiceRequest:

Public Member Functions
	CreateServiceRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

const Aws::String &	GetCluster () const

bool	ClusterHasBeenSet () const

void	SetCluster (const Aws::String &value)

void	SetCluster (Aws::String &&value)

void	SetCluster (const char *value)

CreateServiceRequest &	WithCluster (const Aws::String &value)

CreateServiceRequest &	WithCluster (Aws::String &&value)

CreateServiceRequest &	WithCluster (const char *value)

const Aws::String &	GetServiceName () const

bool	ServiceNameHasBeenSet () const

void	SetServiceName (const Aws::String &value)

void	SetServiceName (Aws::String &&value)

void	SetServiceName (const char *value)

CreateServiceRequest &	WithServiceName (const Aws::String &value)

CreateServiceRequest &	WithServiceName (Aws::String &&value)

CreateServiceRequest &	WithServiceName (const char *value)

const Aws::String &	GetTaskDefinition () const

bool	TaskDefinitionHasBeenSet () const

void	SetTaskDefinition (const Aws::String &value)

void	SetTaskDefinition (Aws::String &&value)

void	SetTaskDefinition (const char *value)

CreateServiceRequest &	WithTaskDefinition (const Aws::String &value)

CreateServiceRequest &	WithTaskDefinition (Aws::String &&value)

CreateServiceRequest &	WithTaskDefinition (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)

CreateServiceRequest &	WithLoadBalancers (const Aws::Vector< LoadBalancer > &value)

CreateServiceRequest &	WithLoadBalancers (Aws::Vector< LoadBalancer > &&value)

CreateServiceRequest &	AddLoadBalancers (const LoadBalancer &value)

CreateServiceRequest &	AddLoadBalancers (LoadBalancer &&value)

const Aws::Vector< ServiceRegistry > &	GetServiceRegistries () const

bool	ServiceRegistriesHasBeenSet () const

void	SetServiceRegistries (const Aws::Vector< ServiceRegistry > &value)

void	SetServiceRegistries (Aws::Vector< ServiceRegistry > &&value)

CreateServiceRequest &	WithServiceRegistries (const Aws::Vector< ServiceRegistry > &value)

CreateServiceRequest &	WithServiceRegistries (Aws::Vector< ServiceRegistry > &&value)

CreateServiceRequest &	AddServiceRegistries (const ServiceRegistry &value)

CreateServiceRequest &	AddServiceRegistries (ServiceRegistry &&value)

int	GetDesiredCount () const

bool	DesiredCountHasBeenSet () const

void	SetDesiredCount (int value)

CreateServiceRequest &	WithDesiredCount (int value)

const Aws::String &	GetClientToken () const

bool	ClientTokenHasBeenSet () const

void	SetClientToken (const Aws::String &value)

void	SetClientToken (Aws::String &&value)

void	SetClientToken (const char *value)

CreateServiceRequest &	WithClientToken (const Aws::String &value)

CreateServiceRequest &	WithClientToken (Aws::String &&value)

CreateServiceRequest &	WithClientToken (const char *value)

const LaunchType &	GetLaunchType () const

bool	LaunchTypeHasBeenSet () const

void	SetLaunchType (const LaunchType &value)

void	SetLaunchType (LaunchType &&value)

CreateServiceRequest &	WithLaunchType (const LaunchType &value)

CreateServiceRequest &	WithLaunchType (LaunchType &&value)

const Aws::Vector< CapacityProviderStrategyItem > &	GetCapacityProviderStrategy () const

bool	CapacityProviderStrategyHasBeenSet () const

void	SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)

void	SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)

CreateServiceRequest &	WithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)

CreateServiceRequest &	WithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)

CreateServiceRequest &	AddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)

CreateServiceRequest &	AddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)

const Aws::String &	GetPlatformVersion () const

bool	PlatformVersionHasBeenSet () const

void	SetPlatformVersion (const Aws::String &value)

void	SetPlatformVersion (Aws::String &&value)

void	SetPlatformVersion (const char *value)

CreateServiceRequest &	WithPlatformVersion (const Aws::String &value)

CreateServiceRequest &	WithPlatformVersion (Aws::String &&value)

CreateServiceRequest &	WithPlatformVersion (const char *value)

const Aws::String &	GetRole () const

bool	RoleHasBeenSet () const

void	SetRole (const Aws::String &value)

void	SetRole (Aws::String &&value)

void	SetRole (const char *value)

CreateServiceRequest &	WithRole (const Aws::String &value)

CreateServiceRequest &	WithRole (Aws::String &&value)

CreateServiceRequest &	WithRole (const char *value)

const DeploymentConfiguration &	GetDeploymentConfiguration () const

bool	DeploymentConfigurationHasBeenSet () const

void	SetDeploymentConfiguration (const DeploymentConfiguration &value)

void	SetDeploymentConfiguration (DeploymentConfiguration &&value)

CreateServiceRequest &	WithDeploymentConfiguration (const DeploymentConfiguration &value)

CreateServiceRequest &	WithDeploymentConfiguration (DeploymentConfiguration &&value)

const Aws::Vector< PlacementConstraint > &	GetPlacementConstraints () const

bool	PlacementConstraintsHasBeenSet () const

void	SetPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)

void	SetPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)

CreateServiceRequest &	WithPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)

CreateServiceRequest &	WithPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)

CreateServiceRequest &	AddPlacementConstraints (const PlacementConstraint &value)

CreateServiceRequest &	AddPlacementConstraints (PlacementConstraint &&value)

const Aws::Vector< PlacementStrategy > &	GetPlacementStrategy () const

bool	PlacementStrategyHasBeenSet () const

void	SetPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)

void	SetPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)

CreateServiceRequest &	WithPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)

CreateServiceRequest &	WithPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)

CreateServiceRequest &	AddPlacementStrategy (const PlacementStrategy &value)

CreateServiceRequest &	AddPlacementStrategy (PlacementStrategy &&value)

const NetworkConfiguration &	GetNetworkConfiguration () const

bool	NetworkConfigurationHasBeenSet () const

void	SetNetworkConfiguration (const NetworkConfiguration &value)

void	SetNetworkConfiguration (NetworkConfiguration &&value)

CreateServiceRequest &	WithNetworkConfiguration (const NetworkConfiguration &value)

CreateServiceRequest &	WithNetworkConfiguration (NetworkConfiguration &&value)

int	GetHealthCheckGracePeriodSeconds () const

bool	HealthCheckGracePeriodSecondsHasBeenSet () const

void	SetHealthCheckGracePeriodSeconds (int value)

CreateServiceRequest &	WithHealthCheckGracePeriodSeconds (int value)

const SchedulingStrategy &	GetSchedulingStrategy () const

bool	SchedulingStrategyHasBeenSet () const

void	SetSchedulingStrategy (const SchedulingStrategy &value)

void	SetSchedulingStrategy (SchedulingStrategy &&value)

CreateServiceRequest &	WithSchedulingStrategy (const SchedulingStrategy &value)

CreateServiceRequest &	WithSchedulingStrategy (SchedulingStrategy &&value)

const DeploymentController &	GetDeploymentController () const

bool	DeploymentControllerHasBeenSet () const

void	SetDeploymentController (const DeploymentController &value)

void	SetDeploymentController (DeploymentController &&value)

CreateServiceRequest &	WithDeploymentController (const DeploymentController &value)

CreateServiceRequest &	WithDeploymentController (DeploymentController &&value)

const Aws::Vector< Tag > &	GetTags () const

bool	TagsHasBeenSet () const

void	SetTags (const Aws::Vector< Tag > &value)

void	SetTags (Aws::Vector< Tag > &&value)

CreateServiceRequest &	WithTags (const Aws::Vector< Tag > &value)

CreateServiceRequest &	WithTags (Aws::Vector< Tag > &&value)

CreateServiceRequest &	AddTags (const Tag &value)

CreateServiceRequest &	AddTags (Tag &&value)

bool	GetEnableECSManagedTags () const

bool	EnableECSManagedTagsHasBeenSet () const

void	SetEnableECSManagedTags (bool value)

CreateServiceRequest &	WithEnableECSManagedTags (bool value)

const PropagateTags &	GetPropagateTags () const

bool	PropagateTagsHasBeenSet () const

void	SetPropagateTags (const PropagateTags &value)

void	SetPropagateTags (PropagateTags &&value)

CreateServiceRequest &	WithPropagateTags (const PropagateTags &value)

CreateServiceRequest &	WithPropagateTags (PropagateTags &&value)

bool	GetEnableExecuteCommand () const

bool	EnableExecuteCommandHasBeenSet () const

void	SetEnableExecuteCommand (bool value)

CreateServiceRequest &	WithEnableExecuteCommand (bool value)

Public Member Functions inherited from Aws::ECS::ECSRequest
virtual	~ECSRequest ()

void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

Aws::Http::HeaderValueCollection	GetHeaders () const override

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()

virtual	~AmazonSerializableWebServiceRequest ()

std::shared_ptr< Aws::IOStream >	GetBody () const override

Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()

virtual	~AmazonWebServiceRequest ()=default

virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const

virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool	IsStreaming () const

virtual bool	IsEventStreamRequest () const

virtual bool	SignBody () const

virtual bool	IsChunked () const

virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () const

void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 34 of file CreateServiceRequest.h.

Constructor & Destructor Documentation

◆ CreateServiceRequest()

Aws::ECS::Model::CreateServiceRequest::CreateServiceRequest ( )

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddCapacityProviderStrategy ( CapacityProviderStrategyItem && value )

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 990 of file CreateServiceRequest.h.

◆ AddCapacityProviderStrategy() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddCapacityProviderStrategy ( const CapacityProviderStrategyItem & value )

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 980 of file CreateServiceRequest.h.

◆ AddLoadBalancers() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddLoadBalancers ( const LoadBalancer & value )

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 587 of file CreateServiceRequest.h.

◆ AddLoadBalancers() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddLoadBalancers ( LoadBalancer && value )

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 635 of file CreateServiceRequest.h.

◆ AddPlacementConstraints() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddPlacementConstraints ( const PlacementConstraint & value )

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1375 of file CreateServiceRequest.h.

◆ AddPlacementConstraints() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddPlacementConstraints ( PlacementConstraint && value )

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1382 of file CreateServiceRequest.h.

◆ AddPlacementStrategy() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddPlacementStrategy ( const PlacementStrategy & value )

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1425 of file CreateServiceRequest.h.

◆ AddPlacementStrategy() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddPlacementStrategy ( PlacementStrategy && value )

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1431 of file CreateServiceRequest.h.

◆ AddServiceRegistries() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddServiceRegistries ( const ServiceRegistry & value )

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 699 of file CreateServiceRequest.h.

◆ AddServiceRegistries() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::AddServiceRegistries ( ServiceRegistry && value )

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 708 of file CreateServiceRequest.h.

◆ AddTags() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1883 of file CreateServiceRequest.h.

◆ AddTags() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1904 of file CreateServiceRequest.h.

◆ CapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::CapacityProviderStrategyHasBeenSet ( ) const

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 930 of file CreateServiceRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::ClientTokenHasBeenSet ( ) const

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 758 of file CreateServiceRequest.h.

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::ClusterHasBeenSet ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 62 of file CreateServiceRequest.h.

◆ DeploymentConfigurationHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::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 1301 of file CreateServiceRequest.h.

◆ DeploymentControllerHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::DeploymentControllerHasBeenSet ( ) const

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1711 of file CreateServiceRequest.h.

◆ DesiredCountHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::DesiredCountHasBeenSet ( ) const

inline

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.

Definition at line 727 of file CreateServiceRequest.h.

◆ EnableECSManagedTagsHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::EnableECSManagedTagsHasBeenSet ( ) const

inline

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Definition at line 1923 of file CreateServiceRequest.h.

◆ EnableExecuteCommandHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::EnableExecuteCommandHasBeenSet ( ) const

inline

Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.

Definition at line 2011 of file CreateServiceRequest.h.

◆ GetCapacityProviderStrategy()

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

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 920 of file CreateServiceRequest.h.

◆ GetClientToken()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetClientToken ( ) const

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 752 of file CreateServiceRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetCluster ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 55 of file CreateServiceRequest.h.

◆ GetDeploymentConfiguration()

const DeploymentConfiguration& Aws::ECS::Model::CreateServiceRequest::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 1295 of file CreateServiceRequest.h.

◆ GetDeploymentController()

const DeploymentController& Aws::ECS::Model::CreateServiceRequest::GetDeploymentController ( ) const

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1705 of file CreateServiceRequest.h.

◆ GetDesiredCount()

int Aws::ECS::Model::CreateServiceRequest::GetDesiredCount ( ) const

inline

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.

Definition at line 718 of file CreateServiceRequest.h.

◆ GetEnableECSManagedTags()

bool Aws::ECS::Model::CreateServiceRequest::GetEnableECSManagedTags ( ) const

inline

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Definition at line 1914 of file CreateServiceRequest.h.

◆ GetEnableExecuteCommand()

bool Aws::ECS::Model::CreateServiceRequest::GetEnableExecuteCommand ( ) const

inline

Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.

Definition at line 2004 of file CreateServiceRequest.h.

◆ GetHealthCheckGracePeriodSeconds()

int Aws::ECS::Model::CreateServiceRequest::GetHealthCheckGracePeriodSeconds ( ) const

inline

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Definition at line 1514 of file CreateServiceRequest.h.

◆ GetLaunchType()

const LaunchType& Aws::ECS::Model::CreateServiceRequest::GetLaunchType ( ) const

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 814 of file CreateServiceRequest.h.

◆ GetLoadBalancers()

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

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 299 of file CreateServiceRequest.h.

◆ GetNetworkConfiguration()

const NetworkConfiguration& Aws::ECS::Model::CreateServiceRequest::GetNetworkConfiguration ( ) const

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1443 of file CreateServiceRequest.h.

◆ GetPlacementConstraints()

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

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1333 of file CreateServiceRequest.h.

◆ GetPlacementStrategy()

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

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1389 of file CreateServiceRequest.h.

◆ GetPlatformVersion()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetPlatformVersion ( ) const

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1002 of file CreateServiceRequest.h.

◆ GetPropagateTags()

const PropagateTags& Aws::ECS::Model::CreateServiceRequest::GetPropagateTags ( ) const

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1951 of file CreateServiceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::CreateServiceRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetRole()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetRole ( ) const

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1106 of file CreateServiceRequest.h.

◆ GetSchedulingStrategy()

const SchedulingStrategy& Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1583 of file CreateServiceRequest.h.

◆ GetServiceName()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetServiceName ( ) const

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 113 of file CreateServiceRequest.h.

◆ GetServiceRegistries()

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

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 645 of file CreateServiceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::CreateServiceRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file CreateServiceRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1757 of file CreateServiceRequest.h.

◆ GetTaskDefinition()

const Aws::String& Aws::ECS::Model::CreateServiceRequest::GetTaskDefinition ( ) const

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 180 of file CreateServiceRequest.h.

◆ HealthCheckGracePeriodSecondsHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::HealthCheckGracePeriodSecondsHasBeenSet ( ) const

inline

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Definition at line 1529 of file CreateServiceRequest.h.

◆ LaunchTypeHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::LaunchTypeHasBeenSet ( ) const

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 833 of file CreateServiceRequest.h.

◆ LoadBalancersHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::LoadBalancersHasBeenSet ( ) const

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 347 of file CreateServiceRequest.h.

◆ NetworkConfigurationHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::NetworkConfigurationHasBeenSet ( ) const

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1454 of file CreateServiceRequest.h.

◆ PlacementConstraintsHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::PlacementConstraintsHasBeenSet ( ) const

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1340 of file CreateServiceRequest.h.

◆ PlacementStrategyHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::PlacementStrategyHasBeenSet ( ) const

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1395 of file CreateServiceRequest.h.

◆ PlatformVersionHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::PlatformVersionHasBeenSet ( ) const

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1013 of file CreateServiceRequest.h.

◆ PropagateTagsHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::PropagateTagsHasBeenSet ( ) const

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1960 of file CreateServiceRequest.h.

◆ RoleHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::RoleHasBeenSet ( ) const

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1132 of file CreateServiceRequest.h.

◆ SchedulingStrategyHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1606 of file CreateServiceRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::CreateServiceRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceNameHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::ServiceNameHasBeenSet ( ) const

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 121 of file CreateServiceRequest.h.

◆ ServiceRegistriesHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::ServiceRegistriesHasBeenSet ( ) const

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 654 of file CreateServiceRequest.h.

◆ SetCapacityProviderStrategy() [1/2]

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

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 950 of file CreateServiceRequest.h.

◆ SetCapacityProviderStrategy() [2/2]

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

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 940 of file CreateServiceRequest.h.

◆ SetClientToken() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetClientToken ( Aws::String && value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 770 of file CreateServiceRequest.h.

◆ SetClientToken() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetClientToken ( const Aws::String & value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 764 of file CreateServiceRequest.h.

◆ SetClientToken() [3/3]

void Aws::ECS::Model::CreateServiceRequest::SetClientToken ( const char * value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 776 of file CreateServiceRequest.h.

◆ SetCluster() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetCluster ( Aws::String && value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 76 of file CreateServiceRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetCluster ( const Aws::String & value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 69 of file CreateServiceRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::CreateServiceRequest::SetCluster ( const char * value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 83 of file CreateServiceRequest.h.

◆ SetDeploymentConfiguration() [1/2]

void Aws::ECS::Model::CreateServiceRequest::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 1307 of file CreateServiceRequest.h.

◆ SetDeploymentConfiguration() [2/2]

void Aws::ECS::Model::CreateServiceRequest::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 1313 of file CreateServiceRequest.h.

◆ SetDeploymentController() [1/2]

void Aws::ECS::Model::CreateServiceRequest::SetDeploymentController ( const DeploymentController & value )

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1717 of file CreateServiceRequest.h.

◆ SetDeploymentController() [2/2]

void Aws::ECS::Model::CreateServiceRequest::SetDeploymentController ( DeploymentController && value )

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1723 of file CreateServiceRequest.h.

◆ SetDesiredCount()

void Aws::ECS::Model::CreateServiceRequest::SetDesiredCount ( int value )

inline

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.

Definition at line 736 of file CreateServiceRequest.h.

◆ SetEnableECSManagedTags()

void Aws::ECS::Model::CreateServiceRequest::SetEnableECSManagedTags ( bool value )

inline

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Definition at line 1932 of file CreateServiceRequest.h.

◆ SetEnableExecuteCommand()

void Aws::ECS::Model::CreateServiceRequest::SetEnableExecuteCommand ( bool value )

inline

Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.

Definition at line 2018 of file CreateServiceRequest.h.

◆ SetHealthCheckGracePeriodSeconds()

void Aws::ECS::Model::CreateServiceRequest::SetHealthCheckGracePeriodSeconds ( int value )

inline

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Definition at line 1544 of file CreateServiceRequest.h.

◆ SetLaunchType() [1/2]

void Aws::ECS::Model::CreateServiceRequest::SetLaunchType ( const LaunchType & value )

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 852 of file CreateServiceRequest.h.

◆ SetLaunchType() [2/2]

void Aws::ECS::Model::CreateServiceRequest::SetLaunchType ( LaunchType && value )

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 871 of file CreateServiceRequest.h.

◆ SetLoadBalancers() [1/2]

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

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 443 of file CreateServiceRequest.h.

◆ SetLoadBalancers() [2/2]

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

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 395 of file CreateServiceRequest.h.

◆ SetNetworkConfiguration() [1/2]

void Aws::ECS::Model::CreateServiceRequest::SetNetworkConfiguration ( const NetworkConfiguration & value )

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1465 of file CreateServiceRequest.h.

◆ SetNetworkConfiguration() [2/2]

void Aws::ECS::Model::CreateServiceRequest::SetNetworkConfiguration ( NetworkConfiguration && value )

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1476 of file CreateServiceRequest.h.

◆ SetPlacementConstraints() [1/2]

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

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1354 of file CreateServiceRequest.h.

◆ SetPlacementConstraints() [2/2]

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

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1347 of file CreateServiceRequest.h.

◆ SetPlacementStrategy() [1/2]

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

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1407 of file CreateServiceRequest.h.

◆ SetPlacementStrategy() [2/2]

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

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1401 of file CreateServiceRequest.h.

◆ SetPlatformVersion() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetPlatformVersion ( Aws::String && value )

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1035 of file CreateServiceRequest.h.

◆ SetPlatformVersion() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetPlatformVersion ( const Aws::String & value )

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1024 of file CreateServiceRequest.h.

◆ SetPlatformVersion() [3/3]

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

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1046 of file CreateServiceRequest.h.

◆ SetPropagateTags() [1/2]

void Aws::ECS::Model::CreateServiceRequest::SetPropagateTags ( const PropagateTags & value )

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1969 of file CreateServiceRequest.h.

◆ SetPropagateTags() [2/2]

void Aws::ECS::Model::CreateServiceRequest::SetPropagateTags ( PropagateTags && value )

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1978 of file CreateServiceRequest.h.

◆ SetRole() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetRole ( Aws::String && value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1184 of file CreateServiceRequest.h.

◆ SetRole() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetRole ( const Aws::String & value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1158 of file CreateServiceRequest.h.

◆ SetRole() [3/3]

void Aws::ECS::Model::CreateServiceRequest::SetRole ( const char * value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1210 of file CreateServiceRequest.h.

◆ SetSchedulingStrategy() [1/2]

void Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1629 of file CreateServiceRequest.h.

◆ SetSchedulingStrategy() [2/2]

void Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1652 of file CreateServiceRequest.h.

◆ SetServiceName() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetServiceName ( Aws::String && value )

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 137 of file CreateServiceRequest.h.

◆ SetServiceName() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetServiceName ( const Aws::String & value )

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 129 of file CreateServiceRequest.h.

◆ SetServiceName() [3/3]

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

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 145 of file CreateServiceRequest.h.

◆ SetServiceRegistries() [1/2]

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

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 672 of file CreateServiceRequest.h.

◆ SetServiceRegistries() [2/2]

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

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 663 of file CreateServiceRequest.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1820 of file CreateServiceRequest.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1799 of file CreateServiceRequest.h.

◆ SetTaskDefinition() [1/3]

void Aws::ECS::Model::CreateServiceRequest::SetTaskDefinition ( Aws::String && value )

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 210 of file CreateServiceRequest.h.

◆ SetTaskDefinition() [2/3]

void Aws::ECS::Model::CreateServiceRequest::SetTaskDefinition ( const Aws::String & value )

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 200 of file CreateServiceRequest.h.

◆ SetTaskDefinition() [3/3]

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

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 220 of file CreateServiceRequest.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1778 of file CreateServiceRequest.h.

◆ TaskDefinitionHasBeenSet()

bool Aws::ECS::Model::CreateServiceRequest::TaskDefinitionHasBeenSet ( ) const

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 190 of file CreateServiceRequest.h.

◆ WithCapacityProviderStrategy() [1/2]

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

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 970 of file CreateServiceRequest.h.

◆ WithCapacityProviderStrategy() [2/2]

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

inline

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

Definition at line 960 of file CreateServiceRequest.h.

◆ WithClientToken() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithClientToken ( Aws::String && value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 788 of file CreateServiceRequest.h.

◆ WithClientToken() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithClientToken ( const Aws::String & value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 782 of file CreateServiceRequest.h.

◆ WithClientToken() [3/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithClientToken ( const char * value )

inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Definition at line 794 of file CreateServiceRequest.h.

◆ WithCluster() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithCluster ( Aws::String && value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 97 of file CreateServiceRequest.h.

◆ WithCluster() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithCluster ( const Aws::String & value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 90 of file CreateServiceRequest.h.

◆ WithCluster() [3/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithCluster ( const char * value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

Definition at line 104 of file CreateServiceRequest.h.

◆ WithDeploymentConfiguration() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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 1319 of file CreateServiceRequest.h.

◆ WithDeploymentConfiguration() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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 1325 of file CreateServiceRequest.h.

◆ WithDeploymentController() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithDeploymentController ( const DeploymentController & value )

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1729 of file CreateServiceRequest.h.

◆ WithDeploymentController() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithDeploymentController ( DeploymentController && value )

inline

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Definition at line 1735 of file CreateServiceRequest.h.

◆ WithDesiredCount()

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithDesiredCount ( int value )

inline

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.

Definition at line 745 of file CreateServiceRequest.h.

◆ WithEnableECSManagedTags()

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithEnableECSManagedTags ( bool value )

inline

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Definition at line 1941 of file CreateServiceRequest.h.

◆ WithEnableExecuteCommand()

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithEnableExecuteCommand ( bool value )

inline

Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.

Definition at line 2025 of file CreateServiceRequest.h.

◆ WithHealthCheckGracePeriodSeconds()

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithHealthCheckGracePeriodSeconds ( int value )

inline

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Definition at line 1559 of file CreateServiceRequest.h.

◆ WithLaunchType() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithLaunchType ( const LaunchType & value )

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 890 of file CreateServiceRequest.h.

◆ WithLaunchType() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithLaunchType ( LaunchType && value )

inline

The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 909 of file CreateServiceRequest.h.

◆ WithLoadBalancers() [1/2]

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

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 539 of file CreateServiceRequest.h.

◆ WithLoadBalancers() [2/2]

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

inline

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 491 of file CreateServiceRequest.h.

◆ WithNetworkConfiguration() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithNetworkConfiguration ( const NetworkConfiguration & value )

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1487 of file CreateServiceRequest.h.

◆ WithNetworkConfiguration() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithNetworkConfiguration ( NetworkConfiguration && value )

inline

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Definition at line 1498 of file CreateServiceRequest.h.

◆ WithPlacementConstraints() [1/2]

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

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1368 of file CreateServiceRequest.h.

◆ WithPlacementConstraints() [2/2]

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

inline

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Definition at line 1361 of file CreateServiceRequest.h.

◆ WithPlacementStrategy() [1/2]

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

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1419 of file CreateServiceRequest.h.

◆ WithPlacementStrategy() [2/2]

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

inline

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Definition at line 1413 of file CreateServiceRequest.h.

◆ WithPlatformVersion() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithPlatformVersion ( Aws::String && value )

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1068 of file CreateServiceRequest.h.

◆ WithPlatformVersion() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithPlatformVersion ( const Aws::String & value )

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1057 of file CreateServiceRequest.h.

◆ WithPlatformVersion() [3/3]

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

inline

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1079 of file CreateServiceRequest.h.

◆ WithPropagateTags() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithPropagateTags ( const PropagateTags & value )

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1987 of file CreateServiceRequest.h.

◆ WithPropagateTags() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithPropagateTags ( PropagateTags && value )

inline

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

Definition at line 1996 of file CreateServiceRequest.h.

◆ WithRole() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithRole ( Aws::String && value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1262 of file CreateServiceRequest.h.

◆ WithRole() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithRole ( const Aws::String & value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1236 of file CreateServiceRequest.h.

◆ WithRole() [3/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithRole ( const char * value )

inline

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Definition at line 1288 of file CreateServiceRequest.h.

◆ WithSchedulingStrategy() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1675 of file CreateServiceRequest.h.

◆ WithSchedulingStrategy() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
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. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

Definition at line 1698 of file CreateServiceRequest.h.

◆ WithServiceName() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithServiceName ( Aws::String && value )

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 161 of file CreateServiceRequest.h.

◆ WithServiceName() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithServiceName ( const Aws::String & value )

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 153 of file CreateServiceRequest.h.

◆ WithServiceName() [3/3]

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

inline

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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Definition at line 169 of file CreateServiceRequest.h.

◆ WithServiceRegistries() [1/2]

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

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 690 of file CreateServiceRequest.h.

◆ WithServiceRegistries() [2/2]

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

inline

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries per service isn't supported.

Definition at line 681 of file CreateServiceRequest.h.

◆ WithTags() [1/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1862 of file CreateServiceRequest.h.

◆ WithTags() [2/2]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::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. When a service is deleted, the tags are deleted as well.

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.

Definition at line 1841 of file CreateServiceRequest.h.

◆ WithTaskDefinition() [1/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithTaskDefinition ( Aws::String && value )

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 240 of file CreateServiceRequest.h.

◆ WithTaskDefinition() [2/3]

CreateServiceRequest& Aws::ECS::Model::CreateServiceRequest::WithTaskDefinition ( const Aws::String & value )

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 230 of file CreateServiceRequest.h.

◆ WithTaskDefinition() [3/3]

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

inline

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Definition at line 250 of file CreateServiceRequest.h.

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

aws-cpp-sdk-ecs/include/aws/ecs/model/CreateServiceRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateServiceRequest()

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

◆ AddCapacityProviderStrategy() [2/2]

◆ AddLoadBalancers() [1/2]

◆ AddLoadBalancers() [2/2]

◆ AddPlacementConstraints() [1/2]

◆ AddPlacementConstraints() [2/2]

◆ AddPlacementStrategy() [1/2]

◆ AddPlacementStrategy() [2/2]

◆ AddServiceRegistries() [1/2]

◆ AddServiceRegistries() [2/2]

◆ AddTags() [1/2]

◆ AddTags() [2/2]

◆ CapacityProviderStrategyHasBeenSet()

◆ ClientTokenHasBeenSet()

◆ ClusterHasBeenSet()

◆ DeploymentConfigurationHasBeenSet()

◆ DeploymentControllerHasBeenSet()

◆ DesiredCountHasBeenSet()

◆ EnableECSManagedTagsHasBeenSet()

◆ EnableExecuteCommandHasBeenSet()

◆ GetCapacityProviderStrategy()

◆ GetClientToken()

◆ GetCluster()

◆ GetDeploymentConfiguration()

◆ GetDeploymentController()

◆ GetDesiredCount()

◆ GetEnableECSManagedTags()

◆ GetEnableExecuteCommand()

◆ GetHealthCheckGracePeriodSeconds()

◆ GetLaunchType()

◆ GetLoadBalancers()

◆ GetNetworkConfiguration()

◆ GetPlacementConstraints()

◆ GetPlacementStrategy()

◆ GetPlatformVersion()

◆ GetPropagateTags()

◆ GetRequestSpecificHeaders()

◆ GetRole()

◆ GetSchedulingStrategy()

◆ GetServiceName()

◆ GetServiceRegistries()

◆ GetServiceRequestName()

◆ GetTags()

◆ GetTaskDefinition()

◆ HealthCheckGracePeriodSecondsHasBeenSet()

◆ LaunchTypeHasBeenSet()

◆ LoadBalancersHasBeenSet()

◆ NetworkConfigurationHasBeenSet()

◆ PlacementConstraintsHasBeenSet()

◆ PlacementStrategyHasBeenSet()

◆ PlatformVersionHasBeenSet()

◆ PropagateTagsHasBeenSet()

◆ RoleHasBeenSet()

◆ SchedulingStrategyHasBeenSet()

◆ SerializePayload()

◆ ServiceNameHasBeenSet()

◆ ServiceRegistriesHasBeenSet()

◆ SetCapacityProviderStrategy() [1/2]

◆ SetCapacityProviderStrategy() [2/2]

◆ SetClientToken() [1/3]

◆ SetClientToken() [2/3]

◆ SetClientToken() [3/3]

◆ SetCluster() [1/3]

◆ SetCluster() [2/3]

◆ SetCluster() [3/3]

◆ SetDeploymentConfiguration() [1/2]

◆ SetDeploymentConfiguration() [2/2]

◆ SetDeploymentController() [1/2]

◆ SetDeploymentController() [2/2]

◆ SetDesiredCount()

◆ SetEnableECSManagedTags()

◆ SetEnableExecuteCommand()

◆ SetHealthCheckGracePeriodSeconds()

◆ SetLaunchType() [1/2]