java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:: FargateServiceBaseProps, NetworkLoadBalancedFargateServiceProps, NetworkLoadBalancedServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: NetworkLoadBalancedFargateServiceProps

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

An implementation for NetworkLoadBalancedFargateServiceProps

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.NetworkLoadBalancedFargateServiceProps
NetworkLoadBalancedFargateServiceProps.Builder, NetworkLoadBalancedFargateServiceProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(NetworkLoadBalancedFargateServiceProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the NetworkLoadBalancedFargateServiceProps.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 List<CapacityProviderStrategy>

getCapacityProviderStrategies()

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

final DeploymentCircuitBreaker

getCircuitBreaker()

Whether to enable the deployment circuit breaker.

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 DeploymentController

getDeploymentController()

Specifies which deployment controller to use for the service.

final Number

getDesiredCount()

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

final String

getDomainName()

The domain name for the service, e.g.

final IHostedZone

getDomainZone()

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

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 IpAddressType

getIpAddressType()

The type of IP addresses to use.

final IListenerCertificate

getListenerCertificate()

Listener certificate list of ACM cert ARNs.

final Number

getListenerPort()

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

final INetworkLoadBalancer

getLoadBalancer()

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 Boolean

getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

final NetworkLoadBalancedServiceRecordType

getRecordType()

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

final RuntimePlatform

getRuntimePlatform()

The runtime platform of the task definition.

final List<ISecurityGroup>

getSecurityGroups()

The security groups to associate with the service.

final String

getServiceName()

The name of the service.

final FargateTaskDefinition

getTaskDefinition()

The task definition to use for tasks in the service.

final NetworkLoadBalancedTaskImageOptions

getTaskImageOptions()

The properties required to create a new task definition.

final SubnetSelection

getTaskSubnets()

The subnets to associate with the service.

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(NetworkLoadBalancedFargateServiceProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the NetworkLoadBalancedFargateServiceProps.Builder.
Method Details
- getAssignPublicIp
  
  public final Boolean getAssignPublicIp()
  
  Description copied from interface: NetworkLoadBalancedFargateServiceProps
  
  Determines whether the service will be assigned a public IP address.
  Default: false
  
  Specified by:
  
  getAssignPublicIp in interface NetworkLoadBalancedFargateServiceProps
- getSecurityGroups
  
  public final List<ISecurityGroup> getSecurityGroups()
  
  Description copied from interface: NetworkLoadBalancedFargateServiceProps
  
  The security groups to associate with the service.
  If you do not specify a security group, a new security group is created.
  Default: - A new security group is created.
  
  Specified by:
  
  getSecurityGroups in interface NetworkLoadBalancedFargateServiceProps
- getTaskSubnets
  
  public final SubnetSelection getTaskSubnets()
  
  Description copied from interface: NetworkLoadBalancedFargateServiceProps
  
  The subnets to associate with the service.
  Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
  
  Specified by:
  
  getTaskSubnets in interface NetworkLoadBalancedFargateServiceProps
- getCapacityProviderStrategies
  
  public final List<CapacityProviderStrategy> getCapacityProviderStrategies()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  A list of Capacity Provider strategies used to place a service.
  Default: - undefined
  
  Specified by:
  
  getCapacityProviderStrategies in interface NetworkLoadBalancedServiceBaseProps
- getCircuitBreaker
  
  public final DeploymentCircuitBreaker getCircuitBreaker()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
  
  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
  
  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
  
  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
  
  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 NetworkLoadBalancedServiceBaseProps
- getDomainName
  
  public final String getDomainName()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
  
  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
  
  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
- getEnableExecuteCommand
  
  public final Boolean getEnableExecuteCommand()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  Whether ECS Exec should be enabled.
  Default: - false
  
  Specified by:
  
  getEnableExecuteCommand in interface NetworkLoadBalancedServiceBaseProps
- getHealthCheckGracePeriod
  
  public final Duration getHealthCheckGracePeriod()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
- getIpAddressType
  
  public final IpAddressType getIpAddressType()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
  Specified by:
  
  getIpAddressType in interface NetworkLoadBalancedServiceBaseProps
  
  See Also:
  
  https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-ip-address-type.html
- getListenerCertificate
  
  public final IListenerCertificate getListenerCertificate()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
  
  Specified by:
  
  getListenerCertificate in interface NetworkLoadBalancedServiceBaseProps
- getListenerPort
  
  public final Number getListenerPort()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  Listener port of the network load balancer that will serve traffic to the service.
  Default: 80 or 443 with listenerCertificate provided
  
  Specified by:
  
  getListenerPort in interface NetworkLoadBalancedServiceBaseProps
- getLoadBalancer
  
  public final INetworkLoadBalancer getLoadBalancer()
  
  Description copied from interface: NetworkLoadBalancedServiceBaseProps
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
  
  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
- 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

Class NetworkLoadBalancedFargateServiceProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getAssignPublicIp

getSecurityGroups

getTaskSubnets

getCapacityProviderStrategies

getCircuitBreaker

getCloudMapOptions

getCluster

getDeploymentController

getDesiredCount

getDomainName

getDomainZone

getEnableECSManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriod

getIpAddressType

getListenerCertificate

getListenerPort

getLoadBalancer

getMaxHealthyPercent

getMinHealthyPercent

getPropagateTags

getPublicLoadBalancer

getRecordType

getServiceName

getTaskImageOptions

getVpc

getCpu

getEphemeralStorageGiB

getMemoryLimitMiB

getPlatformVersion

getRuntimePlatform

getTaskDefinition

$jsii$toJson

equals

hashCode