QueueProcessingFargateServiceProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

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

All Implemented Interfaces:

QueueProcessingFargateServiceProps, QueueProcessingServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

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

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.QueueProcessingFargateServiceProps
  QueueProcessingFargateServiceProps.Builder, QueueProcessingFargateServiceProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	Jsii$Proxy(Boolean assignPublicIp, String containerName, Number cpu, Number memoryLimitMiB, FargatePlatformVersion platformVersion, List<? extends ISecurityGroup> securityGroups, SubnetSelection taskSubnets, ContainerImage image, DeploymentCircuitBreaker circuitBreaker, ICluster cluster, List<String> command, DeploymentController deploymentController, Boolean enableEcsManagedTags, Boolean enableLogging, Map<String,String> environment, String family, LogDriver logDriver, Number maxHealthyPercent, Number maxReceiveCount, Number maxScalingCapacity, Number minHealthyPercent, Number minScalingCapacity, PropagatedTagSource propagateTags, IQueue queue, Duration retentionPeriod, List<? extends ScalingInterval> scalingSteps, Map<String,? extends Secret> secrets, String serviceName, IVpc vpc) Constructor that initializes the object based on literal property values passed by the `QueueProcessingFargateServiceProps.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

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)`
`Boolean`	`getAssignPublicIp()` (experimental) Specifies whether the task's elastic network interface receives a public IP address.
`DeploymentCircuitBreaker`	`getCircuitBreaker()` (experimental) Whether to enable the deployment circuit breaker.
`ICluster`	`getCluster()` (experimental) The name of the cluster that hosts the service.
`List<String>`	`getCommand()` (experimental) The command that is passed to the container.
`String`	`getContainerName()` (experimental) Optional name for the container added.
`Number`	`getCpu()` (experimental) The number of cpu units used by the task.
`DeploymentController`	`getDeploymentController()` (experimental) Specifies which deployment controller to use for the service.
`Boolean`	`getEnableECSManagedTags()` (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`Boolean`	`getEnableLogging()` (experimental) Flag to indicate whether to enable logging.
`Map<String,String>`	`getEnvironment()` (experimental) The environment variables to pass to the container.
`String`	`getFamily()` (experimental) The name of a family that the task definition is registered to.
`ContainerImage`	`getImage()` (experimental) The image used to start a container.
`LogDriver`	`getLogDriver()` (experimental) The log driver to use.
`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`	`getMaxReceiveCount()` (experimental) The maximum number of times that a message can be received by consumers.
`Number`	`getMaxScalingCapacity()` (experimental) Maximum capacity to scale to.
`Number`	`getMemoryLimitMiB()` (experimental) The amount (in MiB) of memory used by the task.
`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.
`Number`	`getMinScalingCapacity()` (experimental) Minimum capacity to scale to.
`FargatePlatformVersion`	`getPlatformVersion()` (experimental) The platform version on which to run your service.
`PropagatedTagSource`	`getPropagateTags()` (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`IQueue`	`getQueue()` (experimental) A queue for which to process items from.
`Duration`	`getRetentionPeriod()` (experimental) The number of seconds that Dead Letter Queue retains a message.
`List<ScalingInterval>`	`getScalingSteps()` (experimental) The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
`Map<String,Secret>`	`getSecrets()` (experimental) The secret to expose to the container as an environment variable.
`List<ISecurityGroup>`	`getSecurityGroups()` (experimental) The security groups to associate with the service.
`String`	`getServiceName()` (experimental) The name of the service.
`SubnetSelection`	`getTaskSubnets()` (experimental) The subnets to associate with the service.
`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.QueueProcessingFargateServiceProps
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(Boolean assignPublicIp,
                     String containerName,
                     Number cpu,
                     Number memoryLimitMiB,
                     FargatePlatformVersion platformVersion,
                     List<? extends ISecurityGroup> securityGroups,
                     SubnetSelection taskSubnets,
                     ContainerImage image,
                     DeploymentCircuitBreaker circuitBreaker,
                     ICluster cluster,
                     List<String> command,
                     DeploymentController deploymentController,
                     Boolean enableEcsManagedTags,
                     Boolean enableLogging,
                     Map<String,String> environment,
                     String family,
                     LogDriver logDriver,
                     Number maxHealthyPercent,
                     Number maxReceiveCount,
                     Number maxScalingCapacity,
                     Number minHealthyPercent,
                     Number minScalingCapacity,
                     PropagatedTagSource propagateTags,
                     IQueue queue,
                     Duration retentionPeriod,
                     List<? extends ScalingInterval> scalingSteps,
                     Map<String,? extends Secret> secrets,
                     String serviceName,
                     IVpc vpc)
```
    Constructor that initializes the object based on literal property values passed by the QueueProcessingFargateServiceProps.Builder.
- Method Detail
  - getAssignPublicIp
```
public final Boolean getAssignPublicIp()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) Specifies whether the task's elastic network interface receives a public IP address.
    If true, each task will receive a public IP address.
    Default: false
    
    Specified by:
    
    getAssignPublicIp in interface QueueProcessingFargateServiceProps
  - getContainerName
