Class CreateServiceRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.The number of instantiations of the specified task definition to place and keep running on your cluster.A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.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.The name of your service.Thefamily
andrevision
(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 list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.void
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) Thefamily
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service.toString()
Returns a string representation of this object; useful for testing and debugging.withClientToken
(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.withCluster
(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.withDeploymentConfiguration
(DeploymentConfiguration deploymentConfiguration) Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.withDesiredCount
(Integer desiredCount) The number of instantiations of the specified task definition to place and keep running on your cluster.withLoadBalancers
(LoadBalancer... loadBalancers) A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.withLoadBalancers
(Collection<LoadBalancer> loadBalancers) A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.The 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.withServiceName
(String serviceName) The name of your service.withTaskDefinition
(String taskDefinition) Thefamily
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateServiceRequest
public CreateServiceRequest()
-
-
Method Details
-
setCluster
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withCluster
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServiceName
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withServiceName
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskDefinition
The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.- Parameters:
taskDefinition
- Thefamily
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.
-
getTaskDefinition
The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.- Returns:
- The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.
-
withTaskDefinition
The
family
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.- Parameters:
taskDefinition
- Thefamily
andrevision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLoadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
- Returns:
- A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
-
setLoadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
- Parameters:
loadBalancers
- A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
-
withLoadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
NOTE: This method appends the values to the existing list (if any). Use
setLoadBalancers(java.util.Collection)
orwithLoadBalancers(java.util.Collection)
if you want to override the existing values.- Parameters:
loadBalancers
- A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLoadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
- Parameters:
loadBalancers
- A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDesiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
- Parameters:
desiredCount
- The number of instantiations of the specified task definition to place and keep running on your cluster.
-
getDesiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
- Returns:
- The number of instantiations of the specified task definition to place and keep running on your cluster.
-
withDesiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
- Parameters:
desiredCount
- The number of instantiations of the specified task definition to place and keep running on your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
-
getClientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- Returns:
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
-
withClientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRole
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 theloadBalancers
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 namebar
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.- Parameters:
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 therole
parameter, you must also specify a load balancer object with theloadBalancers
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 namebar
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.
-
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 theloadBalancers
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 namebar
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.- Returns:
- 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 theloadBalancers
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 namebar
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.
-
withRole
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 theloadBalancers
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 namebar
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.- Parameters:
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 therole
parameter, you must also specify a load balancer object with theloadBalancers
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 namebar
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- Parameters:
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
-
getDeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- Returns:
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
-
withDeploymentConfiguration
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.
- Parameters:
deploymentConfiguration
- Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-