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_connect_configuration=None, service_name=None, service_registries=None, tags=None, task_definition=None, volume_configurations=None)
Bases:
CfnResource
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.The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect
ServiceConnectService
is configured. This is because AWS CloudFormation creates the replacement service first, but eachServiceConnectService
must have a name that is unique in the namespace. > Starting April 15, 2023, AWS ; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS , or Amazon EC2 . However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html
- CloudformationResource:
AWS::ECS::Service
- 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 = ecs.CfnService(self, "MyCfnService", 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" ) )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).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.
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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- 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 intermediate 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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- 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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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
- attr_service_arn
Not currently supported in AWS CloudFormation .
- CloudformationAttribute:
ServiceArn
- capacity_provider_strategy
The capacity provider strategy to use for the service.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- cluster
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
- 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.
- 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.
- desired_count
The number of instantiations of the specified task definition to place and keep running in your service.
- enable_ecs_managed_tags
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
- enable_execute_command
Determines whether the execute command functionality is turned on for 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.
- launch_type
The launch type on which to run your service.
- load_balancers
A list of load balancer objects to associate with the service.
- 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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- network_configuration
The network configuration for the service.
- node
The tree node.
- placement_constraints
An array of placement constraint objects to use for tasks in your service.
- placement_strategies
The placement strategy objects to use for tasks in your service.
- platform_version
The platform version that your tasks in the service are running on.
- propagate_tags
Specifies whether to propagate the tags from the task definition to the task.
- 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 })
.
- 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.
- scheduling_strategy
The scheduling strategy to use for the service.
For more information, see Services .
- 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.
- service_name
The name of your service.
- service_registries
The details of the service discovery registry to associate with this service.
For more information, see Service discovery .
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
The metadata that you apply to the service to help you categorize and organize them.
- task_definition
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service.
- volume_configurations
The configuration for a volume specified in the task definition as a volume that is configured at launch time.
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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
AwsVpcConfigurationProperty
- class CfnService.AwsVpcConfigurationProperty(*, assign_public_ip=None, security_groups=None, subnets=None)
Bases:
object
An object representing the networking details for a task or service.
For example
awsvpcConfiguration={subnets=["subnet-12344321"],securityGroups=["sg-12344321"]}
- Parameters:
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.subnets (
Optional
[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.
- See:
- 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 aws_vpc_configuration_property = ecs.CfnService.AwsVpcConfigurationProperty( assign_public_ip="assignPublicIp", security_groups=["securityGroups"], subnets=["subnets"] )
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 .
- See:
- 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 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 .
DeploymentAlarmsProperty
- class CfnService.DeploymentAlarmsProperty(*, alarm_names, enable, rollback)
Bases:
object
One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.
When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.
You can only use the
DeploymentAlarms
method to detect failures when theDeploymentController
is set toECS
(rolling update).For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .
- Parameters:
alarm_names (
Sequence
[str
]) – One or more CloudWatch alarm names. Use a “,” to separate the alarms.enable (
Union
[bool
,IResolvable
]) – Determines whether to use the CloudWatch alarm option in the service deployment process.rollback (
Union
[bool
,IResolvable
]) – Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
- See:
- 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 deployment_alarms_property = ecs.CfnService.DeploymentAlarmsProperty( alarm_names=["alarmNames"], enable=False, rollback=False )
Attributes
- alarm_names
One or more CloudWatch alarm names.
Use a “,” to separate the alarms.
- enable
Determines whether to use the CloudWatch alarm option in the service deployment process.
- rollback
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
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 deployment circuit breaker determines whether a service deployment will fail if the service can’t reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure 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 .
For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide .
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 on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfigurationProperty
- class CfnService.DeploymentConfigurationProperty(*, alarms=None, deployment_circuit_breaker=None, maximum_percent=None, minimum_healthy_percent=None)
Bases:
object
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
- Parameters:
alarms (
Union
[IResolvable
,DeploymentAlarmsProperty
,Dict
[str
,Any
],None
]) – Information about the CloudWatch alarms.deployment_circuit_breaker (
Union
[IResolvable
,DeploymentCircuitBreakerProperty
,Dict
[str
,Any
],None
]) –The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type. The deployment circuit breaker determines whether a service deployment will fail if the service can’t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guidemaximum_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 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. The default value for a replica service forminimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the AWS CLI , the AWS SDKs, and the APIs and 50% for the AWS Management Console. The minimum number of healthy tasks during a deployment is thedesiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value. 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.
- See:
- 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 deployment_configuration_property = 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 )
Attributes
- alarms
Information about the CloudWatch alarms.
- deployment_circuit_breaker
The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can’t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
- 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 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.
The default value for a replica service for
minimumHealthyPercent
is 100%. The defaultminimumHealthyPercent
value for a service using theDAEMON
service schedule is 0% for the AWS CLI , the AWS SDKs, and the APIs and 50% for the AWS Management Console.The minimum number of healthy tasks during a deployment is the
desiredCount
multiplied by theminimumHealthyPercent
/100, rounded up to the nearest integer value.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.- See:
- 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 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.
- See:
- Type:
The deployment controller type to use. There are three deployment controller types available
LoadBalancerProperty
- class CfnService.LoadBalancerProperty(*, container_name=None, container_port=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_name (
Optional
[str
]) – The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer.container_port (
Union
[int
,float
,None
]) – 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.load_balancer_name (
Optional
[str
]) – The name of the load balancer to associate with the Amazon ECS service or task set. 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. 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.
- See:
- 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 load_balancer_property = ecs.CfnService.LoadBalancerProperty( container_name="containerName", container_port=123, 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.
You need to specify the container name when configuring the target group for an Amazon ECS 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.
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.
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.
LogConfigurationProperty
- class CfnService.LogConfigurationProperty(*, log_driver=None, options=None, secret_options=None)
Bases:
object
The log configuration for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to`docker run
<https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/>`_ .By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Understand the following when specifying a log configuration for your containers.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on AWS Fargate , the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .For tasks that are on AWS Fargate , because you don’t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
- Parameters:
log_driver (
Optional
[str
]) – The log driver to use for the container. For tasks on AWS Fargate , the supported log drivers areawslogs
,splunk
, andawsfirelens
. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
. For more information about using theawslogs
log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide . For more information about using theawsfirelens
log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide . .. epigraph:: If you have a custom driver that isn’t listed, you can fork the Amazon ECS container agent project that’s available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don’t currently provide support for running modified copies of this software.options (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
secret_options (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SecretProperty
,Dict
[str
,Any
]]],None
]) – The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .
- See:
- 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 log_configuration_property = ecs.CfnService.LogConfigurationProperty( log_driver="logDriver", options={ "options_key": "options" }, secret_options=[ecs.CfnService.SecretProperty( name="name", value_from="valueFrom" )] )
Attributes
- log_driver
The log driver to use for the container.
For tasks on AWS Fargate , the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide .For more information about using the
awsfirelens
log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide . .. epigraph:If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent>`_ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.
- options
The configuration options to send to the log driver.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
- secret_options
The secrets to pass to the log configuration.
For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .
NetworkConfigurationProperty
- class CfnService.NetworkConfigurationProperty(*, awsvpc_configuration=None)
Bases:
object
The network configuration for a task or service.
- Parameters:
awsvpc_configuration (
Union
[IResolvable
,AwsVpcConfigurationProperty
,Dict
[str
,Any
],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.- See:
- 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 network_configuration_property = ecs.CfnService.NetworkConfigurationProperty( awsvpc_configuration=ecs.CfnService.AwsVpcConfigurationProperty( assign_public_ip="assignPublicIp", security_groups=["securityGroups"], subnets=["subnets"] ) )
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
An object representing a constraint on task placement.
For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide . .. epigraph:
If you're using the Fargate launch type, task placement constraints aren't supported.
- 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 .
- See:
- 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 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 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.
- See:
- 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 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.
SecretProperty
- class CfnService.SecretProperty(*, name, value_from)
Bases:
object
An object representing the secret to expose to your container.
Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.
For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .
- Parameters:
name (
str
) – The name of the secret.value_from (
str
) –The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require AWS Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide . .. epigraph:: If the SSM Parameter Store parameter exists in the same Region as the task you’re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.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 secret_property = ecs.CfnService.SecretProperty( name="name", value_from="valueFrom" )
Attributes
- name
The name of the secret.
- value_from
The secret to expose to the container.
The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require AWS Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide . .. epigraph:
If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
ServiceConnectClientAliasProperty
- class CfnService.ServiceConnectClientAliasProperty(*, port, dns_name=None)
Bases:
object
Each alias (“endpoint”) is a fully-qualified name and port number that other tasks (“clients”) can use to connect to this service.
Each name and port mapping must be unique within the 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 .
- Parameters:
port (
Union
[int
,float
]) –The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
dns_name (
Optional
[str
]) –The
dnsName
is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn’t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can’t start with a hyphen. If this parameter isn’t specified, the default value ofdiscoveryName.namespace
is used. If thediscoveryName
isn’t specified, the port mapping name from the task definition is used inportName.namespace
. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names aredatabase
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
- See:
- 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 service_connect_client_alias_property = ecs.CfnService.ServiceConnectClientAliasProperty( port=123, # the properties below are optional dns_name="dnsName" )
Attributes
- dns_name
The
dnsName
is the name that you use in the applications of client tasks to connect to this service.The name must be a valid DNS name but doesn’t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can’t start with a hyphen.
If this parameter isn’t specified, the default value of
discoveryName.namespace
is used. If thediscoveryName
isn’t specified, the port mapping name from the task definition is used inportName.namespace
.To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are
database
,db
, or the lowercase name of a database, such asmysql
orredis
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
- port
The listening port number for the Service Connect proxy.
This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
ServiceConnectConfigurationProperty
- class CfnService.ServiceConnectConfigurationProperty(*, enabled, log_configuration=None, namespace=None, services=None)
Bases:
object
The Service Connect configuration of your Amazon ECS service.
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 .
- Parameters:
enabled (
Union
[bool
,IResolvable
]) – Specifies whether to use Service Connect with this service.log_configuration (
Union
[IResolvable
,LogConfigurationProperty
,Dict
[str
,Any
],None
]) –The log configuration for the container. This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to`docker run
<https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/>`_ . By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Understand the following when specifying a log configuration for your containers. - Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on AWS Fargate , the supported log drivers areawslogs
,splunk
, andawsfirelens
. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
. - This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with theECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide . - For tasks that are on AWS Fargate , because you don’t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.namespace (
Optional
[str
]) – The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn’t affect Service Connect. For more information about AWS Cloud Map , see Working with Services in the AWS Cloud Map Developer Guide .services (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ServiceConnectServiceProperty
,Dict
[str
,Any
]]],None
]) – The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a “client” Amazon ECS service that’s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that’s attached to the service or by other means. An object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
- See:
- 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 service_connect_configuration_property = 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" ) )] )
Attributes
- enabled
Specifies whether to use Service Connect with this service.
- log_configuration
The log configuration for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to`docker run
<https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/>`_ .By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Understand the following when specifying a log configuration for your containers.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on AWS Fargate , the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .For tasks that are on AWS Fargate , because you don’t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
- namespace
The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace for use with Service Connect.
The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn’t affect Service Connect. For more information about AWS Cloud Map , see Working with Services in the AWS Cloud Map Developer Guide .
- services
The list of Service Connect service objects.
These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a “client” Amazon ECS service that’s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that’s attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
ServiceConnectServiceProperty
- class CfnService.ServiceConnectServiceProperty(*, port_name, client_aliases=None, discovery_name=None, ingress_port_override=None, timeout=None, tls=None)
Bases:
object
The Service Connect service object configuration.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
- Parameters:
port_name (
str
) – TheportName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.client_aliases (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ServiceConnectClientAliasProperty
,Dict
[str
,Any
]]],None
]) – The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias (“endpoint”) is a fully-qualified name and port number that other Amazon ECS tasks (“clients”) can use to connect to this service. Each name and port mapping must be unique within the namespace. For eachServiceConnectService
, you must provide at least oneclientAlias
with oneport
.discovery_name (
Optional
[str
]) – ThediscoveryName
is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the AWS Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can’t start with a hyphen. If thediscoveryName
isn’t specified, the port mapping name from the task definition is used inportName.namespace
.ingress_port_override (
Union
[int
,float
,None
]) – The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the namedportMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. Inawsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.timeout (
Union
[IResolvable
,TimeoutConfigurationProperty
,Dict
[str
,Any
],None
]) – A reference to an object that represents the configured timeouts for Service Connect.tls (
Union
[IResolvable
,ServiceConnectTlsConfigurationProperty
,Dict
[str
,Any
],None
]) – A reference to an object that represents a Transport Layer Security (TLS) configuration.
- See:
- 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 service_connect_service_property = 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" ) )
Attributes
- client_aliases
The list of client aliases for this Service Connect service.
You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias (“endpoint”) is a fully-qualified name and port number that other Amazon ECS tasks (“clients”) can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each
ServiceConnectService
, you must provide at least oneclientAlias
with oneport
.
- discovery_name
The
discoveryName
is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.This must be unique within the AWS Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can’t start with a hyphen.
If the
discoveryName
isn’t specified, the port mapping name from the task definition is used inportName.namespace
.
- ingress_port_override
The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
portMapping
in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.In
awsvpc
mode and Fargate, the default value is the container port number. The container port number is in theportMapping
in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
- port_name
The
portName
must match the name of one of theportMappings
from all the containers in the task definition of this Amazon ECS service.
- timeout
A reference to an object that represents the configured timeouts for Service Connect.
- tls
A reference to an object that represents a Transport Layer Security (TLS) configuration.
ServiceConnectTlsConfigurationProperty
- class CfnService.ServiceConnectTlsConfigurationProperty(*, issuer_certificate_authority, kms_key=None, role_arn=None)
Bases:
object
An object that represents the configuration for Service Connect TLS.
- Parameters:
issuer_certificate_authority (
Union
[IResolvable
,ServiceConnectTlsCertificateAuthorityProperty
,Dict
[str
,Any
]]) – The signer certificate authority.kms_key (
Optional
[str
]) – The AWS Key Management Service key.role_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the IAM role that’s associated with the Service Connect TLS.
- See:
- 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 service_connect_tls_configuration_property = 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" )
Attributes
- issuer_certificate_authority
The signer certificate authority.
- kms_key
The AWS Key Management Service key.
- role_arn
The Amazon Resource Name (ARN) of the IAM role that’s associated with the Service Connect TLS.
ServiceManagedEBSVolumeConfigurationProperty
- class CfnService.ServiceManagedEBSVolumeConfigurationProperty(*, role_arn, encrypted=None, filesystem_type=None, iops=None, kms_key_id=None, size_in_gib=None, snapshot_id=None, tag_specifications=None, throughput=None, volume_type=None)
Bases:
object
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.
These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.
Many of these parameters map 1:1 with the Amazon EBS
CreateVolume
API request parameters.- Parameters:
role_arn (
str
) – The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managedAmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide .encrypted (
Union
[bool
,IResolvable
,None
]) – Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with theEncrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference .filesystem_type (
Optional
[str
]) – The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types areext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default.iops (
Union
[int
,float
,None
]) –The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. -gp3
: 3,000 - 16,000 IOPS -io1
: 100 - 64,000 IOPS -io2
: 100 - 256,000 IOPS This parameter is required forio1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types. This parameter maps 1:1 with theIops
parameter of the CreateVolume API in the Amazon EC2 API Reference .kms_key_id (
Optional
[str
]) –The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference . .. epigraph:: AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.size_in_gib (
Union
[int
,float
,None
]) –The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference . The following are the supported volume size values for each volume type. -gp2
andgp3
: 1-16,384 -io1
andio2
: 4-16,384 -st1
andsc1
: 125-16,384 -standard
: 1-1,024snapshot_id (
Optional
[str
]) –The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference .tag_specifications (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EBSTagSpecificationProperty
,Dict
[str
,Any
]]],None
]) –The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference .throughput (
Union
[int
,float
,None
]) –The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference . .. epigraph:: This parameter is only supported for thegp3
volume type.volume_type (
Optional
[str
]) –The volume type. This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference . For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . The following are the supported volume types. - General Purpose SSD:gp2
|gp3
- Provisioned IOPS SSD:io1
|io2
- Throughput Optimized HDD:st1
- Cold HDD:sc1
- Magnetic:standard
.. epigraph:: The magnetic volume type is not supported on Fargate.
- See:
- 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 service_managed_eBSVolume_configuration_property = 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
- encrypted
Indicates whether the volume should be encrypted.
If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the
Encrypted
parameter of the CreateVolume API in the Amazon EC2 API Reference .
- filesystem_type
The Linux filesystem type for the volume.
For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
The available filesystem types are
ext3
,ext4
, andxfs
. If no value is specified, thexfs
filesystem type is used by default.
- iops
The number of I/O operations per second (IOPS).
For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type.
gp3
: 3,000 - 16,000 IOPSio1
: 100 - 64,000 IOPSio2
: 100 - 256,000 IOPS
This parameter is required for
io1
andio2
volume types. The default forgp3
volumes is3,000 IOPS
. This parameter is not supported forst1
,sc1
, orstandard
volume types.This parameter maps 1:1 with the
Iops
parameter of the CreateVolume API in the Amazon EC2 API Reference .
- kms_key_id
The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.
When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the
KmsKeyId
parameter of the CreateVolume API in the Amazon EC2 API Reference . .. epigraph:AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
- role_arn
The ARN of the IAM role to associate with this volume.
This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed
AmazonECSInfrastructureRolePolicyForVolumes
IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide .
- size_in_gib
The size of the volume in GiB.
You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
Size
parameter of the CreateVolume API in the Amazon EC2 API Reference .The following are the supported volume size values for each volume type.
gp2
andgp3
: 1-16,384io1
andio2
: 4-16,384st1
andsc1
: 125-16,384standard
: 1-1,024
- snapshot_id
The snapshot that Amazon ECS uses to create the volume.
You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the
SnapshotId
parameter of the CreateVolume API in the Amazon EC2 API Reference .
- tag_specifications
The tags to apply to the volume.
Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the
TagSpecifications.N
parameter of the CreateVolume API in the Amazon EC2 API Reference .
- throughput
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
This parameter maps 1:1 with the
Throughput
parameter of the CreateVolume API in the Amazon EC2 API Reference . .. epigraph:This parameter is only supported for the ``gp3`` volume type.
- volume_type
The volume type.
This parameter maps 1:1 with the
VolumeType
parameter of the CreateVolume API in the Amazon EC2 API Reference . For more information, see Amazon EBS volume types in the Amazon EC2 User Guide .The following are the supported volume types.
General Purpose SSD:
gp2
|gp3
Provisioned IOPS SSD:
io1
|io2
Throughput Optimized HDD:
st1
Cold HDD:
sc1
Magnetic:
standard
The magnetic volume type is not supported on Fargate.
ServiceRegistryProperty
- class CfnService.ServiceRegistryProperty(*, container_name=None, container_port=None, port=None, registry_arn=None)
Bases:
object
The details for the service registry.
Each service may be associated with one service registry. Multiple service registries for each service are not supported.
When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.
- 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 .
- See:
- 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 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.
- 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.
- 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 .
ServiceVolumeConfigurationProperty
- class CfnService.ServiceVolumeConfigurationProperty(*, name, managed_ebs_volume=None)
Bases:
object
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.
- Parameters:
name (
str
) – The name of the volume. This value must match the volume name from theVolume
object in the task definition.managed_ebs_volume (
Union
[IResolvable
,ServiceManagedEBSVolumeConfigurationProperty
,Dict
[str
,Any
],None
]) – The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
- See:
- 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 service_volume_configuration_property = 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
- managed_ebs_volume
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.
These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
- name
The name of the volume.
This value must match the volume name from the
Volume
object in the task definition.
TimeoutConfigurationProperty
- class CfnService.TimeoutConfigurationProperty(*, idle_timeout_seconds=None, per_request_timeout_seconds=None)
Bases:
object
An object that represents the timeout configurations for Service Connect.
If
idleTimeout
is set to a time that is less thanperRequestTimeout
, the connection will close when theidleTimeout
is reached and not theperRequestTimeout
.- Parameters:
idle_timeout_seconds (
Union
[int
,float
,None
]) – The amount of time in seconds a connection will stay active while idle. A value of0
can be set to disableidleTimeout
. TheidleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes. TheidleTimeout
default forTCP
is 1 hour.per_request_timeout_seconds (
Union
[int
,float
,None
]) – The amount of time waiting for the upstream to respond with a complete response per request. A value of0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn’tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.
- See:
- 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 timeout_configuration_property = ecs.CfnService.TimeoutConfigurationProperty( idle_timeout_seconds=123, per_request_timeout_seconds=123 )
Attributes
- idle_timeout_seconds
The amount of time in seconds a connection will stay active while idle.
A value of
0
can be set to disableidleTimeout
.The
idleTimeout
default forHTTP
/HTTP2
/GRPC
is 5 minutes.The
idleTimeout
default forTCP
is 1 hour.
- per_request_timeout_seconds
The amount of time waiting for the upstream to respond with a complete response per request.
A value of
0
can be set to disableperRequestTimeout
.perRequestTimeout
can only be set if Service ConnectappProtocol
isn’tTCP
. OnlyidleTimeout
is allowed forTCP
appProtocol
.