```
public final String getContainerName()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) Optional name for the container added.
    Default: - QueueProcessingContainer
    
    Specified by:
    
    getContainerName in interface QueueProcessingFargateServiceProps
  - getCpu
```
public final Number getCpu()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (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: 256
    
    Specified by:
    
    getCpu in interface QueueProcessingFargateServiceProps
  - getMemoryLimitMiB
```
public final Number getMemoryLimitMiB()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) 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:
    0.5GB, 1GB, 2GB - Available cpu values: 256 (.25 vCPU)
    1GB, 2GB, 3GB, 4GB - Available cpu values: 512 (.5 vCPU)
    2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available cpu values: 1024 (1 vCPU)
    Between 4GB and 16GB in 1GB increments - Available cpu values: 2048 (2 vCPU)
    Between 8GB and 30GB in 1GB increments - Available cpu values: 4096 (4 vCPU)
    This default is set in the underlying FargateTaskDefinition construct.
    Default: 512
    
    Specified by:
    
    getMemoryLimitMiB in interface QueueProcessingFargateServiceProps
  - getPlatformVersion
```
public final FargatePlatformVersion getPlatformVersion()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) 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 QueueProcessingFargateServiceProps
  - getSecurityGroups
```
public final List<ISecurityGroup> getSecurityGroups()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) The security groups to associate with the service.
    If you do not specify a security group, the default security group for the VPC is used.
    Default: - A new security group is created.
    
    Specified by:
    
    getSecurityGroups in interface QueueProcessingFargateServiceProps
  - getTaskSubnets
```
public final SubnetSelection getTaskSubnets()
```
    Description copied from interface: QueueProcessingFargateServiceProps
    
    (experimental) 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 QueueProcessingFargateServiceProps
  - getImage
```
public final ContainerImage getImage()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The image used to start a container.
    
    Specified by:
    
    getImage in interface QueueProcessingServiceBaseProps
  - getCircuitBreaker
```
public final DeploymentCircuitBreaker getCircuitBreaker()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - getCluster
```
public final ICluster getCluster()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - getCommand
```
public final List<String> getCommand()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The command that is passed to the container.
    If you provide a shell command as a single string, you have to quote command-line arguments.
    Default: - CMD value built into container image.
    
    Specified by:
    
    getCommand in interface QueueProcessingServiceBaseProps
  - getDeploymentController
```
public final DeploymentController getDeploymentController()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - getEnableECSManagedTags
```
public final Boolean getEnableECSManagedTags()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - getEnableLogging
```
public final Boolean getEnableLogging()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) Flag to indicate whether to enable logging.
    Default: true
    
    Specified by:
    
    getEnableLogging in interface QueueProcessingServiceBaseProps
  - getEnvironment
```
public final Map<String,String> getEnvironment()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The environment variables to pass to the container.
    The variable QUEUE_NAME with value queue.queueName will always be passed.
    Default: 'QUEUE_NAME: queue.queueName'
    
    Specified by:
    
    getEnvironment in interface QueueProcessingServiceBaseProps
  - getFamily
```
public final String getFamily()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The name of a family that the task definition is registered to.
    A family groups multiple versions of a task definition.
    Default: - Automatically generated name.
    
    Specified by:
    
    getFamily in interface QueueProcessingServiceBaseProps
  - getLogDriver
