com.amazonaws.services.ecs.model.CreateServiceRequest Maven / Gradle / Ivy
/*
* Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateServiceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String cluster;
/**
*
* 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.
*
*/
private String serviceName;
/**
*
* 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.
*
*/
private String taskDefinition;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList loadBalancers;
/**
*
* The details of the service discovery registries you want to assign to this service. For more information, see Service Discovery.
*
*/
private com.amazonaws.internal.SdkInternalList serviceRegistries;
/**
*
* The number of instantiations of the specified task definition to place and keep running on your cluster.
*
*/
private Integer desiredCount;
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters
* are allowed.
*
*/
private String clientToken;
/**
*
* The launch type on which to run your service.
*
*/
private String launchType;
/**
*
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*
*/
private String platformVersion;
/**
*
* 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.
*
*/
private String role;
/**
*
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
* and starting tasks.
*
*/
private DeploymentConfiguration deploymentConfiguration;
/**
*
* 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).
*
*/
private com.amazonaws.internal.SdkInternalList placementConstraints;
/**
*
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules
* per service.
*
*/
private com.amazonaws.internal.SdkInternalList placementStrategy;
/**
*
* 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.
*
*/
private NetworkConfiguration networkConfiguration;
/**
*
* 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 1,800 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.
*
*/
private Integer healthCheckGracePeriodSeconds;
/**
*
* 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.
*
*
* @param 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 setCluster(String cluster) {
this.cluster = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withCluster(String cluster) {
setCluster(cluster);
return this;
}
/**
*
* 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.
*
*
* @param 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 setServiceName(String serviceName) {
this.serviceName = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withServiceName(String serviceName) {
setServiceName(serviceName);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setTaskDefinition(String taskDefinition) {
this.taskDefinition = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withTaskDefinition(String taskDefinition) {
setTaskDefinition(taskDefinition);
return this;
}
/**
*
* 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.
*
*
* @return 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 java.util.List getLoadBalancers() {
if (loadBalancers == null) {
loadBalancers = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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 setLoadBalancers(java.util.Collection loadBalancers) {
if (loadBalancers == null) {
this.loadBalancers = null;
return;
}
this.loadBalancers = new com.amazonaws.internal.SdkInternalList(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
* {@link #setLoadBalancers(java.util.Collection)} or {@link #withLoadBalancers(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withLoadBalancers(LoadBalancer... loadBalancers) {
if (this.loadBalancers == null) {
setLoadBalancers(new com.amazonaws.internal.SdkInternalList(loadBalancers.length));
}
for (LoadBalancer ele : loadBalancers) {
this.loadBalancers.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withLoadBalancers(java.util.Collection loadBalancers) {
setLoadBalancers(loadBalancers);
return this;
}
/**
*
* The details of the service discovery registries you want to assign to this service. For more information, see Service Discovery.
*
*
* @return The details of the service discovery registries you want to assign to this service. For more information,
* see Service
* Discovery.
*/
public java.util.List getServiceRegistries() {
if (serviceRegistries == null) {
serviceRegistries = new com.amazonaws.internal.SdkInternalList();
}
return serviceRegistries;
}
/**
*
* The details of the service discovery registries you want to assign to this service. For more information, see Service Discovery.
*
*
* @param serviceRegistries
* The details of the service discovery registries you want to assign to this service. For more information,
* see Service
* Discovery.
*/
public void setServiceRegistries(java.util.Collection serviceRegistries) {
if (serviceRegistries == null) {
this.serviceRegistries = null;
return;
}
this.serviceRegistries = new com.amazonaws.internal.SdkInternalList(serviceRegistries);
}
/**
*
* The details of the service discovery registries you want to assign to this service. For more information, see Service Discovery.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setServiceRegistries(java.util.Collection)} or {@link #withServiceRegistries(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param serviceRegistries
* The details of the service discovery registries you want to assign to this service. For more information,
* see Service
* Discovery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withServiceRegistries(ServiceRegistry... serviceRegistries) {
if (this.serviceRegistries == null) {
setServiceRegistries(new com.amazonaws.internal.SdkInternalList(serviceRegistries.length));
}
for (ServiceRegistry ele : serviceRegistries) {
this.serviceRegistries.add(ele);
}
return this;
}
/**
*
* The details of the service discovery registries you want to assign to this service. For more information, see Service Discovery.
*
*
* @param serviceRegistries
* The details of the service discovery registries you want to assign to this service. For more information,
* see Service
* Discovery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withServiceRegistries(java.util.Collection serviceRegistries) {
setServiceRegistries(serviceRegistries);
return this;
}
/**
*
* The number of instantiations of the specified task definition to place and keep running on your cluster.
*
*
* @param desiredCount
* The number of instantiations of the specified task definition to place and keep running on your cluster.
*/
public void setDesiredCount(Integer desiredCount) {
this.desiredCount = desiredCount;
}
/**
*
* The number of instantiations of the specified task definition to place and keep running on your cluster.
*
*
* @return The number of instantiations of the specified task definition to place and keep running on your cluster.
*/
public Integer getDesiredCount() {
return this.desiredCount;
}
/**
*
* The number of instantiations of the specified task definition to place and keep running on your cluster.
*
*
* @param desiredCount
* The number of instantiations of the specified task definition to place and keep running on your cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withDesiredCount(Integer desiredCount) {
setDesiredCount(desiredCount);
return this;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters
* are allowed.
*
*
* @param clientToken
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
* characters are allowed.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters
* are allowed.
*
*
* @return Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
* characters are allowed.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters
* are allowed.
*
*
* @param clientToken
* Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
* characters are allowed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The launch type on which to run your service.
*
*
* @param launchType
* The launch type on which to run your service.
* @see LaunchType
*/
public void setLaunchType(String launchType) {
this.launchType = launchType;
}
/**
*
* The launch type on which to run your service.
*
*
* @return The launch type on which to run your service.
* @see LaunchType
*/
public String getLaunchType() {
return this.launchType;
}
/**
*
* The launch type on which to run your service.
*
*
* @param launchType
* The launch type on which to run your service.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public CreateServiceRequest withLaunchType(String launchType) {
setLaunchType(launchType);
return this;
}
/**
*
* The launch type on which to run your service.
*
*
* @param launchType
* The launch type on which to run your service.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public CreateServiceRequest withLaunchType(LaunchType launchType) {
this.launchType = launchType.toString();
return this;
}
/**
*
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*
*
* @param platformVersion
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*/
public void setPlatformVersion(String platformVersion) {
this.platformVersion = platformVersion;
}
/**
*
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*
*
* @return The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*/
public String getPlatformVersion() {
return this.platformVersion;
}
/**
*
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
*
*
* @param platformVersion
* The platform version on which to run your service. If one is not specified, the latest version is used by
* default.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withPlatformVersion(String platformVersion) {
setPlatformVersion(platformVersion);
return this;
}
/**
*
* 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.
*
*
* @param 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 setRole(String role) {
this.role = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withRole(String role) {
setRole(role);
return this;
}
/**
*
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
* and starting tasks.
*
*
* @param deploymentConfiguration
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of
* stopping and starting tasks.
*/
public void setDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) {
this.deploymentConfiguration = deploymentConfiguration;
}
/**
*
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
* and starting tasks.
*
*
* @return Optional deployment parameters that control how many tasks run during the deployment and the ordering of
* stopping and starting tasks.
*/
public DeploymentConfiguration getDeploymentConfiguration() {
return this.deploymentConfiguration;
}
/**
*
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping
* and starting tasks.
*
*
* @param deploymentConfiguration
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of
* stopping and starting tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration) {
setDeploymentConfiguration(deploymentConfiguration);
return this;
}
/**
*
* 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).
*
*
* @return 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 java.util.List getPlacementConstraints() {
if (placementConstraints == null) {
placementConstraints = new com.amazonaws.internal.SdkInternalList();
}
return 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).
*
*
* @param 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 void setPlacementConstraints(java.util.Collection placementConstraints) {
if (placementConstraints == null) {
this.placementConstraints = null;
return;
}
this.placementConstraints = new com.amazonaws.internal.SdkInternalList(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
* {@link #setPlacementConstraints(java.util.Collection)} or {@link #withPlacementConstraints(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withPlacementConstraints(PlacementConstraint... placementConstraints) {
if (this.placementConstraints == null) {
setPlacementConstraints(new com.amazonaws.internal.SdkInternalList(placementConstraints.length));
}
for (PlacementConstraint ele : placementConstraints) {
this.placementConstraints.add(ele);
}
return this;
}
/**
*
* 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withPlacementConstraints(java.util.Collection placementConstraints) {
setPlacementConstraints(placementConstraints);
return this;
}
/**
*
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules
* per service.
*
*
* @return The placement strategy objects to use for tasks in your service. You can specify a maximum of five
* strategy rules per service.
*/
public java.util.List getPlacementStrategy() {
if (placementStrategy == null) {
placementStrategy = new com.amazonaws.internal.SdkInternalList();
}
return placementStrategy;
}
/**
*
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules
* per service.
*
*
* @param 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 setPlacementStrategy(java.util.Collection placementStrategy) {
if (placementStrategy == null) {
this.placementStrategy = null;
return;
}
this.placementStrategy = new com.amazonaws.internal.SdkInternalList(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
* {@link #setPlacementStrategy(java.util.Collection)} or {@link #withPlacementStrategy(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param placementStrategy
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five
* strategy rules per service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withPlacementStrategy(PlacementStrategy... placementStrategy) {
if (this.placementStrategy == null) {
setPlacementStrategy(new com.amazonaws.internal.SdkInternalList(placementStrategy.length));
}
for (PlacementStrategy ele : placementStrategy) {
this.placementStrategy.add(ele);
}
return this;
}
/**
*
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules
* per service.
*
*
* @param placementStrategy
* The placement strategy objects to use for tasks in your service. You can specify a maximum of five
* strategy rules per service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withPlacementStrategy(java.util.Collection placementStrategy) {
setPlacementStrategy(placementStrategy);
return this;
}
/**
*
* 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.
*
*
* @param 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 setNetworkConfiguration(NetworkConfiguration networkConfiguration) {
this.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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withNetworkConfiguration(NetworkConfiguration networkConfiguration) {
setNetworkConfiguration(networkConfiguration);
return this;
}
/**
*
* 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 1,800 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.
*
*
* @param 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 1,800 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 setHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds) {
this.healthCheckGracePeriodSeconds = 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 1,800 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.
*
*
* @return 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 1,800 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() {
return this.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 1,800 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.
*
*
* @param 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 1,800 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withHealthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds) {
setHealthCheckGracePeriodSeconds(healthCheckGracePeriodSeconds);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCluster() != null)
sb.append("Cluster: ").append(getCluster()).append(",");
if (getServiceName() != null)
sb.append("ServiceName: ").append(getServiceName()).append(",");
if (getTaskDefinition() != null)
sb.append("TaskDefinition: ").append(getTaskDefinition()).append(",");
if (getLoadBalancers() != null)
sb.append("LoadBalancers: ").append(getLoadBalancers()).append(",");
if (getServiceRegistries() != null)
sb.append("ServiceRegistries: ").append(getServiceRegistries()).append(",");
if (getDesiredCount() != null)
sb.append("DesiredCount: ").append(getDesiredCount()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getLaunchType() != null)
sb.append("LaunchType: ").append(getLaunchType()).append(",");
if (getPlatformVersion() != null)
sb.append("PlatformVersion: ").append(getPlatformVersion()).append(",");
if (getRole() != null)
sb.append("Role: ").append(getRole()).append(",");
if (getDeploymentConfiguration() != null)
sb.append("DeploymentConfiguration: ").append(getDeploymentConfiguration()).append(",");
if (getPlacementConstraints() != null)
sb.append("PlacementConstraints: ").append(getPlacementConstraints()).append(",");
if (getPlacementStrategy() != null)
sb.append("PlacementStrategy: ").append(getPlacementStrategy()).append(",");
if (getNetworkConfiguration() != null)
sb.append("NetworkConfiguration: ").append(getNetworkConfiguration()).append(",");
if (getHealthCheckGracePeriodSeconds() != null)
sb.append("HealthCheckGracePeriodSeconds: ").append(getHealthCheckGracePeriodSeconds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateServiceRequest == false)
return false;
CreateServiceRequest other = (CreateServiceRequest) obj;
if (other.getCluster() == null ^ this.getCluster() == null)
return false;
if (other.getCluster() != null && other.getCluster().equals(this.getCluster()) == false)
return false;
if (other.getServiceName() == null ^ this.getServiceName() == null)
return false;
if (other.getServiceName() != null && other.getServiceName().equals(this.getServiceName()) == false)
return false;
if (other.getTaskDefinition() == null ^ this.getTaskDefinition() == null)
return false;
if (other.getTaskDefinition() != null && other.getTaskDefinition().equals(this.getTaskDefinition()) == false)
return false;
if (other.getLoadBalancers() == null ^ this.getLoadBalancers() == null)
return false;
if (other.getLoadBalancers() != null && other.getLoadBalancers().equals(this.getLoadBalancers()) == false)
return false;
if (other.getServiceRegistries() == null ^ this.getServiceRegistries() == null)
return false;
if (other.getServiceRegistries() != null && other.getServiceRegistries().equals(this.getServiceRegistries()) == false)
return false;
if (other.getDesiredCount() == null ^ this.getDesiredCount() == null)
return false;
if (other.getDesiredCount() != null && other.getDesiredCount().equals(this.getDesiredCount()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getLaunchType() == null ^ this.getLaunchType() == null)
return false;
if (other.getLaunchType() != null && other.getLaunchType().equals(this.getLaunchType()) == false)
return false;
if (other.getPlatformVersion() == null ^ this.getPlatformVersion() == null)
return false;
if (other.getPlatformVersion() != null && other.getPlatformVersion().equals(this.getPlatformVersion()) == false)
return false;
if (other.getRole() == null ^ this.getRole() == null)
return false;
if (other.getRole() != null && other.getRole().equals(this.getRole()) == false)
return false;
if (other.getDeploymentConfiguration() == null ^ this.getDeploymentConfiguration() == null)
return false;
if (other.getDeploymentConfiguration() != null && other.getDeploymentConfiguration().equals(this.getDeploymentConfiguration()) == false)
return false;
if (other.getPlacementConstraints() == null ^ this.getPlacementConstraints() == null)
return false;
if (other.getPlacementConstraints() != null && other.getPlacementConstraints().equals(this.getPlacementConstraints()) == false)
return false;
if (other.getPlacementStrategy() == null ^ this.getPlacementStrategy() == null)
return false;
if (other.getPlacementStrategy() != null && other.getPlacementStrategy().equals(this.getPlacementStrategy()) == false)
return false;
if (other.getNetworkConfiguration() == null ^ this.getNetworkConfiguration() == null)
return false;
if (other.getNetworkConfiguration() != null && other.getNetworkConfiguration().equals(this.getNetworkConfiguration()) == false)
return false;
if (other.getHealthCheckGracePeriodSeconds() == null ^ this.getHealthCheckGracePeriodSeconds() == null)
return false;
if (other.getHealthCheckGracePeriodSeconds() != null
&& other.getHealthCheckGracePeriodSeconds().equals(this.getHealthCheckGracePeriodSeconds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCluster() == null) ? 0 : getCluster().hashCode());
hashCode = prime * hashCode + ((getServiceName() == null) ? 0 : getServiceName().hashCode());
hashCode = prime * hashCode + ((getTaskDefinition() == null) ? 0 : getTaskDefinition().hashCode());
hashCode = prime * hashCode + ((getLoadBalancers() == null) ? 0 : getLoadBalancers().hashCode());
hashCode = prime * hashCode + ((getServiceRegistries() == null) ? 0 : getServiceRegistries().hashCode());
hashCode = prime * hashCode + ((getDesiredCount() == null) ? 0 : getDesiredCount().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getLaunchType() == null) ? 0 : getLaunchType().hashCode());
hashCode = prime * hashCode + ((getPlatformVersion() == null) ? 0 : getPlatformVersion().hashCode());
hashCode = prime * hashCode + ((getRole() == null) ? 0 : getRole().hashCode());
hashCode = prime * hashCode + ((getDeploymentConfiguration() == null) ? 0 : getDeploymentConfiguration().hashCode());
hashCode = prime * hashCode + ((getPlacementConstraints() == null) ? 0 : getPlacementConstraints().hashCode());
hashCode = prime * hashCode + ((getPlacementStrategy() == null) ? 0 : getPlacementStrategy().hashCode());
hashCode = prime * hashCode + ((getNetworkConfiguration() == null) ? 0 : getNetworkConfiguration().hashCode());
hashCode = prime * hashCode + ((getHealthCheckGracePeriodSeconds() == null) ? 0 : getHealthCheckGracePeriodSeconds().hashCode());
return hashCode;
}
@Override
public CreateServiceRequest clone() {
return (CreateServiceRequest) super.clone();
}
}