software.amazon.awscdk.services.ecs.patterns

Class QueueProcessingServiceBaseProps.Jsii$Proxy

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=Experimental)
 @Internal
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(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 QueueProcessingServiceBaseProps.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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
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.
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	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.
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.
String	getServiceName() (experimental) The name of 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.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.

Jsii$Proxy

protected Jsii$Proxy(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 QueueProcessingServiceBaseProps.Builder.

Method Detail

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