NetworkMultipleTargetGroupsServiceBaseProps Struct
The properties for the base NetworkMultipleTargetGroupsEc2Service or NetworkMultipleTargetGroupsFargateService service.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';
declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const containerImage: ecs.ContainerImage;
declare const hostedZone: route53.HostedZone;
declare const logDriver: ecs.LogDriver;
declare const namespace: servicediscovery.INamespace;
declare const role: iam.Role;
declare const secret: ecs.Secret;
declare const vpc: ec2.Vpc;
const networkMultipleTargetGroupsServiceBaseProps: ecs_patterns.NetworkMultipleTargetGroupsServiceBaseProps = {
cloudMapOptions: {
cloudMapNamespace: namespace,
container: containerDefinition,
containerPort: 123,
dnsRecordType: servicediscovery.DnsRecordType.A,
dnsTtl: cdk.Duration.minutes(30),
failureThreshold: 123,
name: 'name',
},
cluster: cluster,
desiredCount: 123,
enableECSManagedTags: false,
enableExecuteCommand: false,
healthCheckGracePeriod: cdk.Duration.minutes(30),
loadBalancers: [{
listeners: [{
name: 'name',
// the properties below are optional
port: 123,
}],
name: 'name',
// the properties below are optional
domainName: 'domainName',
domainZone: hostedZone,
publicLoadBalancer: false,
}],
propagateTags: ecs.PropagatedTagSource.SERVICE,
serviceName: 'serviceName',
targetGroups: [{
containerPort: 123,
// the properties below are optional
listener: 'listener',
}],
taskImageOptions: {
image: containerImage,
// the properties below are optional
containerName: 'containerName',
containerPorts: [123],
dockerLabels: {
dockerLabelsKey: 'dockerLabels',
},
enableLogging: false,
environment: {
environmentKey: 'environment',
},
executionRole: role,
family: 'family',
logDriver: logDriver,
secrets: {
secretsKey: secret,
},
taskRole: role,
},
vpc: vpc,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_ecs as ecs
from aws_cdk import aws_ecs_patterns as ecs_patterns
from aws_cdk import aws_iam as iam
from aws_cdk import aws_route53 as route53
from aws_cdk import aws_servicediscovery as servicediscovery
# 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
network_multiple_target_groups_service_base_props = ecs_patterns.NetworkMultipleTargetGroupsServiceBaseProps(
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_ecs_managed_tags=False,
enable_execute_command=False,
health_check_grace_period=cdk.Duration.minutes(30),
load_balancers=[ecs_patterns.NetworkLoadBalancerProps(
listeners=[ecs_patterns.NetworkListenerProps(
name="name",
# the properties below are optional
port=123
)],
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.NetworkTargetProps(
container_port=123,
# the properties below are optional
listener="listener"
)],
task_image_options=ecs_patterns.NetworkLoadBalancedTaskImageProps(
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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.ecs.*;
import software.amazon.awscdk.services.ecs.patterns.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.route53.*;
import software.amazon.awscdk.services.servicediscovery.*;
Cluster cluster;
ContainerDefinition containerDefinition;
ContainerImage containerImage;
HostedZone hostedZone;
LogDriver logDriver;
INamespace namespace;
Role role;
Secret secret;
Vpc vpc;
NetworkMultipleTargetGroupsServiceBaseProps networkMultipleTargetGroupsServiceBaseProps = NetworkMultipleTargetGroupsServiceBaseProps.builder()
.cloudMapOptions(CloudMapOptions.builder()
.cloudMapNamespace(namespace)
.container(containerDefinition)
.containerPort(123)
.dnsRecordType(DnsRecordType.A)
.dnsTtl(Duration.minutes(30))
.failureThreshold(123)
.name("name")
.build())
.cluster(cluster)
.desiredCount(123)
.enableECSManagedTags(false)
.enableExecuteCommand(false)
.healthCheckGracePeriod(Duration.minutes(30))
.loadBalancers(List.of(NetworkLoadBalancerProps.builder()
.listeners(List.of(NetworkListenerProps.builder()
.name("name")
// the properties below are optional
.port(123)
.build()))
.name("name")
// the properties below are optional
.domainName("domainName")
.domainZone(hostedZone)
.publicLoadBalancer(false)
.build()))
.propagateTags(PropagatedTagSource.SERVICE)
.serviceName("serviceName")
.targetGroups(List.of(NetworkTargetProps.builder()
.containerPort(123)
// the properties below are optional
.listener("listener")
.build()))
.taskImageOptions(NetworkLoadBalancedTaskImageProps.builder()
.image(containerImage)
// the properties below are optional
.containerName("containerName")
.containerPorts(List.of(123))
.dockerLabels(Map.of(
"dockerLabelsKey", "dockerLabels"))
.enableLogging(false)
.environment(Map.of(
"environmentKey", "environment"))
.executionRole(role)
.family("family")
.logDriver(logDriver)
.secrets(Map.of(
"secretsKey", secret))
.taskRole(role)
.build())
.vpc(vpc)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.ECS.Patterns;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Route53;
using Amazon.CDK.AWS.ServiceDiscovery;
Cluster cluster;
ContainerDefinition containerDefinition;
ContainerImage containerImage;
HostedZone hostedZone;
LogDriver logDriver;
INamespace namespace;
Role role;
Secret secret;
Vpc vpc;
var networkMultipleTargetGroupsServiceBaseProps = new NetworkMultipleTargetGroupsServiceBaseProps {
CloudMapOptions = new CloudMapOptions {
CloudMapNamespace = namespace,
Container = containerDefinition,
ContainerPort = 123,
DnsRecordType = DnsRecordType.A,
DnsTtl = Duration.Minutes(30),
FailureThreshold = 123,
Name = "name"
},
Cluster = cluster,
DesiredCount = 123,
EnableECSManagedTags = false,
EnableExecuteCommand = false,
HealthCheckGracePeriod = Duration.Minutes(30),
LoadBalancers = new [] { new NetworkLoadBalancerProps {
Listeners = new [] { new NetworkListenerProps {
Name = "name",
// the properties below are optional
Port = 123
} },
Name = "name",
// the properties below are optional
DomainName = "domainName",
DomainZone = hostedZone,
PublicLoadBalancer = false
} },
PropagateTags = PropagatedTagSource.SERVICE,
ServiceName = "serviceName",
TargetGroups = new [] { new NetworkTargetProps {
ContainerPort = 123,
// the properties below are optional
Listener = "listener"
} },
TaskImageOptions = new NetworkLoadBalancedTaskImageProps {
Image = containerImage,
// the properties below are optional
ContainerName = "containerName",
ContainerPorts = new [] { 123 },
DockerLabels = new Dictionary<string, string> {
{ "dockerLabelsKey", "dockerLabels" }
},
EnableLogging = false,
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
ExecutionRole = role,
Family = "family",
LogDriver = logDriver,
Secrets = new Dictionary<string, Secret> {
{ "secretsKey", secret }
},
TaskRole = role
},
Vpc = vpc
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var cluster Cluster
var containerDefinition ContainerDefinition
var containerImage ContainerImage
var hostedZone HostedZone
var logDriver LogDriver
var namespace INamespace
var role Role
var secret Secret
var vpc Vpc
networkMultipleTargetGroupsServiceBaseProps := &NetworkMultipleTargetGroupsServiceBaseProps{
CloudMapOptions: &CloudMapOptions{
CloudMapNamespace: namespace,
Container: containerDefinition,
ContainerPort: jsii.Number(123),
DnsRecordType: awscdk.Aws_servicediscovery.DnsRecordType_A,
DnsTtl: cdk.Duration_Minutes(jsii.Number(30)),
FailureThreshold: jsii.Number(123),
Name: jsii.String("name"),
},
Cluster: cluster,
DesiredCount: jsii.Number(123),
EnableECSManagedTags: jsii.Boolean(false),
EnableExecuteCommand: jsii.Boolean(false),
HealthCheckGracePeriod: cdk.Duration_*Minutes(jsii.Number(30)),
LoadBalancers: []NetworkLoadBalancerProps{
&NetworkLoadBalancerProps{
Listeners: []NetworkListenerProps{
&NetworkListenerProps{
Name: jsii.String("name"),
// the properties below are optional
Port: jsii.Number(123),
},
},
Name: jsii.String("name"),
// the properties below are optional
DomainName: jsii.String("domainName"),
DomainZone: hostedZone,
PublicLoadBalancer: jsii.Boolean(false),
},
},
PropagateTags: awscdk.Aws_ecs.PropagatedTagSource_SERVICE,
ServiceName: jsii.String("serviceName"),
TargetGroups: []NetworkTargetProps{
&NetworkTargetProps{
ContainerPort: jsii.Number(123),
// the properties below are optional
Listener: jsii.String("listener"),
},
},
TaskImageOptions: &NetworkLoadBalancedTaskImageProps{
Image: containerImage,
// the properties below are optional
ContainerName: jsii.String("containerName"),
ContainerPorts: []*f64{
jsii.Number(123),
},
DockerLabels: map[string]*string{
"dockerLabelsKey": jsii.String("dockerLabels"),
},
EnableLogging: jsii.Boolean(false),
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
ExecutionRole: role,
Family: jsii.String("family"),
LogDriver: logDriver,
Secrets: map[string]Secret{
"secretsKey": secret,
},
TaskRole: role,
},
Vpc: vpc,
}
Properties
cloudMapOptionsoptionalCloudMapOptionscloud_map_optionsoptionalCloudMapOptionscloudMapOptionsoptionalCloudMapOptionsCloudMapOptionsoptionalCloudMapOptionsCloudMapOptionsoptionalCloudMapOptions#The options for configuring an Amazon ECS service to use service discovery.
Default: AWS Cloud Map service discovery is not enabled.
clusteroptionalIClusterclusteroptionalIClusterclusteroptionalIClusterClusteroptionalIClusterClusteroptionalICluster#The name of the cluster that hosts the service.
Default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
desiredCountoptionalnumberdesired_countoptionalint | floatdesiredCountoptionalNumberDesiredCountoptionaldoubleDesiredCountoptional*float64#The desired number of instantiations of the task definition to keep running on the service.
Default: The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
The minimum value is 1
enableECSManagedTagsoptionalbooleanenable_ecs_managed_tagsoptionalboolenableECSManagedTagsoptionalBooleanEnableECSManagedTagsoptionalboolEnableECSManagedTagsoptional*bool= false#Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool= false#Whether ECS Exec should be enabled.
healthCheckGracePeriodoptionalDurationhealth_check_grace_periodoptionalDurationhealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDuration#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
loadBalancersoptionalNetworkLoadBalancerProps[]load_balancersoptionaltyping.List[NetworkLoadBalancerProps]loadBalancersoptionalList<NetworkLoadBalancerProps>LoadBalancersoptionalNetworkLoadBalancerProps[]LoadBalancersoptional*[]NetworkLoadBalancerProps#The network load balancer that will serve traffic to the service.
Default: a new load balancer with a listener will be created.
propagateTagsoptionalPropagatedTagSourcepropagate_tagsoptionalPropagatedTagSourcepropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSource= none#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.
serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#Name of the service.
Default: CloudFormation-generated name.
targetGroupsoptionalNetworkTargetProps[]target_groupsoptionaltyping.List[NetworkTargetProps]targetGroupsoptionalList<NetworkTargetProps>TargetGroupsoptionalNetworkTargetProps[]TargetGroupsoptional*[]NetworkTargetProps#Properties to specify NLB target groups.
Default: default portMapping registered as target group and attached to the first defined listener
taskImageOptionsoptionalNetworkLoadBalancedTaskImagePropstask_image_optionsoptionalNetworkLoadBalancedTaskImagePropstaskImageOptionsoptionalNetworkLoadBalancedTaskImagePropsTaskImageOptionsoptionalNetworkLoadBalancedTaskImagePropsTaskImageOptionsoptionalNetworkLoadBalancedTaskImageProps= none#The properties required to create a new task definition.
Only one of TaskDefinition or TaskImageOptions must be specified.
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
Default: uses the VPC defined in the cluster or creates a new VPC.
If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.