Class: Aws::ECS::Types::CreateServiceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::CreateServiceRequest
- Defined in:
- gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>
The capacity provider strategy to use for the service.
-
#client_token ⇒ String
An 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 that you run your service on.
-
#deployment_configuration ⇒ Types::DeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
-
#deployment_controller ⇒ Types::DeploymentController
The deployment controller to use for the service.
-
#desired_count ⇒ Integer
The number of instantiations of the specified task definition to place and keep running in your service.
-
#enable_ecs_managed_tags ⇒ Boolean
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
-
#enable_execute_command ⇒ Boolean
Determines whether the execute command functionality is turned on for the service.
-
#health_check_grace_period_seconds ⇒ Integer
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
-
#launch_type ⇒ String
The infrastructure that you run your service on.
-
#load_balancers ⇒ Array<Types::LoadBalancer>
A load balancer object representing the load balancers 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 that your tasks in the service are running on.
-
#propagate_tags ⇒ String
Specifies whether to propagate the tags from the task definition to the task.
-
#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_connect_configuration ⇒ Types::ServiceConnectConfiguration
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
-
#service_name ⇒ String
The name of your service.
-
#service_registries ⇒ Array<Types::ServiceRegistry>
The details of the service discovery registry to associate with this service.
-
#tags ⇒ Array<Types::Tag>
The metadata that you apply to the service to help you categorize and organize them.
-
#task_definition ⇒ String
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service. -
#volume_configurations ⇒ Array<Types::ServiceVolumeConfiguration>
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
Instance Attribute Details
#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>
The capacity provider strategy to use for the service.
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.
A capacity provider strategy may contain a maximum of 6 capacity providers.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#client_token ⇒ String
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#cluster ⇒ String
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#deployment_controller ⇒ Types::DeploymentController
The deployment controller to use for the service. If no deployment
controller is specified, the default value of ECS
is used.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#desired_count ⇒ Integer
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy
is REPLICA
or isn't
specified. If schedulingStrategy
is DAEMON
then this isn't
required.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#enable_ecs_managed_tags ⇒ Boolean
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the
propagateTags
request parameter.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#enable_execute_command ⇒ Boolean
Determines whether the execute command functionality is turned on
for the service. If true
, this enables execute command
functionality on all containers in the service tasks.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#health_check_grace_period_seconds ⇒ Integer
The period of time, in seconds, that the Amazon ECS service
scheduler ignores 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 you do not use an Elastic Load Balancing, we recommend that you
use the startPeriod
in the task definition health check
parameters. For more information, see Health check.
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 (about 69 years). 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.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#launch_type ⇒ String
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE
launch type runs your tasks on Fargate On-Demand
infrastructure.
The EC2
launch type runs your tasks on Amazon EC2 instances
registered to your cluster.
The EXTERNAL
launch type runs your tasks on your on-premises
server or virtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider
strategy. If a launchType
is specified, the
capacityProviderStrategy
parameter must be omitted.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#load_balancers ⇒ Array<Types::LoadBalancer>
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 uses the rolling update (ECS
) deployment controller
and using either an Application Load Balancer or Network Load
Balancer, you must specify one or more target group ARNs to attach
to the service. The service-linked role is required for services
that use 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 uses the CODE_DEPLOY
deployment controller, the
service is required to use either an Application Load Balancer or
Network Load Balancer. When creating an CodeDeploy deployment group,
you specify two target groups (referred to as a targetGroupPair
).
During a deployment, CodeDeploy determines which task set in your
service has the status PRIMARY
, and it associates one target group
with it. Then, it also 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 you can use to perform validation tests with
Lambda functions before routing production traffic to it.
If you use 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, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's 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 aren't
supported. Also, when you create any target groups for these
services, you must choose ip
as the target type, not instance
.
This is because tasks that use the awsvpc
network mode are
associated with an elastic network interface, not an Amazon EC2
instance.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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 isn't supported
for other network modes. For more information, see Task
networking in the Amazon Elastic Container Service Developer
Guide.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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 for each task. This limit includes constraints in the task definition and those specified at runtime.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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 5 strategy rules for each service.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#platform_version ⇒ String
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. For more information, see Fargate platform versions in
the Amazon Elastic Container Service Developer Guide.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#propagate_tags ⇒ String
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than NONE
when you use Cost
Explorer. For more information, see Amazon ECS usage reports in
the Amazon Elastic Container Service Developer Guide.
The default is NONE
.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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 doesn't 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 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
don't 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.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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. This scheduler strategy is required if the service uses theCODE_DEPLOY
orEXTERNAL
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 don't 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
orEXTERNAL
deployment controller types don't support theDAEMON
scheduling strategy.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#service_connect_configuration ⇒ Types::ServiceConnectConfiguration
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#service_name ⇒ String
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, 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.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#service_registries ⇒ Array<Types::ServiceRegistry>
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
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 Amazon Web Services 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.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] 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
isn't
specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service uses either the
ECS
or CODE_DEPLOY
deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |
#volume_configurations ⇒ Array<Types::ServiceVolumeConfiguration>
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3000 class CreateServiceRequest < Struct.new( :cluster, :service_name, :task_definition, :load_balancers, :service_registries, :desired_count, :client_token, :launch_type, :capacity_provider_strategy, :platform_version, :role, :deployment_configuration, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy, :deployment_controller, :tags, :enable_ecs_managed_tags, :propagate_tags, :enable_execute_command, :service_connect_configuration, :volume_configurations) SENSITIVE = [] include Aws::Structure end |