Package software.amazon.awscdk.services.ecs.patterns

Class NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

FargateServiceBaseProps, NetworkMultipleTargetGroupsFargateServiceProps, NetworkMultipleTargetGroupsServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

NetworkMultipleTargetGroupsFargateServiceProps

@Stability(Stable)
@Internal
public static final class NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements NetworkMultipleTargetGroupsFargateServiceProps

An implementation for NetworkMultipleTargetGroupsFargateServiceProps

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

NetworkMultipleTargetGroupsFargateServiceProps.Builder, NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(NetworkMultipleTargetGroupsFargateServiceProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the NetworkMultipleTargetGroupsFargateServiceProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAssignPublicIp()	Determines whether the service will be assigned a public IP address.
final CloudMapOptions	getCloudMapOptions()	The options for configuring an Amazon ECS service to use service discovery.
final ICluster	getCluster()	The name of the cluster that hosts the service.
final Number	getCpu()	The number of cpu units used by the task.
final Number	getDesiredCount()	The desired number of instantiations of the task definition to keep running on the service.
final Boolean	getEnableECSManagedTags()	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
final Boolean	getEnableExecuteCommand()	Whether ECS Exec should be enabled.
final Number	getEphemeralStorageGiB()	The amount (in GiB) of ephemeral storage to be allocated to the task.
final 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.
final List<NetworkLoadBalancerProps>	getLoadBalancers()	The network load balancer that will serve traffic to the service.
final 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.
final Number	getMemoryLimitMiB()	The amount (in MiB) of memory used by the task.
final 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.
final FargatePlatformVersion	getPlatformVersion()	The platform version on which to run your service.
final PropagatedTagSource	getPropagateTags()	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
final RuntimePlatform	getRuntimePlatform()	The runtime platform of the task definition.
final String	getServiceName()	Name of the service.
final List<NetworkTargetProps>	getTargetGroups()	Properties to specify NLB target groups.
final FargateTaskDefinition	getTaskDefinition()	The task definition to use for tasks in the service.
final NetworkLoadBalancedTaskImageProps	getTaskImageOptions()	The properties required to create a new task definition.
final IVpc	getVpc()	The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
final 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

Constructor Details

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(NetworkMultipleTargetGroupsFargateServiceProps.Builder builder)

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

Method Details

getAssignPublicIp

public final Boolean getAssignPublicIp()

Description copied from interface: NetworkMultipleTargetGroupsFargateServiceProps

Determines whether the service will be assigned a public IP address.

Default: false

Specified by:

getAssignPublicIp in interface NetworkMultipleTargetGroupsFargateServiceProps

getMaxHealthyPercent

public final Number getMaxHealthyPercent()

Description copied from interface: NetworkMultipleTargetGroupsFargateServiceProps

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: - 200%

Specified by:

getMaxHealthyPercent in interface NetworkMultipleTargetGroupsFargateServiceProps

getMinHealthyPercent

public final Number getMinHealthyPercent()

Description copied from interface: NetworkMultipleTargetGroupsFargateServiceProps

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: - 50%

Specified by:

getMinHealthyPercent in interface NetworkMultipleTargetGroupsFargateServiceProps

getCloudMapOptions

public final CloudMapOptions getCloudMapOptions()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getCluster

public final ICluster getCluster()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getDesiredCount

public final Number getDesiredCount()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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.

Specified by:

getDesiredCount in interface NetworkMultipleTargetGroupsServiceBaseProps

getEnableECSManagedTags

public final Boolean getEnableECSManagedTags()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getEnableExecuteCommand

public final Boolean getEnableExecuteCommand()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

Whether ECS Exec should be enabled.

Default: - false

Specified by:

getEnableExecuteCommand in interface NetworkMultipleTargetGroupsServiceBaseProps

getHealthCheckGracePeriod

public final Duration getHealthCheckGracePeriod()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getLoadBalancers

public final List<NetworkLoadBalancerProps> getLoadBalancers()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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

Default: - a new load balancer with a listener will be created.

Specified by:

getLoadBalancers in interface NetworkMultipleTargetGroupsServiceBaseProps

getPropagateTags

public final PropagatedTagSource getPropagateTags()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getServiceName

public final String getServiceName()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

Name of the service.

Default: - CloudFormation-generated name.

Specified by:

getServiceName in interface NetworkMultipleTargetGroupsServiceBaseProps

getTargetGroups

public final List<NetworkTargetProps> getTargetGroups()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

Properties to specify NLB target groups.

Default: - default portMapping registered as target group and attached to the first defined listener

Specified by:

getTargetGroups in interface NetworkMultipleTargetGroupsServiceBaseProps

getTaskImageOptions

public final NetworkLoadBalancedTaskImageProps getTaskImageOptions()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Default: - none

Specified by:

getTaskImageOptions in interface NetworkMultipleTargetGroupsServiceBaseProps

getVpc

public final IVpc getVpc()

Description copied from interface: NetworkMultipleTargetGroupsServiceBaseProps

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 NetworkMultipleTargetGroupsServiceBaseProps

getCpu

public final Number getCpu()

Description copied from interface: FargateServiceBaseProps

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

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments

This default is set in the underlying FargateTaskDefinition construct.

Default: 256

Specified by:

getCpu in interface FargateServiceBaseProps

getEphemeralStorageGiB

public final Number getEphemeralStorageGiB()

Description copied from interface: FargateServiceBaseProps

The amount (in GiB) of ephemeral storage to be allocated to the task.

The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.

Specified by:

getEphemeralStorageGiB in interface FargateServiceBaseProps

getMemoryLimitMiB

public final Number getMemoryLimitMiB()

Description copied from interface: FargateServiceBaseProps

The amount (in MiB) of memory used by the task.

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Default: 512

Specified by:

getMemoryLimitMiB in interface FargateServiceBaseProps

getPlatformVersion

public final FargatePlatformVersion getPlatformVersion()

Description copied from interface: FargateServiceBaseProps

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Default: Latest

Specified by:

getPlatformVersion in interface FargateServiceBaseProps

getRuntimePlatform

public final RuntimePlatform getRuntimePlatform()

Description copied from interface: FargateServiceBaseProps

The runtime platform of the task definition.

Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64

Specified by:

getRuntimePlatform in interface FargateServiceBaseProps

getTaskDefinition

public final FargateTaskDefinition getTaskDefinition()

Description copied from interface: FargateServiceBaseProps

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 FargateServiceBaseProps

$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