Class NetworkMultipleTargetGroupsServiceBaseProps
The properties for the base NetworkMultipleTargetGroupsEc2Service or NetworkMultipleTargetGroupsFargateService service.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.AWS.ECS.Patterns.dll
Syntax (csharp)
public class NetworkMultipleTargetGroupsServiceBaseProps : Object, INetworkMultipleTargetGroupsServiceBasePropsSyntax (vb)
Public Class NetworkMultipleTargetGroupsServiceBaseProps
Inherits Object
Implements INetworkMultipleTargetGroupsServiceBasePropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
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;
using Amazon.CDK;
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,
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
};Synopsis
Constructors
| NetworkMultipleTargetGroupsServiceBaseProps() |
Properties
| CloudMapOptions | The options for configuring an Amazon ECS service to use service discovery. |
| Cluster | The name of the cluster that hosts the service. |
| DesiredCount | The desired number of instantiations of the task definition to keep running on the service. |
| EnableECSManagedTags | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
| HealthCheckGracePeriod | 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. |
| LoadBalancers | The network load balancer that will serve traffic to the service. |
| PropagateTags | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
| ServiceName | Name of the service. |
| TargetGroups | Properties to specify NLB target groups. |
| TaskImageOptions | The properties required to create a new task definition. |
| Vpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
Constructors
NetworkMultipleTargetGroupsServiceBaseProps()
public NetworkMultipleTargetGroupsServiceBaseProps()Properties
CloudMapOptions
The options for configuring an Amazon ECS service to use service discovery.
public ICloudMapOptions CloudMapOptions { get; set; }Property Value
Remarks
Default: - AWS Cloud Map service discovery is not enabled.
Cluster
The name of the cluster that hosts the service.
public ICluster Cluster { get; set; }Property Value
Remarks
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.
DesiredCount
The desired number of instantiations of the task definition to keep running on the service.
public Nullable<double> DesiredCount { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The minimum value is 1
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.
EnableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
public Nullable<bool> EnableECSManagedTags { get; set; }Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Tagging Your Amazon ECS Resources
Default: false
HealthCheckGracePeriod
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.
public Duration HealthCheckGracePeriod { get; set; }Property Value
Remarks
Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
LoadBalancers
The network load balancer that will serve traffic to the service.
public INetworkLoadBalancerProps[] LoadBalancers { get; set; }Property Value
Remarks
Default: - a new load balancer with a listener will be created.
PropagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
public Nullable<PropagatedTagSource> PropagateTags { get; set; }Property Value
System.Nullable<PropagatedTagSource>
Remarks
Tags can only be propagated to the tasks within the service during service creation.
Default: - none
ServiceName
Name of the service.
public string ServiceName { get; set; }Property Value
System.String
Remarks
Default: - CloudFormation-generated name.
TargetGroups
Properties to specify NLB target groups.
public INetworkTargetProps[] TargetGroups { get; set; }Property Value
Remarks
Default: - default portMapping registered as target group and attached to the first defined listener
TaskImageOptions
The properties required to create a new task definition.
public INetworkLoadBalancedTaskImageProps TaskImageOptions { get; set; }Property Value
INetworkLoadBalancedTaskImageProps
Remarks
Only one of TaskDefinition or TaskImageOptions must be specified.
Default: - none
Vpc
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
public IVpc Vpc { get; set; }Property Value
Remarks
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.