```
public final LogDriver getLogDriver()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The log driver to use.
    Default: - AwsLogDriver if enableLogging is true
    
    Specified by:
    
    getLogDriver in interface QueueProcessingServiceBaseProps
  - getMaxHealthyPercent
```
public final Number getMaxHealthyPercent()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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: - default from underlying service.
    
    Specified by:
    
    getMaxHealthyPercent in interface QueueProcessingServiceBaseProps
  - getMaxReceiveCount
```
public final Number getMaxReceiveCount()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The maximum number of times that a message can be received by consumers.
    When this value is exceeded for a message the message will be automatically sent to the Dead Letter Queue.
    Default: 3
    
    Specified by:
    
    getMaxReceiveCount in interface QueueProcessingServiceBaseProps
  - getMaxScalingCapacity
```
public final Number getMaxScalingCapacity()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) Maximum capacity to scale to.
    Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is (desiredTaskCount * 2); if true, the default is 2.
    
    Specified by:
    
    getMaxScalingCapacity in interface QueueProcessingServiceBaseProps
  - getMinHealthyPercent
```
public final Number getMinHealthyPercent()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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: - default from underlying service.
    
    Specified by:
    
    getMinHealthyPercent in interface QueueProcessingServiceBaseProps
  - getMinScalingCapacity
```
public final Number getMinScalingCapacity()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) Minimum capacity to scale to.
    Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is the desiredTaskCount; if true, the default is 1.
    
    Specified by:
    
    getMinScalingCapacity in interface QueueProcessingServiceBaseProps
  - getPropagateTags
```
public final PropagatedTagSource getPropagateTags()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - getQueue
```
public final IQueue getQueue()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) A queue for which to process items from.
    If specified and this is a FIFO queue, the queue name must end in the string '.fifo'. See CreateQueue
    Default: 'SQSQueue with CloudFormation-generated name'
    
    Specified by:
    
    getQueue in interface QueueProcessingServiceBaseProps
  - getRetentionPeriod
```
public final Duration getRetentionPeriod()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The number of seconds that Dead Letter Queue retains a message.
    Default: Duration.days(14)
    
    Specified by:
    
    getRetentionPeriod in interface QueueProcessingServiceBaseProps
  - getScalingSteps
```
public final List<ScalingInterval> getScalingSteps()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
    Maps a range of metric values to a particular scaling behavior. See Simple and Step Scaling Policies for Amazon EC2 Auto Scaling
    Default: [{ upper: 0, change: -1 },{ lower: 100, change: +1 },{ lower: 500, change: +5 }]
    
    Specified by:
    
    getScalingSteps in interface QueueProcessingServiceBaseProps
  - getSecrets
```
public final Map<String,Secret> getSecrets()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The secret to expose to the container as an environment variable.
    Default: - No secret environment variables.
    
    Specified by:
    
    getSecrets in interface QueueProcessingServiceBaseProps
  - getServiceName
```
public final String getServiceName()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (experimental) The name of the service.
    Default: - CloudFormation-generated name.
    
    Specified by:
    
    getServiceName in interface QueueProcessingServiceBaseProps
  - getVpc
```
public final IVpc getVpc()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    (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 QueueProcessingServiceBaseProps
  - $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 QueueProcessingFargateServiceProps.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.QueueProcessingFargateServiceProps

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAssignPublicIp

getContainerName

getCpu

getMemoryLimitMiB

getPlatformVersion

getSecurityGroups

getTaskSubnets

getImage

getCircuitBreaker

getCluster

getCommand

getDeploymentController

getEnableECSManagedTags

getEnableLogging

getEnvironment

getFamily

getLogDriver

getMaxHealthyPercent

getMaxReceiveCount

getMaxScalingCapacity

getMinHealthyPercent

getMinScalingCapacity

getPropagateTags

getQueue

getRetentionPeriod

getScalingSteps

getSecrets

getServiceName

getVpc

$jsii$toJson

equals

hashCode