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

#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::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
CreateServiceRequestWithCluster (const Aws::String &value)
 
CreateServiceRequestWithCluster (Aws::String &&value)
 
CreateServiceRequestWithCluster (const char *value)
 
const Aws::StringGetServiceName () const
 
bool ServiceNameHasBeenSet () const
 
void SetServiceName (const Aws::String &value)
 
void SetServiceName (Aws::String &&value)
 
void SetServiceName (const char *value)
 
CreateServiceRequestWithServiceName (const Aws::String &value)
 
CreateServiceRequestWithServiceName (Aws::String &&value)
 
CreateServiceRequestWithServiceName (const char *value)
 
const Aws::StringGetTaskDefinition () const
 
bool TaskDefinitionHasBeenSet () const
 
void SetTaskDefinition (const Aws::String &value)
 
void SetTaskDefinition (Aws::String &&value)
 
void SetTaskDefinition (const char *value)
 
CreateServiceRequestWithTaskDefinition (const Aws::String &value)
 
CreateServiceRequestWithTaskDefinition (Aws::String &&value)
 
CreateServiceRequestWithTaskDefinition (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)
 
CreateServiceRequestWithLoadBalancers (const Aws::Vector< LoadBalancer > &value)
 
CreateServiceRequestWithLoadBalancers (Aws::Vector< LoadBalancer > &&value)
 
CreateServiceRequestAddLoadBalancers (const LoadBalancer &value)
 
CreateServiceRequestAddLoadBalancers (LoadBalancer &&value)
 
const Aws::Vector< ServiceRegistry > & GetServiceRegistries () const
 
bool ServiceRegistriesHasBeenSet () const
 
void SetServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
void SetServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
CreateServiceRequestWithServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
CreateServiceRequestWithServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
CreateServiceRequestAddServiceRegistries (const ServiceRegistry &value)
 
CreateServiceRequestAddServiceRegistries (ServiceRegistry &&value)
 
int GetDesiredCount () const
 
bool DesiredCountHasBeenSet () const
 
void SetDesiredCount (int value)
 
