CreateServiceRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ecs.model.EcsRequest
    - - software.amazon.awssdk.services.ecs.model.CreateServiceRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateServiceRequest
extends EcsRequest
implements ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateServiceRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateServiceRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateServiceRequest.Builder`	`builder()`
`List<CapacityProviderStrategyItem>`	`capacityProviderStrategy()` The capacity provider strategy to use for the service.
`String`	`clientToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`cluster()` The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.
`DeploymentConfiguration`	`deploymentConfiguration()` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`DeploymentController`	`deploymentController()` The deployment controller to use for the service.
`Integer`	`desiredCount()` The number of instantiations of the specified task definition to place and keep running on your cluster.
`Boolean`	`enableECSManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasCapacityProviderStrategy()` Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLoadBalancers()` Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPlacementConstraints()` Returns true if the PlacementConstraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPlacementStrategy()` Returns true if the PlacementStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasServiceRegistries()` Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`healthCheckGracePeriodSeconds()` The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started.
`LaunchType`	`launchType()` The launch type on which to run your service.
`String`	`launchTypeAsString()` The launch type on which to run your service.
`List<LoadBalancer>`	`loadBalancers()` A load balancer object representing the load balancers to use with your service.
`NetworkConfiguration`	`networkConfiguration()` The network configuration for the service.
`List<PlacementConstraint>`	`placementConstraints()` An array of placement constraint objects to use for tasks in your service.
`List<PlacementStrategy>`	`placementStrategy()` The placement strategy objects to use for tasks in your service.
`String`	`platformVersion()` The platform version that your tasks in the service are running on.
`PropagateTags`	`propagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`String`	`propagateTagsAsString()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`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.
`SchedulingStrategy`	`schedulingStrategy()` The scheduling strategy to use for the service.
`String`	`schedulingStrategyAsString()` The scheduling strategy to use for the service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateServiceRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceName()` The name of your service.
`List<ServiceRegistry>`	`serviceRegistries()` The details of the service discovery registries to assign to this service.
`List<Tag>`	`tags()` The metadata that you apply to the service to help you categorize and organize them.
`String`	`taskDefinition()` The `family` and `revision` (`family:revision`) or full ARN of the task definition to run in your service.
`CreateServiceRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - cluster
```
public 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.
    
    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.
  - serviceName
```
public String serviceName()
```
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
    
    Returns:
    
    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
  - taskDefinition
```
public String taskDefinition()
```
    The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
    
    A task definition must be specified if the service is using the ECS deployment controller.
    
    Returns:
    
    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.
    
    A task definition must be specified if the service is using the ECS deployment controller.
  - hasLoadBalancers
```
public boolean hasLoadBalancers()
```
    Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - loadBalancers
```
public List<LoadBalancer> loadBalancers()
```
    A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
    
    If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
    
    If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
    
    After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
    
    For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (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.
    
    Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLoadBalancers() to see if a value was sent in this field.
    
    Returns:
    
    A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
    
    If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
    
    If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
    
    After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
    
    For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (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.
    
    Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
  - hasServiceRegistries
```
public boolean hasServiceRegistries()
```
    Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - serviceRegistries
```
public List<ServiceRegistry> serviceRegistries()
```
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasServiceRegistries() to see if a value was sent in this field.
    
    Returns:
    
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
  - desiredCount
```
public Integer desiredCount()
```
    The number of instantiations of the specified task definition to place and keep running on your cluster.
    
    This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.
    
    Returns:
    
    The number of instantiations of the specified task definition to place and keep running on your cluster.
    
    This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.
  - clientToken
```
public String clientToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
  - launchType
```
public LaunchType launchType()
```
    The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    See Also:
    
    LaunchType
  - launchTypeAsString
```
public String launchTypeAsString()
```
    The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    See Also:
    
    LaunchType
  - hasCapacityProviderStrategy
```
public boolean hasCapacityProviderStrategy()
```
    Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - capacityProviderStrategy
```
public List<CapacityProviderStrategyItem> capacityProviderStrategy()
```
    The capacity provider strategy to use for the service.
    
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    
    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
    
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    
    To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCapacityProviderStrategy() to see if a value was sent in this field.
    
    Returns:
    
    The capacity provider strategy to use for the service.
    
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    
    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
    
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    
    To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - platformVersion
```
public String platformVersion()
```
    The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - role
```
public String role()
```
    The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
    
    If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you 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.
    
    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 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 or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you 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.
  - deploymentConfiguration
```
public DeploymentConfiguration deploymentConfiguration()
```
    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.
  - hasPlacementConstraints
```
public boolean hasPlacementConstraints()
```
    Returns true if the PlacementConstraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - placementConstraints
```
public List<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 runtime).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPlacementConstraints() to see if a value was sent in this field.
    
    Returns:
    
    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 runtime).
  - hasPlacementStrategy
```
public boolean hasPlacementStrategy()
```
    Returns true if the PlacementStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - placementStrategy
```
public List<PlacementStrategy> placementStrategy()
```
    The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPlacementStrategy() to see if a value was sent in this field.
    
    Returns:
    
    The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
  - networkConfiguration
```
public 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.
    
    Returns:
    
    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.
  - healthCheckGracePeriodSeconds
```
public Integer healthCheckGracePeriodSeconds()
```
    The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
    
    If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
    
    Returns:
    
    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 used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
    
    If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
  - schedulingStrategy
```
public SchedulingStrategy schedulingStrategy()
```
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    - REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
    - DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
      
      Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return SchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().
    Returns:
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    
    REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
    
    DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
    
    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    See Also:
    
    SchedulingStrategy
  - schedulingStrategyAsString
```
public String schedulingStrategyAsString()
```
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    - REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
    - DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
      
      Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return SchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().
    Returns:
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    
    REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
    
    DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
    
    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    See Also:
    
    SchedulingStrategy
  - deploymentController
```
public DeploymentController deploymentController()
```
    The deployment controller to use for the service.
    
    Returns:
    
    The deployment controller to use for the service.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<Tag> tags()
```
    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    Returns:
    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - enableECSManagedTags
```
public Boolean enableECSManagedTags()
```
    Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
  - propagateTags
```
public PropagateTags propagateTags()
```
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
    
    See Also:
    
    PropagateTags
  - propagateTagsAsString
```
public String propagateTagsAsString()
```
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
    
    See Also:
    
    PropagateTags
  - toBuilder
```
public CreateServiceRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
    
    Specified by:
    
    toBuilder in class EcsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateServiceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateServiceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.18

Class CreateServiceRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

cluster

serviceName

taskDefinition

hasLoadBalancers

loadBalancers

hasServiceRegistries

serviceRegistries

desiredCount

clientToken

launchType

launchTypeAsString

hasCapacityProviderStrategy

capacityProviderStrategy

platformVersion

role

deploymentConfiguration

hasPlacementConstraints

placementConstraints

hasPlacementStrategy

placementStrategy

networkConfiguration

healthCheckGracePeriodSeconds

schedulingStrategy

schedulingStrategyAsString

deploymentController

hasTags

tags

enableECSManagedTags

propagateTags

propagateTagsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.