QueueProcessingServiceBaseProps.Jsii$Proxy (software.amazon.awscdk:ecs-patterns 1.32.1 API)

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

All Implemented Interfaces:

QueueProcessingServiceBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

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

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.QueueProcessingServiceBaseProps
  QueueProcessingServiceBaseProps.Builder, QueueProcessingServiceBaseProps.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.

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)`
`ICluster`	`getCluster()` The name of the cluster that hosts the service.
`List<String>`	`getCommand()` The command that is passed to the container.
`Number`	`getDesiredTaskCount()` The desired number of instantiations of the task definition to keep running on the service.
`Boolean`	`getEnableEcsManagedTags()` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`Boolean`	`getEnableLogging()` Flag to indicate whether to enable logging.
`Map<String,String>`	`getEnvironment()` The environment variables to pass to the container.
`String`	`getFamily()` The name of a family that the task definition is registered to.
`ContainerImage`	`getImage()` The image used to start a container.
`LogDriver`	`getLogDriver()` The log driver to use.
`Number`	`getMaxReceiveCount()` The maximum number of times that a message can be received by consumers.
`Number`	`getMaxScalingCapacity()` Maximum capacity to scale to.
`PropagatedTagSource`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`IQueue`	`getQueue()` A queue for which to process items from.
`Duration`	`getRetentionPeriod()` The number of seconds that Dead Letter Queue retains a message.
`List<ScalingInterval>`	`getScalingSteps()` The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.
`Map<String,Secret>`	`getSecrets()` The secret to expose to the container as an environment variable.
`String`	`getServiceName()` The name of the service.
`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

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.QueueProcessingServiceBaseProps
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.
- Method Detail
  - getImage
```
public ContainerImage getImage()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The image used to start a container.
    
    Specified by:
    
    getImage in interface QueueProcessingServiceBaseProps
  - getCluster
```
public ICluster getCluster()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 List<String> getCommand()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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
  - getDesiredTaskCount
```
public Number getDesiredTaskCount()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The desired number of instantiations of the task definition to keep running on the service.
    Default: 1
    
    Specified by:
    
    getDesiredTaskCount in interface QueueProcessingServiceBaseProps
  - getEnableEcsManagedTags
```
public Boolean getEnableEcsManagedTags()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 Boolean getEnableLogging()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    Flag to indicate whether to enable logging.
    Default: true
    
    Specified by:
    
    getEnableLogging in interface QueueProcessingServiceBaseProps
  - getEnvironment
```
public Map<String,String> getEnvironment()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 String getFamily()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 LogDriver getLogDriver()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The log driver to use.
    Default: - AwsLogDriver if enableLogging is true
    
    Specified by:
    
    getLogDriver in interface QueueProcessingServiceBaseProps
  - getMaxReceiveCount
```
public Number getMaxReceiveCount()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 Number getMaxScalingCapacity()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    Maximum capacity to scale to.
    Default: (desiredTaskCount * 2)
    
    Specified by:
    
    getMaxScalingCapacity in interface QueueProcessingServiceBaseProps
  - getPropagateTags
```
public PropagatedTagSource getPropagateTags()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 IQueue getQueue()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 Duration getRetentionPeriod()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The number of seconds that Dead Letter Queue retains a message.
    Default: Duration.days(14)
    
    Specified by:
    
    getRetentionPeriod in interface QueueProcessingServiceBaseProps
  - getScalingSteps
```
public List<ScalingInterval> getScalingSteps()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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 Map<String,Secret> getSecrets()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The secret to expose to the container as an environment variable.
    Default: - No secret environment variables.
    
    Specified by:
    
    getSecrets in interface QueueProcessingServiceBaseProps
  - getServiceName
```
public String getServiceName()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    The name of the service.
    Default: - CloudFormation-generated name.
    
    Specified by:
    
    getServiceName in interface QueueProcessingServiceBaseProps
  - getVpc
```
public IVpc getVpc()
```
    Description copied from interface: QueueProcessingServiceBaseProps
    
    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
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class QueueProcessingServiceBaseProps.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.QueueProcessingServiceBaseProps

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

Constructor Detail

Jsii$Proxy

Method Detail

getImage

getCluster

getCommand

getDesiredTaskCount

getEnableEcsManagedTags

getEnableLogging

getEnvironment

getFamily

getLogDriver

getMaxReceiveCount

getMaxScalingCapacity

getPropagateTags

getQueue

getRetentionPeriod

getScalingSteps

getSecrets

getServiceName

getVpc

$jsii$toJson

equals

hashCode