Class: Aws::ECS::Types::CreateServiceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::CreateServiceRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
When making an API call, you may pass CreateServiceRequest data as a hash:
{
cluster: "String",
service_name: "String", # required
task_definition: "String", # required
load_balancers: [
{
target_group_arn: "String",
load_balancer_name: "String",
container_name: "String",
container_port: 1,
},
],
service_registries: [
{
registry_arn: "String",
port: 1,
container_name: "String",
container_port: 1,
},
],
desired_count: 1,
client_token: "String",
launch_type: "EC2", # accepts EC2, FARGATE
platform_version: "String",
role: "String",
deployment_configuration: {
maximum_percent: 1,
minimum_healthy_percent: 1,
},
placement_constraints: [
{
type: "distinctInstance", # accepts distinctInstance, memberOf
expression: "String",
},
],
placement_strategy: [
{
type: "random", # accepts random, spread, binpack
field: "String",
},
],
network_configuration: {
awsvpc_configuration: {
subnets: ["String"], # required
security_groups: ["String"],
assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
},
},
health_check_grace_period_seconds: 1,
scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#cluster ⇒ String
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.
-
#deployment_configuration ⇒ Types::DeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
-
#desired_count ⇒ Integer
The number of instantiations of the specified task definition to place and keep running on your cluster.
-
#health_check_grace_period_seconds ⇒ Integer
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.
-
#launch_type ⇒ String
The launch type on which to run your service.
-
#load_balancers ⇒ Array<Types::LoadBalancer>
A load balancer object representing the load balancer to use with your service.
-
#network_configuration ⇒ Types::NetworkConfiguration
The network configuration for the service.
-
#placement_constraints ⇒ Array<Types::PlacementConstraint>
An array of placement constraint objects to use for tasks in your service.
-
#placement_strategy ⇒ Array<Types::PlacementStrategy>
The placement strategy objects to use for tasks in your service.
-
#platform_version ⇒ String
The platform version on which to run your service.
-
#role ⇒ String
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.
-
#scheduling_strategy ⇒ String
The scheduling strategy to use for the service.
-
#service_name ⇒ String
The name of your service.
-
#service_registries ⇒ Array<Types::ServiceRegistry>
The details of the service discovery registries you want to assign to this service.
-
#task_definition ⇒ String
The ‘family` and `revision` (`family:revision`) or full ARN of the task definition to run in your service.
Instance Attribute Details
#client_token ⇒ String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#cluster ⇒ String
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.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#deployment_configuration ⇒ Types::DeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#desired_count ⇒ Integer
The number of instantiations of the specified task definition to place and keep running on your cluster.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#health_check_grace_period_seconds ⇒ Integer
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.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#launch_type ⇒ String
The launch type on which to run your service.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#load_balancers ⇒ Array<Types::LoadBalancer>
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the ‘awsvpc` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose `ip` as the target type, not `instance`, because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#network_configuration ⇒ Types::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*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#placement_constraints ⇒ Array<Types::PlacementConstraint>
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).
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#placement_strategy ⇒ Array<Types::PlacementStrategy>
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#platform_version ⇒ String
The platform version on which to run your service. If one is not specified, the latest version is used by default.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#role ⇒ String
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*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#scheduling_strategy ⇒ String
The scheduling strategy to use for the service. For more information, see [Services].
There are two service scheduler strategies available:
-
‘REPLICA`-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
-
‘DAEMON`-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
<note markdown=“1”> Fargate tasks do not support the ‘DAEMON` scheduling strategy.
</note>
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#service_name ⇒ String
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.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#service_registries ⇒ Array<Types::ServiceRegistry>
The details of the service discovery registries you want to assign to this service. For more information, see [Service Discovery].
<note markdown=“1”> Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see [AWS Fargate Platform Versions].
</note>
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#task_definition ⇒ String
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.
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 |
# File 'lib/aws-sdk-ecs/types.rb', line 1603 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |