software.amazon.awscdk.services.ecs.patterns

Interface ApplicationLoadBalancedServiceBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationLoadBalancedEc2ServiceProps, ApplicationLoadBalancedFargateServiceProps

All Known Implementing Classes:

ApplicationLoadBalancedEc2ServiceProps.Jsii$Proxy, ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy, ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.851Z")
 @Stability(value=Experimental)
public interface ApplicationLoadBalancedServiceBaseProps
extends software.amazon.jsii.JsiiSerializable

(experimental) The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApplicationLoadBalancedServiceBaseProps.Builder A builder for ApplicationLoadBalancedServiceBaseProps
static class	ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy An implementation for ApplicationLoadBalancedServiceBaseProps

Method Summary

Modifier and Type	Method and Description
static ApplicationLoadBalancedServiceBaseProps.Builder	builder()
default ICertificate	getCertificate() (experimental) Certificate Manager certificate to associate with the load balancer.
default DeploymentCircuitBreaker	getCircuitBreaker() (experimental) Whether to enable the deployment circuit breaker.
default CloudMapOptions	getCloudMapOptions() (experimental) The options for configuring an Amazon ECS service to use service discovery.
default ICluster	getCluster() (experimental) The name of the cluster that hosts the service.
default DeploymentController	getDeploymentController() (experimental) Specifies which deployment controller to use for the service.
default Number	getDesiredCount() (experimental) The desired number of instantiations of the task definition to keep running on the service.
default String	getDomainName() (experimental) The domain name for the service, e.g.
default IHostedZone	getDomainZone() (experimental) The Route53 hosted zone for the domain, e.g.
default Boolean	getEnableECSManagedTags() (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
default Duration	getHealthCheckGracePeriod() (experimental) 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 Number	getListenerPort() (experimental) Listener port of the application load balancer that will serve traffic to the service.
default IApplicationLoadBalancer	getLoadBalancer() (experimental) The application load balancer that will serve traffic to the service.
default String	getLoadBalancerName() (experimental) Name of the load balancer.
default Number	getMaxHealthyPercent() (experimental) 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() (experimental) 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 Boolean	getOpenListener() (experimental) Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
default PropagatedTagSource	getPropagateTags() (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
default ApplicationProtocol	getProtocol() (experimental) The protocol for connections from clients to the load balancer.
default ApplicationProtocolVersion	getProtocolVersion() (experimental) The protocol version to use.
default Boolean	getPublicLoadBalancer() (experimental) Determines whether the Load Balancer will be internet-facing.
default ApplicationLoadBalancedServiceRecordType	getRecordType() (experimental) Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
default Boolean	getRedirectHTTP() (experimental) Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
default String	getServiceName() (experimental) The name of the service.
default ApplicationProtocol	getTargetProtocol() (experimental) The protocol for connections from the load balancer to the ECS tasks.
default ApplicationLoadBalancedTaskImageOptions	getTaskImageOptions() (experimental) The properties required to create a new task definition.
default IVpc	getVpc() (experimental) 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 Detail

getCertificate

@Stability(value=Experimental)
 @Nullable
default ICertificate getCertificate()

(experimental) Certificate Manager certificate to associate with the load balancer.

Setting this option will set the load balancer protocol to HTTPS.

Default: - No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name.

getCircuitBreaker

@Stability(value=Experimental)
 @Nullable
default DeploymentCircuitBreaker getCircuitBreaker()

(experimental) Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default: - disabled

getCloudMapOptions

@Stability(value=Experimental)
 @Nullable
default CloudMapOptions getCloudMapOptions()

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

Default: - AWS Cloud Map service discovery is not enabled.

getCluster

@Stability(value=Experimental)
 @Nullable
default ICluster getCluster()

(experimental) 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(value=Experimental)
 @Nullable
default DeploymentController getDeploymentController()

(experimental) Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

getDesiredCount

@Stability(value=Experimental)
 @Nullable
default Number getDesiredCount()

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

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.

getDomainName

@Stability(value=Experimental)
 @Nullable
default String getDomainName()

(experimental) The domain name for the service, e.g. "api.example.com.".

Default: - No domain name.

getDomainZone

@Stability(value=Experimental)
 @Nullable
default IHostedZone getDomainZone()

(experimental) The Route53 hosted zone for the domain, e.g. "example.com.".

Default: - No Route53 hosted domain zone.

getEnableECSManagedTags

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableECSManagedTags()

(experimental) 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

getHealthCheckGracePeriod

@Stability(value=Experimental)
 @Nullable
default Duration getHealthCheckGracePeriod()

(experimental) 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

getListenerPort

@Stability(value=Experimental)
 @Nullable
default Number getListenerPort()

(experimental) Listener port of the application load balancer that will serve traffic to the service.

Default: - The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.

getLoadBalancer

@Stability(value=Experimental)
 @Nullable
default IApplicationLoadBalancer getLoadBalancer()

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

The VPC attribute of a load balancer must be specified for it to be used to create a new service with this pattern.

[disable-awslint:ref-via-interface]

Default: - a new load balancer will be created.

getLoadBalancerName

@Stability(value=Experimental)
 @Nullable
default String getLoadBalancerName()

(experimental) Name of the load balancer.

Default: - Automatically generated name.

getMaxHealthyPercent

@Stability(value=Experimental)
 @Nullable
default Number getMaxHealthyPercent()

(experimental) 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(value=Experimental)
 @Nullable
default Number getMinHealthyPercent()

(experimental) 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

getOpenListener

@Stability(value=Experimental)
 @Nullable
default Boolean getOpenListener()

(experimental) Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

Default: true -- The security group allows ingress from all IP addresses.

getPropagateTags

@Stability(value=Experimental)
 @Nullable
default PropagatedTagSource getPropagateTags()

(experimental) 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

getProtocol

@Stability(value=Experimental)
 @Nullable
default ApplicationProtocol getProtocol()

(experimental) The protocol for connections from clients to the load balancer.

The load balancer port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.

Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.

getProtocolVersion

@Stability(value=Experimental)
 @Nullable
default ApplicationProtocolVersion getProtocolVersion()

(experimental) The protocol version to use.

Default: ApplicationProtocolVersion.HTTP1

getPublicLoadBalancer

@Stability(value=Experimental)
 @Nullable
default Boolean getPublicLoadBalancer()

(experimental) Determines whether the Load Balancer will be internet-facing.

Default: true

getRecordType

@Stability(value=Experimental)
 @Nullable
default ApplicationLoadBalancedServiceRecordType getRecordType()

(experimental) 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: ApplicationLoadBalancedServiceRecordType.ALIAS

getRedirectHTTP

@Stability(value=Experimental)
 @Nullable
default Boolean getRedirectHTTP()

(experimental) Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.

Default: false

getServiceName

@Stability(value=Experimental)
 @Nullable
default String getServiceName()

(experimental) The name of the service.

Default: - CloudFormation-generated name.

getTargetProtocol

@Stability(value=Experimental)
 @Nullable
default ApplicationProtocol getTargetProtocol()

(experimental) The protocol for connections from the load balancer to the ECS tasks.

The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).

Default: HTTP.

getTaskImageOptions

@Stability(value=Experimental)
 @Nullable
default ApplicationLoadBalancedTaskImageOptions getTaskImageOptions()

(experimental) The properties required to create a new task definition.

TaskDefinition or TaskImageOptions must be specified, but not both.

Default: none

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) 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(value=Experimental)
static ApplicationLoadBalancedServiceBaseProps.Builder builder()

Returns:

a ApplicationLoadBalancedServiceBaseProps.Builder of ApplicationLoadBalancedServiceBaseProps