CfnService¶
-
class
aws_cdk.aws_ecs.
CfnService
(scope, id, *, 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_name=None, service_registries=None, tags=None, task_definition=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::ECS::Service
.The
AWS::ECS::Service
resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.- CloudformationResource
AWS::ECS::Service
- Link
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. import aws_cdk.aws_ecs as ecs cfn_service = ecs.CfnService(self, "MyCfnService", capacity_provider_strategy=[ecs.CfnService.CapacityProviderStrategyItemProperty( base=123, capacity_provider="capacityProvider", weight=123 )], cluster="cluster", deployment_configuration=ecs.CfnService.DeploymentConfigurationProperty( 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_port=123, # the properties below are optional container_name="containerName", load_balancer_name="loadBalancerName", target_group_arn="targetGroupArn" )], network_configuration=ecs.CfnService.NetworkConfigurationProperty( awsvpc_configuration=ecs.CfnService.AwsVpcConfigurationProperty( subnets=["subnets"], # the properties below are optional assign_public_ip="assignPublicIp", security_groups=["securityGroups"] ) ), 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_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" )
Create a new
AWS::ECS::Service
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
capacity_provider_strategy (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CapacityProviderStrategyItemProperty
]],None
]) – The capacity provider strategy to use for the service. A capacity provider strategy consists of one or more capacity providers along with thebase
andweight
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 anACTIVE
orUPDATING
status can be used. Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide. If acapacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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 an AWS Fargate capacity provider, specify either theFARGATE
orFARGATE_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.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
,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
,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 on your cluster. 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 .enable_execute_command (
Union
[bool
,IResolvable
,None
]) – Determines whether the execute command functionality is enabled for the service. Iftrue
, the execute command functionality is enabled 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 recomend that you use thestartPeriod
in the task definition healtch 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
[LoadBalancerProperty
,IResolvable
]],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
[NetworkConfigurationProperty
,IResolvable
,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
[PlacementConstraintProperty
,IResolvable
]],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
[PlacementStrategyProperty
,IResolvable
]],None
]) – The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .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 .propagate_tags (
Optional
[str
]) – 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.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_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.service_registries (
Union
[IResolvable
,Sequence
[Union
[ServiceRegistryProperty
,IResolvable
]],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
[CfnTag
]]) – 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 useaws:
,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 (
Optional
[str
]) – Thefamily
andrevision
(family:revision
) or full ARN of the task definition to run in your service. Therevision
is required in order for the resource to stabilize. A task definition must be specified if the service is using either theECS
orCODE_DEPLOY
deployment controllers.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::ECS::Service'¶
-
attr_name
¶ The name of the Amazon ECS service, such as
sample-webapp
.- CloudformationAttribute
Name
- Return type
str
-
attr_service_arn
¶ Not currently supported in AWS CloudFormation .
- CloudformationAttribute
ServiceArn
- Return type
str
-
capacity_provider_strategy
¶ The capacity provider strategy to use for the service.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
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 anACTIVE
orUPDATING
status can be used.Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
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 an AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_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.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,CapacityProviderStrategyItemProperty
]],None
]
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
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.
- Link
- Return type
Optional
[str
]
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
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 on your cluster.
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.
- Link
- Return type
Union
[int
,float
,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 .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
enable_execute_command
¶ Determines whether the execute command functionality is enabled for the service.
If
true
, the execute command functionality is enabled for all containers in tasks as part of the service.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
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 recomend that you use the
startPeriod
in the task definition healtch 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.
- Link
- Return type
Union
[int
,float
,None
]
-
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 .
- Link
- Return type
Optional
[str
]
-
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 .- Link
- Return type
Union
[IResolvable
,List
[Union
[LoadBalancerProperty
,IResolvable
]],None
]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
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 .
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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.
- Link
- Return type
Union
[IResolvable
,List
[Union
[PlacementConstraintProperty
,IResolvable
]],None
]
-
placement_strategies
¶ The placement strategy objects to use for tasks in your service.
You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
- Link
- Return type
Union
[IResolvable
,List
[Union
[PlacementStrategyProperty
,IResolvable
]],None
]
-
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 .- Link
- Return type
Optional
[str
]
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.
- Link
- Return type
Optional
[str
]
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
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 .- Link
- Return type
Optional
[str
]
-
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.- Link
- Type
The scheduling strategy to use for the service. For more information, see `Services <https
- Return type
Optional
[str
]
-
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.
- Link
- Return type
Optional
[str
]
-
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.
- Link
- Type
The details of the service discovery registry to associate with this service. For more information, see `Service discovery <https
- Return type
Union
[IResolvable
,List
[Union
[ServiceRegistryProperty
,IResolvable
]],None
]
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
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.The
revision
is required in order for the resource to stabilize.A task definition must be specified if the service is using either the
ECS
orCODE_DEPLOY
deployment controllers.- Link
- Return type
Optional
[str
]
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AwsVpcConfigurationProperty¶
-
class
CfnService.
AwsVpcConfigurationProperty
(*, subnets, assign_public_ip=None, security_groups=None)¶ Bases:
object
An object representing the networking details for a task or service.
- Parameters
subnets (
Sequence
[str
]) – The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified perAwsVpcConfiguration
. .. epigraph:: All specified subnets must be from the same VPC.assign_public_ip (
Optional
[str
]) – Whether the task’s elastic network interface receives a public IP address. The default value isDISABLED
.security_groups (
Optional
[Sequence
[str
]]) – The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified perAwsVpcConfiguration
. .. epigraph:: All specified security groups must be from the same VPC.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs aws_vpc_configuration_property = ecs.CfnService.AwsVpcConfigurationProperty( subnets=["subnets"], # the properties below are optional assign_public_ip="assignPublicIp", security_groups=["securityGroups"] )
Attributes
-
assign_public_ip
¶ Whether the task’s elastic network interface receives a public IP address.
The default value is
DISABLED
.
-
security_groups
¶ The IDs of the security groups associated with the task or service.
If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified per
AwsVpcConfiguration
. .. epigraph:All specified security groups must be from the same VPC.
-
subnets
¶ The IDs of the subnets associated with the task or service.
There’s a limit of 16 subnets that can be specified per
AwsVpcConfiguration
. .. epigraph:All specified subnets must be from the same VPC.
CapacityProviderStrategyItemProperty¶
-
class
CfnService.
CapacityProviderStrategyItemProperty
(*, base=None, capacity_provider=None, weight=None)¶ Bases:
object
The details of a capacity provider strategy.
A capacity provider strategy can be set when using the
RunTask
orCreateService
APIs or as the default capacity provider strategy for a cluster with theCreateCluster
API.Only capacity providers that are already associated with a cluster and have an
ACTIVE
orUPDATING
status can be used in a capacity provider strategy. ThePutClusterCapacityProviders
API is used to associate a capacity provider with a cluster.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the
CreateCapacityProvider
API operation.To use an AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_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 in a capacity provider strategy.- Parameters
base (
Union
[int
,float
,None
]) – The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of0
is used.capacity_provider (
Optional
[str
]) – The short name of the capacity provider.weight (
Union
[int
,float
,None
]) – The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. Theweight
value is taken into consideration after thebase
value, if defined, is satisfied. If noweight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that’s run using capacityProviderA , four tasks would use capacityProviderB .
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs capacity_provider_strategy_item_property = ecs.CfnService.CapacityProviderStrategyItemProperty( base=123, capacity_provider="capacityProvider", weight=123 )
Attributes
-
base
¶ The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used.
-
capacity_provider
¶ The short name of the capacity provider.
-
weight
¶ The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
The
weight
value is taken into consideration after thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that’s run using capacityProviderA , four tasks would use capacityProviderB .
DeploymentCircuitBreakerProperty¶
-
class
CfnService.
DeploymentCircuitBreakerProperty
(*, enable, rollback)¶ Bases:
object
The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type.The
DeploymentCircuitBreaker
property determines whether a service deployment will fail if the service can’t reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.- param enable
Determines whether to use the deployment circuit breaker logic for the service.
- param rollback
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
- link
- exampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs deployment_circuit_breaker_property = ecs.CfnService.DeploymentCircuitBreakerProperty( enable=False, rollback=False )
Attributes
-
enable
¶ Determines whether to use the deployment circuit breaker logic for the service.
-
rollback
¶ Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfigurationProperty¶
-
class
CfnService.
DeploymentConfigurationProperty
(*, deployment_circuit_breaker=None, maximum_percent=None, minimum_healthy_percent=None)¶ Bases:
object
The
DeploymentConfiguration
property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.- Parameters
deployment_circuit_breaker (
Union
[IResolvable
,DeploymentCircuitBreakerProperty
,None
]) –The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer. The deployment circuit breaker determines whether a service deployment will fail if the service can’t reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .maximum_percent (
Union
[int
,float
,None
]) – If a service is using the rolling update (ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service’s tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using theREPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.minimum_healthy_percent (
Union
[int
,float
,None
]) – If a service is using the rolling update (ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service’s tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has adesiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that do not use a load balancer, the following should be noted: - A service is considered healthy if all essential containers within the tasks in the service pass their health checks. - If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches aRUNNING
state before the task is counted towards the minimum healthy percent total. - If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services are that do use a load balancer, the following should be noted: - If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. - If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs deployment_configuration_property = ecs.CfnService.DeploymentConfigurationProperty( deployment_circuit_breaker=ecs.CfnService.DeploymentCircuitBreakerProperty( enable=False, rollback=False ), maximum_percent=123, minimum_healthy_percent=123 )
Attributes
-
deployment_circuit_breaker
¶ The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type that are not behind a Classic Load Balancer.The deployment circuit breaker determines whether a service deployment will fail if the service can’t reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .
- Return type
Union
[IResolvable
,DeploymentCircuitBreakerProperty
,None
]
-
maximum_percent
¶ If a service is using the rolling update (
ECS
) deployment type, themaximumPercent
parameter represents an upper limit on the number of your service’s tasks that are allowed in theRUNNING
orPENDING
state during a deployment, as a percentage of thedesiredCount
(rounded down to the nearest integer).This parameter enables you to define the deployment batch size. For example, if your service is using the
REPLICA
service scheduler and has adesiredCount
of four tasks and amaximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The defaultmaximumPercent
value for a service using theREPLICA
service scheduler is 200%.If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
-
minimum_healthy_percent
¶ If a service is using the rolling update (
ECS
) deployment type, theminimumHealthyPercent
represents a lower limit on the number of your service’s tasks that must remain in theRUNNING
state during a deployment, as a percentage of thedesiredCount
(rounded up to the nearest integer).This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a
desiredCount
of four tasks and aminimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a
RUNNING
state before the task is counted towards the minimum healthy percent total.If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services are that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a service is using either the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If a service is using either the blue/green (CODE_DEPLOY
) orEXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
DeploymentControllerProperty¶
-
class
CfnService.
DeploymentControllerProperty
(*, type=None)¶ Bases:
object
The deployment controller to use for the service.
For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide .
- Parameters
type (
Optional
[str
]) – The deployment controller type to use. There are three deployment controller types available:. - ECS - The rolling update (ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration . - CODE_DEPLOY - The blue/green (CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by AWS CodeDeploy , which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL - The external (EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs deployment_controller_property = ecs.CfnService.DeploymentControllerProperty( type="type" )
Attributes
-
type
¶ .
ECS - The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration .CODE_DEPLOY - The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by AWS CodeDeploy , which allows you to verify a new deployment of a service before sending production traffic to it.EXTERNAL - The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
- Link
- Type
The deployment controller type to use. There are three deployment controller types available
- Return type
Optional
[str
]
LoadBalancerProperty¶
-
class
CfnService.
LoadBalancerProperty
(*, container_port, container_name=None, load_balancer_name=None, target_group_arn=None)¶ Bases:
object
The
LoadBalancer
property specifies details on a load balancer that is used with a service.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 you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as atargetGroupPair
). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.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 chooseip
as the target type, notinstance
. Tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.- Parameters
container_port (
Union
[int
,float
]) – The port on the container to associate with the load balancer. This port must correspond to acontainerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they’re launched on must allow ingress traffic on thehostPort
of the port mapping.container_name (
Optional
[str
]) – The name of the container (as it appears in a container definition) to associate with the load balancer.load_balancer_name (
Optional
[str
]) – The name of the load balancer to associate with the Amazon ECS service or task set. A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.target_group_arn (
Optional
[str
]) – The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you’re using a Classic Load Balancer, omit the target group ARN. For services using theECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide . For services using theCODE_DEPLOY
deployment controller, you’re required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide . .. epigraph:: If your service’s task definition uses theawsvpc
network mode, you must chooseip
as the target type, notinstance
. Do this when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs load_balancer_property = ecs.CfnService.LoadBalancerProperty( container_port=123, # the properties below are optional container_name="containerName", load_balancer_name="loadBalancerName", target_group_arn="targetGroupArn" )
Attributes
-
container_name
¶ The name of the container (as it appears in a container definition) to associate with the load balancer.
-
container_port
¶ The port on the container to associate with the load balancer.
This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they’re launched on must allow ingress traffic on thehostPort
of the port mapping.
-
load_balancer_name
¶ The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
-
target_group_arn
¶ The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you’re using a Classic Load Balancer, omit the target group ARN.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide .For services using the
CODE_DEPLOY
deployment controller, you’re required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide . .. epigraph:If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance`` . Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.
NetworkConfigurationProperty¶
-
class
CfnService.
NetworkConfigurationProperty
(*, awsvpc_configuration=None)¶ Bases:
object
The
NetworkConfiguration
property specifies an object representing the network configuration for a task or service.- Parameters
awsvpc_configuration (
Union
[IResolvable
,AwsVpcConfigurationProperty
,None
]) – The VPC subnets and security groups that are associated with a task. .. epigraph:: All specified subnets and security groups must be from the same VPC.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs network_configuration_property = ecs.CfnService.NetworkConfigurationProperty( awsvpc_configuration=ecs.CfnService.AwsVpcConfigurationProperty( subnets=["subnets"], # the properties below are optional assign_public_ip="assignPublicIp", security_groups=["securityGroups"] ) )
Attributes
-
awsvpc_configuration
¶ The VPC subnets and security groups that are associated with a task.
All specified subnets and security groups must be from the same VPC.
PlacementConstraintProperty¶
-
class
CfnService.
PlacementConstraintProperty
(*, type, expression=None)¶ Bases:
object
The
PlacementConstraint
property specifies an object representing a constraint on task placement in the task definition.For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
- Parameters
type (
str
) – The type of constraint. UsedistinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates.expression (
Optional
[str
]) – A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can’t specify an expression if the constraint type isdistinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide .
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs placement_constraint_property = ecs.CfnService.PlacementConstraintProperty( type="type", # the properties below are optional expression="expression" )
Attributes
-
expression
¶ A cluster query language expression to apply to the constraint.
The expression can have a maximum length of 2000 characters. You can’t specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide .
-
type
¶ The type of constraint.
Use
distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates.
PlacementStrategyProperty¶
-
class
CfnService.
PlacementStrategyProperty
(*, type, field=None)¶ Bases:
object
The
PlacementStrategy
property specifies the task placement strategy for a task or service.For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
- Parameters
type (
str
) – The type of placement strategy. Therandom
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that’s specified with thefield
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.field (
Optional
[str
]) – The field to apply the placement strategy against. For thespread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that’s applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs placement_strategy_property = ecs.CfnService.PlacementStrategyProperty( type="type", # the properties below are optional field="field" )
Attributes
-
field
¶ The field to apply the placement strategy against.
For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that’s applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
-
type
¶ The type of placement strategy.
The
random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that’s specified with thefield
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.
ServiceRegistryProperty¶
-
class
CfnService.
ServiceRegistryProperty
(*, container_name=None, container_port=None, port=None, registry_arn=None)¶ Bases:
object
The
ServiceRegistry
property specifies details of the service registry.For more information, see Service Discovery in the Amazon Elastic Container Service Developer Guide .
- Parameters
container_name (
Optional
[str
]) – The container name value to be used for your service discovery service. It’s already specified in the task definition. If the task definition that your service task specifies uses thebridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can’t specify both.container_port (
Union
[int
,float
,None
]) – The port value to be used for your service discovery service. It’s already specified in the task definition. If the task definition your service task specifies uses thebridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can’t specify both.port (
Union
[int
,float
,None
]) – The port value used if your service discovery service specified an SRV record. This field might be used if both theawsvpc
network mode and SRV records are used.registry_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map . For more information, see CreateService .
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ecs as ecs service_registry_property = ecs.CfnService.ServiceRegistryProperty( container_name="containerName", container_port=123, port=123, registry_arn="registryArn" )
Attributes
-
container_name
¶ The container name value to be used for your service discovery service.
It’s already specified in the task definition. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can’t specify both.
-
container_port
¶ The port value to be used for your service discovery service.
It’s already specified in the task definition. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value. However, you can’t specify both.- Link
- Return type
Union
[int
,float
,None
]
-
port
¶ The port value used if your service discovery service specified an SRV record.
This field might be used if both the
awsvpc
network mode and SRV records are used.- Link
- Return type
Union
[int
,float
,None
]
-
registry_arn
¶ The Amazon Resource Name (ARN) of the service registry.
The currently supported service registry is AWS Cloud Map . For more information, see CreateService .