You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ECS::Types::CreateServiceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Note:

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,
    },
  ],
  desired_count: 1, # required
  client_token: "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",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#clusterString

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:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#deployment_configurationTypes::DeploymentConfiguration

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#desired_countInteger

The number of instantiations of the specified task definition to place and keep running on your cluster.

Returns:

  • (Integer)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#load_balancersArray<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 Elastic Load Balancing 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 Elastic Load Balancing Application 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.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#placement_constraintsArray<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).

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#placement_strategyArray<Types::PlacementStrategy>

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#roleString

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#service_nameString

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#task_definitionString

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1133

class CreateServiceRequest < Struct.new(
  :cluster,
  :service_name,
  :task_definition,
  :load_balancers,
  :desired_count,
  :client_token,
  :role,
  :deployment_configuration,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end