All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: NetworkLoadBalancedEc2ServiceProps, NetworkLoadBalancedFargateServiceProps

All Known Implementing Classes:: NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy, NetworkLoadBalancedFargateServiceProps.Jsii$Proxy, NetworkLoadBalancedServiceBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:01.253Z") @Stability(Stable) public interface NetworkLoadBalancedServiceBaseProps extends software.amazon.jsii.JsiiSerializable

The properties for the base NetworkLoadBalancedEc2Service or NetworkLoadBalancedFargateService service.

Example:

 // 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.elasticloadbalancingv2.*;
 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;
 ListenerCertificate listenerCertificate;
 LogDriver logDriver;
 INamespace namespace;
 NetworkLoadBalancer networkLoadBalancer;
 Role role;
 Secret secret;
 Vpc vpc;
 NetworkLoadBalancedServiceBaseProps networkLoadBalancedServiceBaseProps = NetworkLoadBalancedServiceBaseProps.builder()
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .circuitBreaker(DeploymentCircuitBreaker.builder()
                 .enable(false)
                 .rollback(false)
                 .build())
         .cloudMapOptions(CloudMapOptions.builder()
                 .cloudMapNamespace(namespace)
                 .container(containerDefinition)
                 .containerPort(123)
                 .dnsRecordType(DnsRecordType.A)
                 .dnsTtl(Duration.minutes(30))
                 .failureThreshold(123)
                 .name("name")
                 .build())
         .cluster(cluster)
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .desiredCount(123)
         .domainName("domainName")
         .domainZone(hostedZone)
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriod(Duration.minutes(30))
         .ipAddressType(IpAddressType.IPV4)
         .listenerCertificate(listenerCertificate)
         .listenerPort(123)
         .loadBalancer(networkLoadBalancer)
         .maxHealthyPercent(123)
         .minHealthyPercent(123)
         .propagateTags(PropagatedTagSource.SERVICE)
         .publicLoadBalancer(false)
         .recordType(NetworkLoadBalancedServiceRecordType.ALIAS)
         .serviceName("serviceName")
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(containerImage)
                 // the properties below are optional
                 .containerName("containerName")
                 .containerPort(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();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

NetworkLoadBalancedServiceBaseProps.Builder

A builder for NetworkLoadBalancedServiceBaseProps

static final class

NetworkLoadBalancedServiceBaseProps.Jsii$Proxy

An implementation for NetworkLoadBalancedServiceBaseProps
Method Summary

Modifier and Type

Method

Description

static NetworkLoadBalancedServiceBaseProps.Builder

builder()

default List<CapacityProviderStrategy>

getCapacityProviderStrategies()

A list of Capacity Provider strategies used to place a service.

default DeploymentCircuitBreaker

getCircuitBreaker()

Whether to enable the deployment circuit breaker.

default CloudMapOptions

getCloudMapOptions()

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

default ICluster

getCluster()

The name of the cluster that hosts the service.

default DeploymentController

getDeploymentController()

Specifies which deployment controller to use for the service.

default Number

getDesiredCount()

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

default String

getDomainName()

The domain name for the service, e.g.

default IHostedZone

getDomainZone()

The Route53 hosted zone for the domain, e.g.

default Boolean

getEnableECSManagedTags()

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

default Boolean

getEnableExecuteCommand()

Whether ECS Exec should be enabled.

default Duration

getHealthCheckGracePeriod()

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 IpAddressType

getIpAddressType()

The type of IP addresses to use.

default IListenerCertificate

getListenerCertificate()

Listener certificate list of ACM cert ARNs.

default Number

getListenerPort()

Listener port of the network load balancer that will serve traffic to the service.

default INetworkLoadBalancer

getLoadBalancer()

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

default Number

getMaxHealthyPercent()

The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

default Number

getMinHealthyPercent()

The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

default PropagatedTagSource

getPropagateTags()

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

default Boolean

getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

default NetworkLoadBalancedServiceRecordType

getRecordType()

Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.

default String

getServiceName()

The name of the service.

default NetworkLoadBalancedTaskImageOptions

getTaskImageOptions()

The properties required to create a new task definition.

default IVpc

getVpc()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCapacityProviderStrategies
  
  @Stability(Stable) @Nullable default List<CapacityProviderStrategy> getCapacityProviderStrategies()
  
  A list of Capacity Provider strategies used to place a service.
  Default: - undefined
- getCircuitBreaker
  
  @Stability(Stable) @Nullable default DeploymentCircuitBreaker getCircuitBreaker()
  
  Whether to enable the deployment circuit breaker.
  If this property is defined, circuit breaker will be implicitly enabled.
  Default: - disabled
- getCloudMapOptions
  
  @Stability(Stable) @Nullable default CloudMapOptions getCloudMapOptions()
  
  The options for configuring an Amazon ECS service to use service discovery.
  Default: - AWS Cloud Map service discovery is not enabled.
- getCluster
  
  @Stability(Stable) @Nullable default ICluster getCluster()
  
  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.
- getDeploymentController
  
  @Stability(Stable) @Nullable default DeploymentController getDeploymentController()
  
  Specifies which deployment controller to use for the service.
  For more information, see Amazon ECS Deployment Types
  Default: - Rolling update (ECS)
- getDesiredCount
  
  @Stability(Stable) @Nullable default Number getDesiredCount()
  
  The desired number of instantiations of the task definition to keep running on the service.
  The minimum value is 1
  Default: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
- getDomainName
  
  @Stability(Stable) @Nullable default String getDomainName()
  
  The domain name for the service, e.g. "api.example.com.".
  Default: - No domain name.
- getDomainZone
  
  @Stability(Stable) @Nullable default IHostedZone getDomainZone()
  
  The Route53 hosted zone for the domain, e.g. "example.com.".
  Default: - No Route53 hosted domain zone.
- getEnableECSManagedTags
  
  @Stability(Stable) @Nullable default Boolean getEnableECSManagedTags()
  
  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
- getEnableExecuteCommand
  
  @Stability(Stable) @Nullable default Boolean getEnableExecuteCommand()
  
  Whether ECS Exec should be enabled.
  Default: - false
- getHealthCheckGracePeriod
  
  @Stability(Stable) @Nullable default Duration getHealthCheckGracePeriod()
  
  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
- getIpAddressType
  
  @Stability(Stable) @Nullable default IpAddressType getIpAddressType()
  
  The type of IP addresses to use.
  If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.
  Default: IpAddressType.IPV4
  See Also:
  
  https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-ip-address-type.html
- getListenerCertificate
  
  @Stability(Stable) @Nullable default IListenerCertificate getListenerCertificate()
  
  Listener certificate list of ACM cert ARNs.
  If you provide a certificate, the listener's protocol will be TLS. If not, the listener's protocol will be TCP.
  Default: - none
- getListenerPort
  
  @Stability(Stable) @Nullable default Number getListenerPort()
  
  Listener port of the network load balancer that will serve traffic to the service.
  Default: 80 or 443 with listenerCertificate provided
- getLoadBalancer
  
  @Stability(Stable) @Nullable default INetworkLoadBalancer getLoadBalancer()
  
  The network load balancer that will serve traffic to the service.
  If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().
  [disable-awslint:ref-via-interface]
  Default: - a new load balancer will be created.
- getMaxHealthyPercent
  
  @Stability(Stable) @Nullable default Number getMaxHealthyPercent()
  
  The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
  Default: - 100 if daemon, otherwise 200
- getMinHealthyPercent
  
  @Stability(Stable) @Nullable default Number getMinHealthyPercent()
  
  The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
  Default: - 0 if daemon, otherwise 50
- getPropagateTags
  
  @Stability(Stable) @Nullable default PropagatedTagSource getPropagateTags()
  
  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
- getPublicLoadBalancer
  
  @Stability(Stable) @Nullable default Boolean getPublicLoadBalancer()
  
  Determines whether the Load Balancer will be internet-facing.
  Default: true
- getRecordType
  
  @Stability(Stable) @Nullable default NetworkLoadBalancedServiceRecordType getRecordType()
  
  Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
  This is useful if you need to work with DNS systems that do not support alias records.
  Default: NetworkLoadBalancedServiceRecordType.ALIAS
- getServiceName
  
  @Stability(Stable) @Nullable default String getServiceName()
  
  The name of the service.
  Default: - CloudFormation-generated name.
- getTaskImageOptions
  
  @Stability(Stable) @Nullable default NetworkLoadBalancedTaskImageOptions getTaskImageOptions()
  
  The properties required to create a new task definition.
  One of taskImageOptions or taskDefinition must be specified.
  Default: - none
- getVpc
  
  @Stability(Stable) @Nullable default IVpc getVpc()
  
  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.
- builder
  
  @Stability(Stable) static NetworkLoadBalancedServiceBaseProps.Builder builder()
  
  Returns:
  
  a NetworkLoadBalancedServiceBaseProps.Builder of NetworkLoadBalancedServiceBaseProps

Interface NetworkLoadBalancedServiceBaseProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCapacityProviderStrategies

getCircuitBreaker

getCloudMapOptions

getCluster

getDeploymentController

getDesiredCount

getDomainName

getDomainZone

getEnableECSManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriod

getIpAddressType

getListenerCertificate

getListenerPort

getLoadBalancer

getMaxHealthyPercent

getMinHealthyPercent

getPropagateTags

getPublicLoadBalancer

getRecordType

getServiceName

getTaskImageOptions

getVpc

builder