@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 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.
|
List<LoadBalancer> |
getLoadBalancers()
A load balancer object representing the load balancer to use with your 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 |
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 |
getServiceName()
The name of your service.
|
String |
getTaskDefinition()
The
family and revision (family:revision ) or full Amazon Resource Name
(ARN) of the task definition to run in your service. |
int |
hashCode() |
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier 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 |
setLoadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your 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 |
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 |
setServiceName(String serviceName)
The name of your service.
|
void |
setTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full Amazon Resource Name
(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 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 |
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 |
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 |
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 |
withServiceName(String serviceName)
The name of your service.
|
CreateServiceRequest |
withTaskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full Amazon Resource Name
(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 Amazon Resource Name
(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 Amazon Resource
Name (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 Amazon Resource Name
(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 Amazon Resource
Name (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 Amazon Resource Name
(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 Amazon Resource
Name (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.
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.
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.
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.
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.
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.
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.
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.
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 you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
characters are allowed.public String getClientToken()
Unique, case-sensitive identifier 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 you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
characters are allowed.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 required if you are using a load balancer with your service. If you
specify the role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
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 required if you are using a load balancer with your
service. If you specify the role
parameter, you must also specify a load balancer object with
the loadBalancers
parameter.
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 required if you are using a load balancer with your service. If you
specify the role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
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
parameter, you must also specify a load balancer object
with the loadBalancers
parameter.
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 required if you are using a load balancer with your service. If you
specify the role
parameter, you must also specify a load balancer object with the
loadBalancers
parameter.
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 required if you are using a load balancer with your
service. If you specify the role
parameter, you must also specify a load balancer object with
the loadBalancers
parameter.
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 5 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 5 strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 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 5 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 5 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 5 strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy
rules per service.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.