@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) |
String |
getClientToken()
Unique, case-sensitive 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 on which to run your service.
|
DeploymentConfiguration |
getDeploymentConfiguration()
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
and starting tasks.
|
Integer |
getDesiredCount()
The number of instantiations of the specified task definition to place and keep running on your cluster.
|
Integer |
getHealthCheckGracePeriodSeconds()
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started.
|
String |
getLaunchType()
The launch type on which to run your service.
|
List<LoadBalancer> |
getLoadBalancers()
A load balancer object representing the load balancer 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 on which to run your service.
|
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.
|
String |
getServiceName()
The name of your service.
|
List<ServiceRegistry> |
getServiceRegistries()
The details of the service discovery registries to assign to this service.
|
String |
getTaskDefinition()
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
int |
hashCode() |
void |
setClientToken(String clientToken)
Unique, case-sensitive 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 on which to run your service.
|
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 |
setDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
|
void |
setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started.
|
void |
setLaunchType(String launchType)
The launch type on which to run your service.
|
void |
setLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer 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 on which to run your service.
|
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 |
setServiceName(String serviceName)
The name of your service.
|
void |
setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service.
|
void |
setTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CreateServiceRequest |
withClientToken(String clientToken)
Unique, case-sensitive 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 on which to run your service.
|
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 |
withDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
|
CreateServiceRequest |
withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started.
|
CreateServiceRequest |
withLaunchType(LaunchType launchType)
The launch type on which to run your service.
|
CreateServiceRequest |
withLaunchType(String launchType)
The launch type on which to run your service.
|
CreateServiceRequest |
withLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your service.
|
CreateServiceRequest |
withLoadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer 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 on which to run your service.
|
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 |
withServiceName(String serviceName)
The name of your service.
|
CreateServiceRequest |
withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service.
|
CreateServiceRequest |
withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service.
|
CreateServiceRequest |
withTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full ARN of the task
definition to run in your service. |
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 on which to run your service. 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 on which to run your service. 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 on which to run your service. 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 on which to run your service. 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 on which to run your service. 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, hyphens, and underscores 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, hyphens, and underscores
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, hyphens, and underscores 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, hyphens, and underscores 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, hyphens, and underscores
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
is not specified, the latest ACTIVE
revision is used.
taskDefinition
- The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the latest
ACTIVE
revision is used.public String getTaskDefinition()
The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used.
family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the latest
ACTIVE
revision is used.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
is not specified, the latest ACTIVE
revision is used.
taskDefinition
- The family
and revision
(family:revision
) or full ARN of the task
definition to run in your service. If a revision
is not specified, the latest
ACTIVE
revision is used.public List<LoadBalancer> getLoadBalancers()
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
, because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers
are not supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
, because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public void setLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
, because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers
- A load balancer object representing the load balancer to use with your service. Currently, you are limited
to one load balancer or target group per service. After you create a service, the load balancer name or
target group ARN, container name, and container port specified in the service definition are
immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers
are not supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
, because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public CreateServiceRequest withLoadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
, because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
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 balancer to use with your service. Currently, you are limited
to one load balancer or target group per service. After you create a service, the load balancer name or
target group ARN, container name, and container port specified in the service definition are
immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers
are not supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
, because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public CreateServiceRequest withLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip
as the
target type, not instance
, because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers
- A load balancer object representing the load balancer to use with your service. Currently, you are limited
to one load balancer or target group per service. After you create a service, the load balancer name or
target group ARN, container name, and container port specified in the service definition are
immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers
are not supported. Also, when you create any target groups for these services, you must choose
ip
as the target type, not instance
, because tasks that use the
awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2
instance.
public List<ServiceRegistry> getServiceRegistries()
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
public void setServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
serviceRegistries
- The details of the service discovery registries to assign to this service. For more information, see Service
Discovery. Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
public CreateServiceRequest withServiceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
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 registries to assign to this service. For more information, see Service
Discovery. Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
public CreateServiceRequest withServiceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
serviceRegistries
- The details of the service discovery registries to assign to this service. For more information, see Service
Discovery. Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
public void setDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
desiredCount
- The number of instantiations of the specified task definition to place and keep running on your cluster.public Integer getDesiredCount()
The number of instantiations of the specified task definition to place and keep running on your cluster.
public CreateServiceRequest withDesiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
desiredCount
- The number of instantiations of the specified task definition to place and keep running on your cluster.public void setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32
ASCII characters are allowed.public String getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
public CreateServiceRequest withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32
ASCII characters are allowed.public void setLaunchType(String launchType)
The launch type on which to run your service.
launchType
- The launch type on which to run your service.LaunchType
public String getLaunchType()
The launch type on which to run your service.
LaunchType
public CreateServiceRequest withLaunchType(String launchType)
The launch type on which to run your service.
launchType
- The launch type on which to run your service.LaunchType
public CreateServiceRequest withLaunchType(LaunchType launchType)
The launch type on which to run your service.
launchType
- The launch type on which to run your service.LaunchType
public void setPlatformVersion(String platformVersion)
The platform version on which to run your service. If one is not specified, the latest version is used by default.
platformVersion
- The platform version on which to run your service. If one is not specified, the latest version is used by
default.public String getPlatformVersion()
The platform version on which to run your service. If one is not specified, the latest version is used by default.
public CreateServiceRequest withPlatformVersion(String platformVersion)
The platform version on which to run your service. If one is not specified, the latest version is used by default.
platformVersion
- The platform version on which to run your service. If one is not specified, the latest version is used by
default.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 does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your
service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc
network mode, in which case you should not specify a role here. For more information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this
is recommended) or prefix the role name with the path. For example, if a role with the name bar
has
a path of /foo/
then you would specify /foo/bar
as the role name. For more information,
see Friendly Names and Paths in the IAM User Guide.
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 does not use the awsvpc
network mode. If you specify the
role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for
your service unless you specify a role here. The service-linked role is required if your task definition
uses the awsvpc
network mode, in which case you should not specify a role here. For more
information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role
ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name
bar
has a path of /foo/
then you would specify /foo/bar
as the role
name. For more information, see Friendly Names and Paths in the IAM User Guide.
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 does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your
service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc
network mode, in which case you should not specify a role here. For more information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this
is recommended) or prefix the role name with the path. For example, if a role with the name bar
has
a path of /foo/
then you would specify /foo/bar
as the role name. For more information,
see Friendly Names and Paths in the IAM User Guide.
awsvpc
network mode. If you specify the
role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for
your service unless you specify a role here. The service-linked role is required if your task definition
uses the awsvpc
network mode, in which case you should not specify a role here. For more
information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role
ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name
bar
has a path of /foo/
then you would specify /foo/bar
as the
role name. For more information, see Friendly Names and Paths in the IAM User Guide.
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 does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your
service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc
network mode, in which case you should not specify a role here. For more information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this
is recommended) or prefix the role name with the path. For example, if a role with the name bar
has
a path of /foo/
then you would specify /foo/bar
as the role name. For more information,
see Friendly Names and Paths in the IAM User Guide.
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 does not use the awsvpc
network mode. If you specify the
role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for
your service unless you specify a role here. The service-linked role is required if your task definition
uses the awsvpc
network mode, in which case you should not specify a role here. For more
information, see Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role
ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name
bar
has a path of /foo/
then you would specify /foo/bar
as the role
name. For more information, see Friendly Names and Paths in the IAM User Guide.
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 per task (this limit includes constraints in the task definition and those specified at run time).
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 per task (this limit includes constraints in the task definition and those specified at run time).
placementConstraints
- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
constraints per task (this limit includes constraints in the task definition and those specified at run
time).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 per task (this limit includes constraints in the task definition and those specified at run time).
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 per task (this limit includes constraints in the task definition and those specified at run
time).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 per task (this limit includes constraints in the task definition and those specified at run time).
placementConstraints
- An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
constraints per task (this limit includes constraints in the task definition and those specified at run
time).public List<PlacementStrategy> getPlacementStrategy()
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of five
strategy rules per service.public CreateServiceRequest withPlacementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per 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 five
strategy rules per service.public CreateServiceRequest withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of five
strategy rules per 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 is not 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 is not 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 is not 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 is not 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 is not 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 is not 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 should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. 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 7,200 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS 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 should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started. This is only valid if your service is
configured to use a load balancer. 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 7,200 seconds during
which the ECS service scheduler ignores health check status. This grace period can prevent the ECS 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 should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. 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 7,200 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS 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 should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. 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 7,200 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS 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 should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started. This is only valid if your service is
configured to use a load balancer. 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 7,200 seconds during
which the ECS service scheduler ignores health check status. This grace period can prevent the ECS 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.
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. When using this strategy,
there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling
policies.
Fargate tasks do not 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.
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. When using
this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use
Service Auto Scaling policies.
Fargate tasks do not 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.
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. When using this strategy,
there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling
policies.
Fargate tasks do not 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.
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. When using
this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use
Service Auto Scaling policies.
Fargate tasks do not 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.
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. When using this strategy,
there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling
policies.
Fargate tasks do not 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.
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. When using
this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use
Service Auto Scaling policies.
Fargate tasks do not 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.
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. When using this strategy,
there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling
policies.
Fargate tasks do not 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.
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. When using
this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use
Service Auto Scaling policies.
Fargate tasks do not support the DAEMON
scheduling strategy.
SchedulingStrategy
public String toString()
toString
in class Object
Object.toString()
public CreateServiceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.