software.amazon.awscdk.services.ecs.patterns

Interface NetworkLoadBalancedServiceBaseProps

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.3.0 (build 8ae966b)",
           date="2020-04-17T19:11:45.427Z")
 @Stability(value=Stable)
public interface NetworkLoadBalancedServiceBaseProps
extends software.amazon.jsii.JsiiSerializable

The properties for the base NetworkLoadBalancedEc2Service or NetworkLoadBalancedFargateService service.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static NetworkLoadBalancedServiceBaseProps.Builder	builder()
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 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 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 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 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 Detail

getCloudMapOptions

@Stability(value=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(value=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.

getDesiredCount

@Stability(value=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: 1

getDomainName

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

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

Default: - No domain name.

getDomainZone

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

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

Default: - No Route53 hosted domain zone.

getEnableEcsManagedTags

@Stability(value=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

getHealthCheckGracePeriod

@Stability(value=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

getListenerPort

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

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

Default: 80

getLoadBalancer

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
default Boolean getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

Default: true

getServiceName

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

The name of the service.

Default: - CloudFormation-generated name.

getTaskImageOptions

@Stability(value=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(value=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(value=Stable)
static NetworkLoadBalancedServiceBaseProps.Builder builder()

Returns:

a NetworkLoadBalancedServiceBaseProps.Builder of NetworkLoadBalancedServiceBaseProps