CfnServiceProps
- class aws_cdk.aws_ecs.CfnServiceProps(*, capacity_provider_strategy=None, cluster=None, deployment_configuration=None, deployment_controller=None, desired_count=None, enable_ecs_managed_tags=None, enable_execute_command=None, health_check_grace_period_seconds=None, launch_type=None, load_balancers=None, network_configuration=None, placement_constraints=None, placement_strategies=None, platform_version=None, propagate_tags=None, role=None, scheduling_strategy=None, service_connect_configuration=None, service_name=None, service_registries=None, tags=None, task_definition=None, volume_configurations=None)
Bases:
object
Properties for defining a
CfnService
.- Parameters:
capacity_provider_strategy (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CapacityProviderStrategyItemProperty
,Dict
[str
,Any
]]],None
]) – The capacity provider strategy to use for the service. If acapacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers.cluster (
Optional
[str
]) – 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.deployment_configuration (
Union
[IResolvable
,DeploymentConfigurationProperty
,Dict
[str
,Any
],None
]) – Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.deployment_controller (
Union
[IResolvable
,DeploymentControllerProperty
,Dict
[str
,Any
],None
]) – The deployment controller to use for the service. If no deployment controller is specified, the default value ofECS
is used.desired_count (
Union
[int
,float
,None
]) – The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of1
is used. When using theDAEMON
scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation.enable_ecs_managed_tags (
Union
[bool
,IResolvable
,None
]) – 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 thepropagateTags
request parameter.enable_execute_command (
Union
[bool
,IResolvable
,None
]) – Determines whether the execute command functionality is turned on for the service. Iftrue
, the execute command functionality is turned on for all containers in tasks as part of the service.health_check_grace_period_seconds (
Union
[int
,float
,None
]) – 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 of0
is used. If you do not use an Elastic Load Balancing, we recommend that you use thestartPeriod
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.launch_type (
Optional
[str
]) – 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 .load_balancers (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,LoadBalancerProperty
,Dict
[str
,Any
]]],None
]) – A list of load balancer objects to associate with the service. If you specify theRole
property,LoadBalancers
must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .network_configuration (
Union
[IResolvable
,NetworkConfigurationProperty
,Dict
[str
,Any
],None
]) – The network configuration for the service. This parameter is required for task definitions that use theawsvpc
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 .placement_constraints (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PlacementConstraintProperty
,Dict
[str
,Any
]]],None
]) – 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.placement_strategies (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PlacementStrategyProperty
,Dict
[str
,Any
]]],None
]) – The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.platform_version (
Optional
[str
]) – 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, theLATEST
platform version is used. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide . Default: - “LATEST”propagate_tags (
Optional
[str
]) – 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 thanNONE
when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide . The default isNONE
.role (
Optional
[str
]) – 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 theawsvpc
network mode. If you specify therole
parameter, you must also specify a load balancer object with theloadBalancers
parameter. .. epigraph:: 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 theawsvpc
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 namebar
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 .scheduling_strategy (
Optional
[str
]) – 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. .. epigraph:: Tasks using the Fargate launch type or theCODE_DEPLOY
orEXTERNAL
deployment controller types don’t support theDAEMON
scheduling strategy.service_connect_configuration (
Union
[IResolvable
,ServiceConnectConfigurationProperty
,Dict
[str
,Any
],None
]) – 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 .service_name (
Optional
[str
]) – 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. .. epigraph:: The stack update fails if you change any properties that require replacement and theServiceName
is configured. This is because AWS CloudFormation creates the replacement service first, but eachServiceName
must be unique in the cluster.service_registries (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ServiceRegistryProperty
,Dict
[str
,Any
]]],None
]) – The details of the service discovery registry to associate with this service. For more information, see Service discovery . .. epigraph:: Each service may be associated with one service registry. Multiple service registries for each service isn’t supported.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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: + - = . _ : /task_definition (
Optional
[str
]) – Thefamily
andrevision
(family:revision
) or full ARN of the task definition to run in your service. If arevision
isn’t specified, the latestACTIVE
revision is used. A task definition must be specified if the service uses either theECS
orCODE_DEPLOY
deployment controllers. For more information about deployment types, see Amazon ECS deployment types .volume_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ServiceVolumeConfigurationProperty
,Dict
[str
,Any
]]],None
]) – 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.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs cfn_service_props = ecs.CfnServiceProps( capacity_provider_strategy=[ecs.CfnService.CapacityProviderStrategyItemProperty( base=123, capacity_provider="capacityProvider", weight=123 )], cluster="cluster", deployment_configuration=ecs.CfnService.DeploymentConfigurationProperty( alarms=ecs.CfnService.DeploymentAlarmsProperty( alarm_names=["alarmNames"], enable=False, rollback=False ), deployment_circuit_breaker=ecs.CfnService.DeploymentCircuitBreakerProperty( enable=False, rollback=False ), maximum_percent=123, minimum_healthy_percent=123 ), deployment_controller=ecs.CfnService.DeploymentControllerProperty( type="type" ), desired_count=123, enable_ecs_managed_tags=False, enable_execute_command=False, health_check_grace_period_seconds=123, launch_type="launchType", load_balancers=[ecs.CfnService.LoadBalancerProperty( container_name="containerName", container_port=123, load_balancer_name="loadBalancerName", target_group_arn="targetGroupArn" )], network_configuration=ecs.CfnService.NetworkConfigurationProperty( awsvpc_configuration=ecs.CfnService.AwsVpcConfigurationProperty( assign_public_ip="assignPublicIp", security_groups=["securityGroups"], subnets=["subnets"] ) ), placement_constraints=[ecs.CfnService.PlacementConstraintProperty( type="type", # the properties below are optional expression="expression" )], placement_strategies=[ecs.CfnService.PlacementStrategyProperty( type="type", # the properties below are optional field="field" )], platform_version="platformVersion", propagate_tags="propagateTags", role="role", scheduling_strategy="schedulingStrategy", service_connect_configuration=ecs.CfnService.ServiceConnectConfigurationProperty( enabled=False, # the properties below are optional log_configuration=ecs.CfnService.LogConfigurationProperty( log_driver="logDriver", options={ "options_key": "options" }, secret_options=[ecs.CfnService.SecretProperty( name="name", value_from="valueFrom" )] ), namespace="namespace", services=[ecs.CfnService.ServiceConnectServiceProperty( port_name="portName", # the properties below are optional client_aliases=[ecs.CfnService.ServiceConnectClientAliasProperty( port=123, # the properties below are optional dns_name="dnsName" )], discovery_name="discoveryName", ingress_port_override=123, timeout=ecs.CfnService.TimeoutConfigurationProperty( idle_timeout_seconds=123, per_request_timeout_seconds=123 ), tls=ecs.CfnService.ServiceConnectTlsConfigurationProperty( issuer_certificate_authority=ecs.CfnService.ServiceConnectTlsCertificateAuthorityProperty( aws_pca_authority_arn="awsPcaAuthorityArn" ), # the properties below are optional kms_key="kmsKey", role_arn="roleArn" ) )] ), service_name="serviceName", service_registries=[ecs.CfnService.ServiceRegistryProperty( container_name="containerName", container_port=123, port=123, registry_arn="registryArn" )], tags=[CfnTag( key="key", value="value" )], task_definition="taskDefinition", volume_configurations=[ecs.CfnService.ServiceVolumeConfigurationProperty( name="name", # the properties below are optional managed_ebs_volume=ecs.CfnService.ServiceManagedEBSVolumeConfigurationProperty( role_arn="roleArn", # the properties below are optional encrypted=False, filesystem_type="filesystemType", iops=123, kms_key_id="kmsKeyId", size_in_gi_b=123, snapshot_id="snapshotId", tag_specifications=[ecs.CfnService.EBSTagSpecificationProperty( resource_type="resourceType", # the properties below are optional propagate_tags="propagateTags", tags=[CfnTag( key="key", value="value" )] )], throughput=123, volume_type="volumeType" ) )] )
Attributes
- capacity_provider_strategy
The capacity provider strategy to use for the service.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.A capacity provider strategy may contain a maximum of 6 capacity providers.
- cluster
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.
- deployment_configuration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- deployment_controller
The deployment controller to use for the service.
If no deployment controller is specified, the default value of
ECS
is used.
- desired_count
The number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of
1
is used. When using theDAEMON
scheduling strategy, the desired count is not required.For existing services, if a desired count is not specified, it is omitted from the operation.
- enable_ecs_managed_tags
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.
- enable_execute_command
Determines whether the execute command functionality is turned on for the service.
If
true
, the execute command functionality is turned on for all containers in tasks as part of the service.
- health_check_grace_period_seconds
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.
- launch_type
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 .
- load_balancers
A list of load balancer objects to associate with the service.
If you specify the
Role
property,LoadBalancers
must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .
- network_configuration
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 .
- placement_constraints
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.
- placement_strategies
The placement strategy objects to use for tasks in your service.
You can specify a maximum of 5 strategy rules for each service.
- platform_version
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 AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .
- propagate_tags
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
.
- 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 doesn’t use the
awsvpc
network mode. If you specify therole
parameter, you must also specify a load balancer object with theloadBalancers
parameter. .. epigraph: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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html>`_ 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 namebar
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 .
- scheduling_strategy
//docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html>`_ .
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.- See:
- Type:
The scheduling strategy to use for the service. For more information, see `Services <https
- service_connect_configuration
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 .
- service_name
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. .. epigraph:
The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.
- service_registries
//docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html>`_ .
Each service may be associated with one service registry. Multiple service registries for each service isn’t supported.
- See:
- Type:
The details of the service discovery registry to associate with this service. For more information, see `Service discovery <https
- 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.
- task_definition
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service.If a
revision
isn’t specified, the latestACTIVE
revision is used.A task definition must be specified if the service uses either the
ECS
orCODE_DEPLOY
deployment controllers.For more information about deployment types, see Amazon ECS deployment types .
- volume_configurations
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.