CreateServiceRequestWithDesiredCount (int value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateServiceRequestWithClientToken (const Aws::String &value)
 
CreateServiceRequestWithClientToken (Aws::String &&value)
 
CreateServiceRequestWithClientToken (const char *value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
CreateServiceRequestWithLaunchType (const LaunchType &value)
 
CreateServiceRequestWithLaunchType (LaunchType &&value)
 
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy () const
 
bool CapacityProviderStrategyHasBeenSet () const
 
void SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
void SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
CreateServiceRequestWithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
CreateServiceRequestWithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
CreateServiceRequestAddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
CreateServiceRequestAddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
CreateServiceRequestWithPlatformVersion (const Aws::String &value)
 
CreateServiceRequestWithPlatformVersion (Aws::String &&value)
 
CreateServiceRequestWithPlatformVersion (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
CreateServiceRequestWithRole (const Aws::String &value)
 
CreateServiceRequestWithRole (Aws::String &&value)
 
CreateServiceRequestWithRole (const char *value)
 
const DeploymentConfigurationGetDeploymentConfiguration () const
 
bool DeploymentConfigurationHasBeenSet () const
 
void SetDeploymentConfiguration (const DeploymentConfiguration &value)
 
void SetDeploymentConfiguration (DeploymentConfiguration &&value)
 
CreateServiceRequestWithDeploymentConfiguration (const DeploymentConfiguration &value)
 
CreateServiceRequestWithDeploymentConfiguration (DeploymentConfiguration &&value)
 
const Aws::Vector< PlacementConstraint > & GetPlacementConstraints () const
 
bool PlacementConstraintsHasBeenSet () const
 
void SetPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
void SetPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
CreateServiceRequestWithPlacementConstraints (const Aws::Vector< PlacementConstraint > &value)
 
CreateServiceRequestWithPlacementConstraints (Aws::Vector< PlacementConstraint > &&value)
 
CreateServiceRequestAddPlacementConstraints (const PlacementConstraint &value)
 
CreateServiceRequestAddPlacementConstraints (PlacementConstraint &&value)
 
const Aws::Vector< PlacementStrategy > & GetPlacementStrategy () const
 
bool PlacementStrategyHasBeenSet () const
 
void SetPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
void SetPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
CreateServiceRequestWithPlacementStrategy (const Aws::Vector< PlacementStrategy > &value)
 
CreateServiceRequestWithPlacementStrategy (Aws::Vector< PlacementStrategy > &&value)
 
CreateServiceRequestAddPlacementStrategy (const PlacementStrategy &value)
 
CreateServiceRequestAddPlacementStrategy (PlacementStrategy &&value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
CreateServiceRequestWithNetworkConfiguration (const NetworkConfiguration &value)
 
CreateServiceRequestWithNetworkConfiguration (NetworkConfiguration &&value)
 
int GetHealthCheckGracePeriodSeconds () const
 
bool HealthCheckGracePeriodSecondsHasBeenSet () const
 
void SetHealthCheckGracePeriodSeconds (int value)
 
CreateServiceRequestWithHealthCheckGracePeriodSeconds (int value)
 
const SchedulingStrategyGetSchedulingStrategy () const
 
bool SchedulingStrategyHasBeenSet () const
 
void SetSchedulingStrategy (const SchedulingStrategy &value)
 
void SetSchedulingStrategy (SchedulingStrategy &&value)
 
CreateServiceRequestWithSchedulingStrategy (const SchedulingStrategy &value)
 
CreateServiceRequestWithSchedulingStrategy (SchedulingStrategy &&value)
 
const DeploymentControllerGetDeploymentController () const
 
bool DeploymentControllerHasBeenSet () const
 
void SetDeploymentController (const DeploymentController &value)
 
void SetDeploymentController (DeploymentController &&value)
 
CreateServiceRequestWithDeploymentController (const DeploymentController &value)
 
CreateServiceRequestWithDeploymentController (DeploymentController &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateServiceRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateServiceRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateServiceRequestAddTags (const Tag &value)
 
CreateServiceRequestAddTags (Tag &&value)
 
bool GetEnableECSManagedTags () const
 
bool EnableECSManagedTagsHasBeenSet () const
 
void SetEnableECSManagedTags (bool value)
 
CreateServiceRequestWithEnableECSManagedTags (bool value)
 
const PropagateTagsGetPropagateTags () const
 
bool PropagateTagsHasBeenSet () const
 
void SetPropagateTags (const PropagateTags &value)
 
void SetPropagateTags (PropagateTags &&value)
 
CreateServiceRequestWithPropagateTags (const PropagateTags &value)
 
CreateServiceRequestWithPropagateTags (PropagateTags &&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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 ( const CapacityProviderStrategyItem value)
inline

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 1034 of file CreateServiceRequest.h.

◆ AddCapacityProviderStrategy() [2/2]

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

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 1058 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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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 1443 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 1450 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 five strategy rules per service.

Definition at line 1493 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 five strategy rules per service.

Definition at line 1499 of file CreateServiceRequest.h.

◆ AddServiceRegistries() [1/2]

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

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 713 of file CreateServiceRequest.h.

◆ AddServiceRegistries() [2/2]

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

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 724 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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1945 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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1966 of file CreateServiceRequest.h.

◆ CapacityProviderStrategyHasBeenSet()

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

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 914 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 774 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 1369 of file CreateServiceRequest.h.

◆ DeploymentControllerHasBeenSet()

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

The deployment controller to use for the service.

Definition at line 1777 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 743 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 1985 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.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 890 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 768 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 1363 of file CreateServiceRequest.h.

◆ GetDeploymentController()

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

The deployment controller to use for the service.

Definition at line 1772 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 734 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 1976 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 1582 of file CreateServiceRequest.h.

◆ GetLaunchType()

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 820 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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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 1511 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 1401 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 five strategy rules per service.

Definition at line 1457 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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1070 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 2013 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 1174 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 1651 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, 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 registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 647 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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1819 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 1597 of file CreateServiceRequest.h.

◆ LaunchTypeHasBeenSet()

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 829 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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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 1522 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 1408 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 five strategy rules per service.

Definition at line 1463 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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1081 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 2022 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 1200 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 1674 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, 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 registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 658 of file CreateServiceRequest.h.

◆ SetCapacityProviderStrategy() [1/2]

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

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 938 of file CreateServiceRequest.h.

◆ SetCapacityProviderStrategy() [2/2]

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

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 962 of file CreateServiceRequest.h.

◆ SetClientToken() [1/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 780 of file CreateServiceRequest.h.

◆ SetClientToken() [2/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 786 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 792 of file CreateServiceRequest.h.

◆ SetCluster() [1/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() [2/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() [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 1375 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 1381 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.

Definition at line 1782 of file CreateServiceRequest.h.

◆ SetDeploymentController() [2/2]

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

The deployment controller to use for the service.

Definition at line 1787 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 752 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 1994 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 1612 of file CreateServiceRequest.h.

◆ SetLaunchType() [1/2]

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 838 of file CreateServiceRequest.h.

◆ SetLaunchType() [2/2]

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 847 of file CreateServiceRequest.h.

◆ SetLoadBalancers() [1/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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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.

◆ SetLoadBalancers() [2/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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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.

◆ 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 1533 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 1544 of file CreateServiceRequest.h.

◆ SetPlacementConstraints() [1/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 1415 of file CreateServiceRequest.h.

◆ SetPlacementConstraints() [2/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 1422 of file CreateServiceRequest.h.

◆ SetPlacementStrategy() [1/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 five strategy rules per service.

Definition at line 1469 of file CreateServiceRequest.h.

◆ SetPlacementStrategy() [2/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 five strategy rules per service.

Definition at line 1475 of file CreateServiceRequest.h.

◆ SetPlatformVersion() [1/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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1092 of file CreateServiceRequest.h.

◆ SetPlatformVersion() [2/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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1103 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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1114 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 2031 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 2040 of file CreateServiceRequest.h.

◆ SetRole() [1/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 1226 of file CreateServiceRequest.h.

◆ SetRole() [2/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 1252 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 1278 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 1697 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 1720 of file CreateServiceRequest.h.

◆ SetServiceName() [1/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, 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() [2/3]

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

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

Definition at line 137 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, 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 ( const Aws::Vector< ServiceRegistry > &  value)
inline

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 669 of file CreateServiceRequest.h.

◆ SetServiceRegistries() [2/2]

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

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 680 of file CreateServiceRequest.h.

◆ SetTags() [1/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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1861 of file CreateServiceRequest.h.

◆ SetTags() [2/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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1882 of file CreateServiceRequest.h.

◆ SetTaskDefinition() [1/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() [2/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() [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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1840 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 ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 986 of file CreateServiceRequest.h.

◆ WithCapacityProviderStrategy() [2/2]

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

The capacity provider strategy to use for the service.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 1010 of file CreateServiceRequest.h.

◆ WithClientToken() [1/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 798 of file CreateServiceRequest.h.

◆ WithClientToken() [2/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 804 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 810 of file CreateServiceRequest.h.

◆ WithCluster() [1/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() [2/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() [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 1387 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 1393 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.

Definition at line 1792 of file CreateServiceRequest.h.

◆ WithDeploymentController() [2/2]

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

The deployment controller to use for the service.

Definition at line 1797 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 761 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 2003 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 1627 of file CreateServiceRequest.h.

◆ WithLaunchType() [1/2]

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 856 of file CreateServiceRequest.h.

◆ WithLaunchType() [2/2]

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

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

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Definition at line 865 of file CreateServiceRequest.h.

◆ WithLoadBalancers() [1/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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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.

◆ WithLoadBalancers() [2/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 AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS 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.

◆ 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 1555 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 1566 of file CreateServiceRequest.h.

◆ WithPlacementConstraints() [1/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 1429 of file CreateServiceRequest.h.

◆ WithPlacementConstraints() [2/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 1436 of file CreateServiceRequest.h.

◆ WithPlacementStrategy() [1/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 five strategy rules per service.

Definition at line 1481 of file CreateServiceRequest.h.

◆ WithPlacementStrategy() [2/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 five strategy rules per service.

Definition at line 1487 of file CreateServiceRequest.h.

◆ WithPlatformVersion() [1/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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1125 of file CreateServiceRequest.h.

◆ WithPlatformVersion() [2/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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1136 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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 1147 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 2049 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 2058 of file CreateServiceRequest.h.

◆ WithRole() [1/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 1304 of file CreateServiceRequest.h.

◆ WithRole() [2/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 1330 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 1356 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 1743 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 1766 of file CreateServiceRequest.h.

◆ WithServiceName() [1/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, 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() [2/3]

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

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

Definition at line 161 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, 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 ( const Aws::Vector< ServiceRegistry > &  value)
inline

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 691 of file CreateServiceRequest.h.

◆ WithServiceRegistries() [2/2]

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

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

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

Definition at line 702 of file CreateServiceRequest.h.

◆ WithTags() [1/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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1903 of file CreateServiceRequest.h.

◆ WithTags() [2/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 AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 1924 of file CreateServiceRequest.h.

◆ WithTaskDefinition() [1/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() [2/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() [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: