NetworkLoadBalancedServiceBaseProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBaseProps.Jsii$Proxy

All Implemented Interfaces:

NetworkLoadBalancedServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

NetworkLoadBalancedServiceBaseProps
```
@Stability(value=Stable)
 @Internal
public static final class NetworkLoadBalancedServiceBaseProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements NetworkLoadBalancedServiceBaseProps
```
An implementation for NetworkLoadBalancedServiceBaseProps

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.NetworkLoadBalancedServiceBaseProps
  NetworkLoadBalancedServiceBaseProps.Builder, NetworkLoadBalancedServiceBaseProps.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(NetworkLoadBalancedServiceBaseProps.Builder builder)` Constructor that initializes the object based on literal property values passed by the `NetworkLoadBalancedServiceBaseProps.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`List<CapacityProviderStrategy>`	`getCapacityProviderStrategies()` A list of Capacity Provider strategies used to place a service.
`DeploymentCircuitBreaker`	`getCircuitBreaker()` Whether to enable the deployment circuit breaker.
`CloudMapOptions`	`getCloudMapOptions()` The options for configuring an Amazon ECS service to use service discovery.
`ICluster`	`getCluster()` The name of the cluster that hosts the service.
`DeploymentController`	`getDeploymentController()` Specifies which deployment controller to use for the service.
`Number`	`getDesiredCount()` The desired number of instantiations of the task definition to keep running on the service.
`String`	`getDomainName()` The domain name for the service, e.g.
`IHostedZone`	`getDomainZone()` The Route53 hosted zone for the domain, e.g.
`Boolean`	`getEnableECSManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`Boolean`	`getEnableExecuteCommand()` Whether ECS Exec should be enabled.
`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.
`Number`	`getListenerPort()` Listener port of the network load balancer that will serve traffic to the service.
`INetworkLoadBalancer`	`getLoadBalancer()` The network load balancer that will serve traffic to the service.
`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.
`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.
`PropagatedTagSource`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`Boolean`	`getPublicLoadBalancer()` Determines whether the Load Balancer will be internet-facing.
`NetworkLoadBalancedServiceRecordType`	`getRecordType()` Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
`String`	`getServiceName()` The name of the service.
`NetworkLoadBalancedTaskImageOptions`	`getTaskImageOptions()` The properties required to create a new task definition.
`IVpc`	`getVpc()` 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.NetworkLoadBalancedServiceBaseProps
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(NetworkLoadBalancedServiceBaseProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the NetworkLoadBalancedServiceBaseProps.Builder.
- Method Detail
  - 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: - 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
    
    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
  - 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
    
    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
  - $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 NetworkLoadBalancedServiceBaseProps.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.NetworkLoadBalancedServiceBaseProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getCapacityProviderStrategies

getCircuitBreaker

getCloudMapOptions

getCluster

getDeploymentController

getDesiredCount

getDomainName

getDomainZone

getEnableECSManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriod

getListenerPort

getLoadBalancer

getMaxHealthyPercent

getMinHealthyPercent

getPropagateTags

getPublicLoadBalancer

getRecordType

getServiceName

getTaskImageOptions

getVpc

$jsii$toJson

equals

hashCode