software.amazon.awscdk.services.ecs.patterns

Class NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy

All Implemented Interfaces:

NetworkLoadBalancedEc2ServiceProps, NetworkLoadBalancedServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

NetworkLoadBalancedEc2ServiceProps

@Stability(value=Experimental)
 @Internal
public static final class NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements NetworkLoadBalancedEc2ServiceProps

An implementation for NetworkLoadBalancedEc2ServiceProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedEc2ServiceProps

NetworkLoadBalancedEc2ServiceProps.Builder, NetworkLoadBalancedEc2ServiceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(Number cpu, Number memoryLimitMiB, Number memoryReservationMiB, Ec2TaskDefinition taskDefinition, DeploymentCircuitBreaker circuitBreaker, CloudMapOptions cloudMapOptions, ICluster cluster, DeploymentController deploymentController, Number desiredCount, String domainName, IHostedZone domainZone, Boolean enableEcsManagedTags, Duration healthCheckGracePeriod, Number listenerPort, INetworkLoadBalancer loadBalancer, Number maxHealthyPercent, Number minHealthyPercent, PropagatedTagSource propagateTags, Boolean publicLoadBalancer, NetworkLoadBalancedServiceRecordType recordType, String serviceName, NetworkLoadBalancedTaskImageOptions taskImageOptions, IVpc vpc) Constructor that initializes the object based on literal property values passed by the NetworkLoadBalancedEc2ServiceProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
DeploymentCircuitBreaker	getCircuitBreaker() (experimental) Whether to enable the deployment circuit breaker.
CloudMapOptions	getCloudMapOptions() (experimental) The options for configuring an Amazon ECS service to use service discovery.
ICluster	getCluster() (experimental) The name of the cluster that hosts the service.
Number	getCpu() (experimental) The number of cpu units used by the task.
DeploymentController	getDeploymentController() (experimental) Specifies which deployment controller to use for the service.
Number	getDesiredCount() (experimental) The desired number of instantiations of the task definition to keep running on the service.
String	getDomainName() (experimental) The domain name for the service, e.g.
IHostedZone	getDomainZone() (experimental) The Route53 hosted zone for the domain, e.g.
Boolean	getEnableECSManagedTags() (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
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.
Number	getListenerPort() (experimental) Listener port of the network load balancer that will serve traffic to the service.
INetworkLoadBalancer	getLoadBalancer() (experimental) The network load balancer that will serve traffic to the service.
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.
Number	getMemoryLimitMiB() (experimental) The hard limit (in MiB) of memory to present to the container.
Number	getMemoryReservationMiB() (experimental) The soft limit (in MiB) of memory to reserve for the container.
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.
PropagatedTagSource	getPropagateTags() (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
Boolean	getPublicLoadBalancer() (experimental) Determines whether the Load Balancer will be internet-facing.
NetworkLoadBalancedServiceRecordType	getRecordType() (experimental) Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
String	getServiceName() (experimental) The name of the service.
Ec2TaskDefinition	getTaskDefinition() (experimental) The task definition to use for tasks in the service.
NetworkLoadBalancedTaskImageOptions	getTaskImageOptions() (experimental) The properties required to create a new task definition.
IVpc	getVpc() (experimental) The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedEc2ServiceProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Number cpu,
                     Number memoryLimitMiB,
                     Number memoryReservationMiB,
                     Ec2TaskDefinition taskDefinition,
                     DeploymentCircuitBreaker circuitBreaker,
                     CloudMapOptions cloudMapOptions,
                     ICluster cluster,
                     DeploymentController deploymentController,
                     Number desiredCount,
                     String domainName,
                     IHostedZone domainZone,
                     Boolean enableEcsManagedTags,
                     Duration healthCheckGracePeriod,
                     Number listenerPort,
                     INetworkLoadBalancer loadBalancer,
                     Number maxHealthyPercent,
                     Number minHealthyPercent,
                     PropagatedTagSource propagateTags,
                     Boolean publicLoadBalancer,
                     NetworkLoadBalancedServiceRecordType recordType,
                     String serviceName,
                     NetworkLoadBalancedTaskImageOptions taskImageOptions,
                     IVpc vpc)

Constructor that initializes the object based on literal property values passed by the NetworkLoadBalancedEc2ServiceProps.Builder.

Method Detail

getCpu

public final Number getCpu()

Description copied from interface: NetworkLoadBalancedEc2ServiceProps

(experimental) The number of cpu units used by the task.

Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Default: none

Specified by:

getCpu in interface NetworkLoadBalancedEc2ServiceProps

getMemoryLimitMiB

public final Number getMemoryLimitMiB()

Description copied from interface: NetworkLoadBalancedEc2ServiceProps

(experimental) The hard limit (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Default: - No memory limit.

Specified by:

getMemoryLimitMiB in interface NetworkLoadBalancedEc2ServiceProps

getMemoryReservationMiB

public final Number getMemoryReservationMiB()

Description copied from interface: NetworkLoadBalancedEc2ServiceProps

(experimental) The soft limit (in MiB) of memory to reserve for the container.

When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Default: - No memory reserved.

Specified by:

getMemoryReservationMiB in interface NetworkLoadBalancedEc2ServiceProps

getTaskDefinition

public final Ec2TaskDefinition getTaskDefinition()

Description copied from interface: NetworkLoadBalancedEc2ServiceProps

(experimental) The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both..

[disable-awslint:ref-via-interface]

Default: - none

Specified by:

getTaskDefinition in interface NetworkLoadBalancedEc2ServiceProps

getCircuitBreaker

public final DeploymentCircuitBreaker getCircuitBreaker()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(experimental) Whether to enable the deployment circuit breaker.

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

Default: - disabled

Specified by:

getCircuitBreaker in interface NetworkLoadBalancedServiceBaseProps

getCloudMapOptions

public final CloudMapOptions getCloudMapOptions()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

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

Specified by:

getCloudMapOptions in interface NetworkLoadBalancedServiceBaseProps

getCluster

public final ICluster getCluster()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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.

Specified by:

getCluster in interface NetworkLoadBalancedServiceBaseProps

getDeploymentController

public final DeploymentController getDeploymentController()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

Specified by:

getDeploymentController in interface NetworkLoadBalancedServiceBaseProps

getDesiredCount

public final Number getDesiredCount()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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.

Specified by:

getDesiredCount in interface NetworkLoadBalancedServiceBaseProps

getDomainName

public final String getDomainName()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

Default: - No domain name.

Specified by:

getDomainName in interface NetworkLoadBalancedServiceBaseProps

getDomainZone

public final IHostedZone getDomainZone()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

Default: - No Route53 hosted domain zone.

Specified by:

getDomainZone in interface NetworkLoadBalancedServiceBaseProps

getEnableECSManagedTags

public final Boolean getEnableECSManagedTags()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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

Specified by:

getEnableECSManagedTags in interface NetworkLoadBalancedServiceBaseProps

getHealthCheckGracePeriod

public final Duration getHealthCheckGracePeriod()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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

Specified by:

getHealthCheckGracePeriod in interface NetworkLoadBalancedServiceBaseProps

getListenerPort

public final Number getListenerPort()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

Default: 80

Specified by:

getListenerPort in interface NetworkLoadBalancedServiceBaseProps

getLoadBalancer

public final INetworkLoadBalancer getLoadBalancer()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

Specified by:

getLoadBalancer in interface NetworkLoadBalancedServiceBaseProps

getMaxHealthyPercent

public final Number getMaxHealthyPercent()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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

Specified by:

getMaxHealthyPercent in interface NetworkLoadBalancedServiceBaseProps

getMinHealthyPercent

public final Number getMinHealthyPercent()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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

Specified by:

getMinHealthyPercent in interface NetworkLoadBalancedServiceBaseProps

getPropagateTags

public final PropagatedTagSource getPropagateTags()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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

Specified by:

getPropagateTags in interface NetworkLoadBalancedServiceBaseProps

getPublicLoadBalancer

public final Boolean getPublicLoadBalancer()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

Default: true

Specified by:

getPublicLoadBalancer in interface NetworkLoadBalancedServiceBaseProps

getRecordType

public final NetworkLoadBalancedServiceRecordType getRecordType()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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: NetworkLoadBalancedServiceRecordType.ALIAS

Specified by:

getRecordType in interface NetworkLoadBalancedServiceBaseProps

getServiceName

public final String getServiceName()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(experimental) The name of the service.

Default: - CloudFormation-generated name.

Specified by:

getServiceName in interface NetworkLoadBalancedServiceBaseProps

getTaskImageOptions

public final NetworkLoadBalancedTaskImageOptions getTaskImageOptions()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

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

One of taskImageOptions or taskDefinition must be specified.

Default: - none

Specified by:

getTaskImageOptions in interface NetworkLoadBalancedServiceBaseProps

getVpc

public final IVpc getVpc()

Description copied from interface: NetworkLoadBalancedServiceBaseProps

(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.

Specified by:

getVpc in interface NetworkLoadBalancedServiceBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object