@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateServiceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateServiceRequest() |
Modifier and Type | Method and Description |
---|---|
CreateServiceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<CapacityProviderStrategyItem> |
getCapacityProviderStrategy()
The capacity provider strategy to use for the service.
|
String |
getClientToken()
An identifier that you provide to ensure the idempotency of the request.
|
String |
getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
|
DeploymentConfiguration |
getDeploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
DeploymentController |
getDeploymentController()
The deployment controller to use for the service.
|
Integer |
getDesiredCount()
The number of instantiations of the specified task definition to place and keep running in your service.
|
Boolean |
getEnableECSManagedTags()
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
|
Boolean |
getEnableExecuteCommand()
Determines whether the execute command functionality is turned on for the service.
|
Integer |
getHealthCheckGracePeriodSeconds()
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started.
|
String |
getLaunchType()
The infrastructure that you run your service on.
|
List<LoadBalancer> |
getLoadBalancers()
A load balancer object representing the load balancers to use with your service.
|
NetworkConfiguration |
getNetworkConfiguration()
The network configuration for the service.
|
List<PlacementConstraint> |
getPlacementConstraints()
An array of placement constraint objects to use for tasks in your service.
|
List<PlacementStrategy> |
getPlacementStrategy()
The placement strategy objects to use for tasks in your service.
|
String |
getPlatformVersion()
The platform version that your tasks in the service are running on.
|
String |
getPropagateTags()
Specifies whether to propagate the tags from the task definition to the task.
|
String |
getRole()
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.
|
String |
getSchedulingStrategy()
The scheduling strategy to use for the service.
|
ServiceConnectConfiguration |
getServiceConnectConfiguration()
The configuration for this service to discover and connect to services, and be discovered by, and connected from,
other services within a namespace.
|
String |
getServiceName()
The name of your service.
|
List<ServiceRegistry> |
getServiceRegistries()
The details of the service discovery registry to associate with this service.
|
List<Tag> |
getTags()
The metadata that you apply to the service to help you categorize and organize them.
|
String |
getTaskDefinition()
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
List<ServiceVolumeConfiguration> |
getVolumeConfigurations()
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
|
int |
hashCode() |
Boolean |
isEnableECSManagedTags()
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
|
Boolean |
isEnableExecuteCommand()
Determines whether the execute command functionality is turned on for the service.
|
void |
setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the service.
|
void |
setClientToken(String clientToken)
An identifier that you provide to ensure the idempotency of the request.
|
void |
setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
|
void |
setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
void |
setDeploymentController(DeploymentController deploymentController)
The deployment controller to use for the service.
|
void |
setDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running in your service.
|
void |
setEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
|
void |
setEnableExecuteCommand(Boolean enableExecuteCommand)
Determines whether the execute command functionality is turned on for the service.
|
void |
setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started.
|
void |
setLaunchType(String launchType)
The infrastructure that you run your service on.
|
void |
setLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancers to use with your service.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service.
|
void |
setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
void |
setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service.
|
void |
setPlatformVersion(String platformVersion)
The platform version that your tasks in the service are running on.
|
void |
setPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
void |
setRole(String role)
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.
|
void |
setSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service.
|
void |
setServiceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)
The configuration for this service to discover and connect to services, and be discovered by, and connected from,
other services within a namespace.
|
void |
setServiceName(String serviceName)
The name of your service.
|
void |
setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registry to associate with this service.
|
void |
setTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them.
|
void |
setTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
void |
setVolumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
|
String |
toString()
Returns a string representation of this object.
|
CreateServiceRequest |
withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the service.
|
CreateServiceRequest |
withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the service.
|
CreateServiceRequest |
withClientToken(String clientToken)
An identifier that you provide to ensure the idempotency of the request.
|
CreateServiceRequest |
withCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
|
CreateServiceRequest |
withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
CreateServiceRequest |
withDeploymentController(DeploymentController deploymentController)
The deployment controller to use for the service.
|
CreateServiceRequest |
withDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running in your service.
|
CreateServiceRequest |
withEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
|
CreateServiceRequest |
withEnableExecuteCommand(Boolean enableExecuteCommand)
Determines whether the execute command functionality is turned on for the service.
|
CreateServiceRequest |
withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started.
|
CreateServiceRequest |
withLaunchType(LaunchType launchType)
The infrastructure that you run your service on.
|
CreateServiceRequest |
withLaunchType(String launchType)
The infrastructure that you run your service on.
|
CreateServiceRequest |
withLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancers to use with your service.
|
CreateServiceRequest |
withLoadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancers to use with your service.
|
CreateServiceRequest |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service.
|
CreateServiceRequest |
withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
CreateServiceRequest |
withPlacementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
CreateServiceRequest |
withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service.
|
CreateServiceRequest |
withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for tasks in your service.
|
CreateServiceRequest |
withPlatformVersion(String platformVersion)
The platform version that your tasks in the service are running on.
|
CreateServiceRequest |
withPropagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
CreateServiceRequest |
withPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
CreateServiceRequest |
withRole(String role)
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.
|
CreateServiceRequest |
withSchedulingStrategy(SchedulingStrategy schedulingStrategy)
The scheduling strategy to use for the service.
|
CreateServiceRequest |
withSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service.
|
CreateServiceRequest |
withServiceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)
The configuration for this service to discover and connect to services, and be discovered by, and connected from,
other services within a namespace.
|
CreateServiceRequest |
withServiceName(String serviceName)
The name of your service.
|
CreateServiceRequest |
withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registry to associate with this service.
|
CreateServiceRequest |
withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registry to associate with this service.
|
CreateServiceRequest |
withTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them.
|
CreateServiceRequest |
withTags(Tag... tags)
The metadata that you apply to the service to help you categorize and organize them.
|
CreateServiceRequest |
withTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
CreateServiceRequest |
withVolumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
|
CreateServiceRequest |
withVolumeConfigurations(ServiceVolumeConfiguration... volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do
not specify a cluster, the default cluster is assumed.public String getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
public CreateServiceRequest withCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do
not specify a cluster, the default cluster is assumed.public void setServiceName(String serviceName)
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
serviceName
- The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens
are allowed. Service names must be unique within a cluster, but you can have similarly named services in
multiple clusters within a Region or across multiple Regions.public String getServiceName()
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
public CreateServiceRequest withServiceName(String serviceName)
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
serviceName
- The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens
are allowed. Service names must be unique within a cluster, but you can have similarly named services in
multiple clusters within a Region or across multiple Regions.public void setTaskDefinition(String taskDefinition)
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
taskDefinition
- The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest
ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or
CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
public String getTaskDefinition()
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest
ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or
CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
public CreateServiceRequest withTaskDefinition(String taskDefinition)
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
taskDefinition
- The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
isn't specified, the latest
ACTIVE
revision is used.
A task definition must be specified if the service uses either the ECS
or
CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
public List<LoadBalancer> getLoadBalancers()
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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use either an
Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two
target groups (referred to as a targetGroupPair
). During a deployment, CodeDeploy determines which
task set in your service has the status PRIMARY
, and it associates one target group with it. Then,
it also 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 you can use to perform
validation tests with Lambda functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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 aren't
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
. This is because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
If the service uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair
). During a
deployment, CodeDeploy determines which task set in your service has the status PRIMARY
, and
it associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda
functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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
aren't supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
. This is because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public void setLoadBalancers(Collection<LoadBalancer> loadBalancers)
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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use either an
Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two
target groups (referred to as a targetGroupPair
). During a deployment, CodeDeploy determines which
task set in your service has the status PRIMARY
, and it associates one target group with it. Then,
it also 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 you can use to perform
validation tests with Lambda functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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 aren't
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
. This is because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers
- 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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair
). During a deployment,
CodeDeploy determines which task set in your service has the status PRIMARY
, and it
associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda functions before routing
production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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
aren't supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
. This is because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public CreateServiceRequest withLoadBalancers(LoadBalancer... loadBalancers)
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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use either an
Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two
target groups (referred to as a targetGroupPair
). During a deployment, CodeDeploy determines which
task set in your service has the status PRIMARY
, and it associates one target group with it. Then,
it also 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 you can use to perform
validation tests with Lambda functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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 aren't
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
. This is because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
NOTE: This method appends the values to the existing list (if any). Use
setLoadBalancers(java.util.Collection)
or withLoadBalancers(java.util.Collection)
if you want
to override the existing values.
loadBalancers
- 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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair
). During a deployment,
CodeDeploy determines which task set in your service has the status PRIMARY
, and it
associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda functions before routing
production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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
aren't supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
. This is because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public CreateServiceRequest withLoadBalancers(Collection<LoadBalancer> loadBalancers)
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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use either an
Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two
target groups (referred to as a targetGroupPair
). During a deployment, CodeDeploy determines which
task set in your service has the status PRIMARY
, and it associates one target group with it. Then,
it also 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 you can use to perform
validation tests with Lambda functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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 aren't
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
. This is because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers
- 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 uses 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 use 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 uses the CODE_DEPLOY
deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair
). During a deployment,
CodeDeploy determines which task set in your service has the status PRIMARY
, and it
associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda functions before routing
production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's 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
aren't supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
. This is because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public List<ServiceRegistry> getServiceRegistries()
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
public void setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
serviceRegistries
- The details of the service discovery registry to associate with this service. For more information, see Service
discovery. Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
public CreateServiceRequest withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
NOTE: This method appends the values to the existing list (if any). Use
setServiceRegistries(java.util.Collection)
or withServiceRegistries(java.util.Collection)
if
you want to override the existing values.
serviceRegistries
- The details of the service discovery registry to associate with this service. For more information, see Service
discovery. Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
public CreateServiceRequest withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
serviceRegistries
- The details of the service discovery registry to associate with this service. For more information, see Service
discovery. Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
public void setDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
desiredCount
- The number of instantiations of the specified task definition to place and keep running in your
service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
public Integer getDesiredCount()
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
public CreateServiceRequest withDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
desiredCount
- The number of instantiations of the specified task definition to place and keep running in your
service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If
schedulingStrategy
is DAEMON
then this isn't required.
public void setClientToken(String clientToken)
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
clientToken
- An identifier that you provide to ensure the idempotency of the request. It must be unique and is case
sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.public String getClientToken()
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
public CreateServiceRequest withClientToken(String clientToken)
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
clientToken
- An identifier that you provide to ensure the idempotency of the request. It must be unique and is case
sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.public void setLaunchType(String launchType)
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity
registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
launchType
- The infrastructure that you run your service on. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
LaunchType
public String getLaunchType()
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity
registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
LaunchType
public CreateServiceRequest withLaunchType(String launchType)
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity
registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
launchType
- The infrastructure that you run your service on. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
LaunchType
public CreateServiceRequest withLaunchType(LaunchType launchType)
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity
registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
launchType
- The infrastructure that you run your service on. For more information, see Amazon ECS launch
types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType
is
specified, the capacityProviderStrategy
parameter must be omitted.
LaunchType
public List<CapacityProviderStrategyItem> getCapacityProviderStrategy()
The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted.
If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
If a capacityProviderStrategy
is specified, the launchType
parameter must be
omitted. If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
public void setCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted.
If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProviderStrategy
- The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be
omitted. If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
public CreateServiceRequest withCapacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted.
If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
NOTE: This method appends the values to the existing list (if any). Use
setCapacityProviderStrategy(java.util.Collection)
or
withCapacityProviderStrategy(java.util.Collection)
if you want to override the existing values.
capacityProviderStrategy
- The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be
omitted. If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
public CreateServiceRequest withCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted.
If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProviderStrategy
- The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be
omitted. If no capacityProviderStrategy
or launchType
is specified, the
defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
public void setPlatformVersion(String platformVersion)
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.
For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
platformVersion
- 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. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.public String getPlatformVersion()
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.
For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
LATEST
platform version
is used. For more information, see Fargate
platform versions in the Amazon Elastic Container Service Developer Guide.public CreateServiceRequest withPlatformVersion(String platformVersion)
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.
For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
platformVersion
- 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. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.public void setRole(String role)
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 doesn't 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 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 don't 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.
role
- 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 doesn't 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 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 don't
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.
public String getRole()
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 doesn't 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 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 don't 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.
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 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 don't 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.
public CreateServiceRequest withRole(String role)
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 doesn't 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 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 don't 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.
role
- 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 doesn't 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 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 don't
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.
public void setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.public DeploymentConfiguration getDeploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
public CreateServiceRequest withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.public List<PlacementConstraint> getPlacementConstraints()
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
public void setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placementConstraints
- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
constraints for each task. This limit includes constraints in the task definition and those specified at
runtime.public CreateServiceRequest withPlacementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementConstraints(java.util.Collection)
or withPlacementConstraints(java.util.Collection)
if you want to override the existing values.
placementConstraints
- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
constraints for each task. This limit includes constraints in the task definition and those specified at
runtime.public CreateServiceRequest withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placementConstraints
- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
constraints for each task. This limit includes constraints in the task definition and those specified at
runtime.public List<PlacementStrategy> getPlacementStrategy()
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy
rules for each service.public CreateServiceRequest withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
NOTE: This method appends the values to the existing list (if any). Use
setPlacementStrategy(java.util.Collection)
or withPlacementStrategy(java.util.Collection)
if
you want to override the existing values.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy
rules for each service.public CreateServiceRequest withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy
rules for each service.public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
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 isn't supported for other
network modes. For more information, see Task networking in
the Amazon Elastic Container Service Developer Guide.
networkConfiguration
- 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 isn't supported
for other network modes. For more information, see Task
networking in the Amazon Elastic Container Service Developer Guide.public NetworkConfiguration getNetworkConfiguration()
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 isn't supported for other
network modes. For more information, see Task networking in
the Amazon Elastic Container Service Developer Guide.
awsvpc
network mode to receive their own elastic network interface, and it isn't supported
for other network modes. For more information, see Task
networking in the Amazon Elastic Container Service Developer Guide.public CreateServiceRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration)
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 isn't supported for other
network modes. For more information, see Task networking in
the Amazon Elastic Container Service Developer Guide.
networkConfiguration
- 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 isn't supported
for other network modes. For more information, see Task
networking in the Amazon Elastic Container Service Developer Guide.public void setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started. 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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in the task
definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
healthCheckGracePeriodSeconds
- The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load
Balancing target health checks after a task has first started. 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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in the
task definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
public Integer getHealthCheckGracePeriodSeconds()
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started. 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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in the task
definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
0
is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in
the task definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
public CreateServiceRequest withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks after a task has first started. 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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in the task
definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
healthCheckGracePeriodSeconds
- The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load
Balancing target health checks after a task has first started. 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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod
in the
task definition health check parameters. For more information, see Health check.
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 (about 69 years). 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.
public void setSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your
cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement
strategies and constraints to customize task placement decisions. This scheduler strategy is required if the
service uses 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 don't 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.
schedulingStrategy
- The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks
across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can
use task placement strategies and constraints to customize task placement decisions. This scheduler
strategy is required if the service uses 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 don't
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.
SchedulingStrategy
public String getSchedulingStrategy()
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 uses 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 don't 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.
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 uses 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 don't
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.
SchedulingStrategy
public CreateServiceRequest withSchedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your
cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement
strategies and constraints to customize task placement decisions. This scheduler strategy is required if the
service uses 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 don't 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.
schedulingStrategy
- The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks
across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can
use task placement strategies and constraints to customize task placement decisions. This scheduler
strategy is required if the service uses 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 don't
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.
SchedulingStrategy
public CreateServiceRequest withSchedulingStrategy(SchedulingStrategy schedulingStrategy)
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your
cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement
strategies and constraints to customize task placement decisions. This scheduler strategy is required if the
service uses 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 don't 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.
schedulingStrategy
- The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks
across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can
use task placement strategies and constraints to customize task placement decisions. This scheduler
strategy is required if the service uses 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 don't
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.
SchedulingStrategy
public void setDeploymentController(DeploymentController deploymentController)
The deployment controller to use for the service. If no deployment controller is specified, the default value of
ECS
is used.
deploymentController
- The deployment controller to use for the service. If no deployment controller is specified, the default
value of ECS
is used.public DeploymentController getDeploymentController()
The deployment controller to use for the service. If no deployment controller is specified, the default value of
ECS
is used.
ECS
is used.public CreateServiceRequest withDeploymentController(DeploymentController deploymentController)
The deployment controller to use for the service. If no deployment controller is specified, the default value of
ECS
is used.
deploymentController
- The deployment controller to use for the service. If no deployment controller is specified, the default
value of ECS
is used.public List<Tag> getTags()
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete
tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource
limit.
public void setTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
tags
- The metadata that you apply to the service to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as
well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public CreateServiceRequest withTags(Tag... tags)
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The metadata that you apply to the service to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as
well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public CreateServiceRequest withTags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values
with this prefix. Tags with this prefix do not count against your tags per resource limit.
tags
- The metadata that you apply to the service to help you categorize and organize them. Each tag consists of
a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as
well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix
for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public void setEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
enableECSManagedTags
- Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
public Boolean getEnableECSManagedTags()
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
public CreateServiceRequest withEnableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
enableECSManagedTags
- Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
public Boolean isEnableECSManagedTags()
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
When you use Amazon ECS managed tags, you need to set the propagateTags
request parameter.
public void setPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than NONE
when you use Cost Explorer. For more information, see
Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
propagateTags
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified,
the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a
task after task creation, use the TagResource API
action.
You must set this to a value other than NONE
when you use Cost Explorer. For more
information, see Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
PropagateTags
public String getPropagateTags()
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than NONE
when you use Cost Explorer. For more information, see
Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
You must set this to a value other than NONE
when you use Cost Explorer. For more
information, see Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
PropagateTags
public CreateServiceRequest withPropagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than NONE
when you use Cost Explorer. For more information, see
Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
propagateTags
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified,
the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a
task after task creation, use the TagResource API
action.
You must set this to a value other than NONE
when you use Cost Explorer. For more
information, see Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
PropagateTags
public CreateServiceRequest withPropagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than NONE
when you use Cost Explorer. For more information, see
Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
propagateTags
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified,
the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a
task after task creation, use the TagResource API
action.
You must set this to a value other than NONE
when you use Cost Explorer. For more
information, see Amazon ECS usage
reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
PropagateTags
public void setEnableExecuteCommand(Boolean enableExecuteCommand)
Determines whether the execute command functionality is turned on for the service. If true
, this
enables execute command functionality on all containers in the service tasks.
enableExecuteCommand
- Determines whether the execute command functionality is turned on for the service. If true
,
this enables execute command functionality on all containers in the service tasks.public Boolean getEnableExecuteCommand()
Determines whether the execute command functionality is turned on for the service. If true
, this
enables execute command functionality on all containers in the service tasks.
true
,
this enables execute command functionality on all containers in the service tasks.public CreateServiceRequest withEnableExecuteCommand(Boolean enableExecuteCommand)
Determines whether the execute command functionality is turned on for the service. If true
, this
enables execute command functionality on all containers in the service tasks.
enableExecuteCommand
- Determines whether the execute command functionality is turned on for the service. If true
,
this enables execute command functionality on all containers in the service tasks.public Boolean isEnableExecuteCommand()
Determines whether the execute command functionality is turned on for the service. If true
, this
enables execute command functionality on all containers in the service tasks.
true
,
this enables execute command functionality on all containers in the service tasks.public void setServiceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
serviceConnectConfiguration
- The configuration for this service to discover and connect to services, and be discovered by, and
connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
public ServiceConnectConfiguration getServiceConnectConfiguration()
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
public CreateServiceRequest withServiceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
serviceConnectConfiguration
- The configuration for this service to discover and connect to services, and be discovered by, and
connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
public List<ServiceVolumeConfiguration> getVolumeConfigurations()
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
public void setVolumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
volumeConfigurations
- The configuration for a volume specified in the task definition as a volume that is configured at launch
time. Currently, the only supported volume type is an Amazon EBS volume.public CreateServiceRequest withVolumeConfigurations(ServiceVolumeConfiguration... volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
NOTE: This method appends the values to the existing list (if any). Use
setVolumeConfigurations(java.util.Collection)
or withVolumeConfigurations(java.util.Collection)
if you want to override the existing values.
volumeConfigurations
- The configuration for a volume specified in the task definition as a volume that is configured at launch
time. Currently, the only supported volume type is an Amazon EBS volume.public CreateServiceRequest withVolumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
volumeConfigurations
- The configuration for a volume specified in the task definition as a volume that is configured at launch
time. Currently, the only supported volume type is an Amazon EBS volume.public String toString()
toString
in class Object
Object.toString()
public CreateServiceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()