ApplicationMultipleTargetGroupsServiceBaseProps¶

class aws_cdk.aws_ecs_patterns.ApplicationMultipleTargetGroupsServiceBaseProps(*, cloud_map_options=None, cluster=None, desired_count=None, enable_ecs_managed_tags=None, health_check_grace_period=None, load_balancers=None, propagate_tags=None, service_name=None, target_groups=None, task_image_options=None, vpc=None)¶

Bases: object

The properties for the base ApplicationMultipleTargetGroupsEc2Service or ApplicationMultipleTargetGroupsFargateService service.

Parameters

cloud_map_options (Optional[CloudMapOptions]) – The options for configuring an Amazon ECS service to use service discovery. Default: - AWS Cloud Map service discovery is not enabled.
cluster (Optional[ICluster]) – The name of the cluster that hosts the service. If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc. Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.
enable_ecs_managed_tags (Optional[bool]) – Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources Default: false
health_check_grace_period (Optional[Duration]) – 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. Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
load_balancers (Optional[Sequence[ApplicationLoadBalancerProps]]) – The application load balancer that will serve traffic to the service. Default: - a new load balancer with a listener will be created.
propagate_tags (Optional[PropagatedTagSource]) – Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. Tags can only be propagated to the tasks within the service during service creation. Default: - none
service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.
target_groups (Optional[Sequence[ApplicationTargetProps]]) – Properties to specify ALB target groups. Default: - default portMapping registered as target group and attached to the first defined listener
task_image_options (Optional[ApplicationLoadBalancedTaskImageProps]) – The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified. Default: none
vpc (Optional[IVpc]) – The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster. Default: - uses the VPC defined in the cluster or creates a new VPC.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_certificatemanager as certificatemanager
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_ecs as ecs
import aws_cdk.aws_ecs_patterns as ecs_patterns
import aws_cdk.aws_elasticloadbalancingv2 as elbv2
import aws_cdk.aws_iam as iam
import aws_cdk.aws_route53 as route53
import aws_cdk.aws_servicediscovery as servicediscovery
import aws_cdk.core as cdk

# certificate: certificatemanager.Certificate
# cluster: ecs.Cluster
# container_definition: ecs.ContainerDefinition
# container_image: ecs.ContainerImage
# hosted_zone: route53.HostedZone
# log_driver: ecs.LogDriver
# namespace: servicediscovery.INamespace
# role: iam.Role
# secret: ecs.Secret
# vpc: ec2.Vpc

application_multiple_target_groups_service_base_props = ecs_patterns.ApplicationMultipleTargetGroupsServiceBaseProps(
    cloud_map_options=ecs.CloudMapOptions(
        cloud_map_namespace=namespace,
        container=container_definition,
        container_port=123,
        dns_record_type=servicediscovery.DnsRecordType.A,
        dns_ttl=cdk.Duration.minutes(30),
        failure_threshold=123,
        name="name"
    ),
    cluster=cluster,
    desired_count=123,
    enable_eCSManaged_tags=False,
    health_check_grace_period=cdk.Duration.minutes(30),
    load_balancers=[ecs_patterns.ApplicationLoadBalancerProps(
        listeners=[ecs_patterns.ApplicationListenerProps(
            name="name",

            # the properties below are optional
            certificate=certificate,
            port=123,
            protocol=elbv2.ApplicationProtocol.HTTP,
            ssl_policy=elbv2.SslPolicy.RECOMMENDED
        )],
        name="name",

        # the properties below are optional
        domain_name="domainName",
        domain_zone=hosted_zone,
        public_load_balancer=False
    )],
    propagate_tags=ecs.PropagatedTagSource.SERVICE,
    service_name="serviceName",
    target_groups=[ecs_patterns.ApplicationTargetProps(
        container_port=123,

        # the properties below are optional
        host_header="hostHeader",
        listener="listener",
        path_pattern="pathPattern",
        priority=123,
        protocol=ecs.Protocol.TCP
    )],
    task_image_options=ecs_patterns.ApplicationLoadBalancedTaskImageProps(
        image=container_image,

        # the properties below are optional
        container_name="containerName",
        container_ports=[123],
        docker_labels={
            "docker_labels_key": "dockerLabels"
        },
        enable_logging=False,
        environment={
            "environment_key": "environment"
        },
        execution_role=role,
        family="family",
        log_driver=log_driver,
        secrets={
            "secrets_key": secret
        },
        task_role=role
    ),
    vpc=vpc
)

Attributes

cloud_map_options¶

The options for configuring an Amazon ECS service to use service discovery.

Default

AWS Cloud Map service discovery is not enabled.

Return type

Optional[CloudMapOptions]

cluster¶

The name of the cluster that hosts the service.

If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

Default

create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

Return type

Optional[ICluster]

desired_count¶

The desired number of instantiations of the task definition to keep running on the service.

Default

If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1;

if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.

Return type: Union[int, float, None]

enable_ecs_managed_tags¶

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default: false
Return type: Optional[bool]

health_check_grace_period¶

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.

Default

defaults to 60 seconds if at least one load balancer is in-use and it is not already set

Return type

Optional[Duration]

load_balancers¶

The application load balancer that will serve traffic to the service.

Default

a new load balancer with a listener will be created.

Return type

Optional[List[ApplicationLoadBalancerProps]]

propagate_tags¶

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Tags can only be propagated to the tasks within the service during service creation.

Default

none

Return type

Optional[PropagatedTagSource]

service_name¶

The name of the service.

Default

CloudFormation-generated name.

Return type

Optional[str]

target_groups¶

Properties to specify ALB target groups.

Default

default portMapping registered as target group and attached to the first defined listener

Return type

Optional[List[ApplicationTargetProps]]

task_image_options¶

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Default: none
Return type: Optional[ApplicationLoadBalancedTaskImageProps]

vpc¶

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

Default

uses the VPC defined in the cluster or creates a new VPC.

Return type

Optional[IVpc]