Class QueueProcessingFargateServiceProps.Jsii$Proxy
- All Implemented Interfaces:
FargateServiceBaseProps,QueueProcessingFargateServiceProps,QueueProcessingServiceBaseProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
QueueProcessingFargateServiceProps
QueueProcessingFargateServiceProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.patterns.QueueProcessingFargateServiceProps
QueueProcessingFargateServiceProps.Builder, QueueProcessingFargateServiceProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theQueueProcessingFargateServiceProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal BooleanSpecifies whether the task's elastic network interface receives a public IP address.final List<CapacityProviderStrategy> A list of Capacity Provider strategies used to place a service.final DeploymentCircuitBreakerWhether to enable the deployment circuit breaker.final IClusterThe name of the cluster that hosts the service.The command that is passed to the container.final StringOptional name for the container added.final DurationGrace period after scaling activity in seconds.final NumbergetCpu()The number of cpu units used by the task.final NumberThe target CPU utilization percentage for CPU based scaling strategy when enabled.final DeploymentControllerSpecifies which deployment controller to use for the service.final BooleanFlag to disable CPU based auto scaling strategy on the service.final BooleanSpecifies whether to enable Amazon ECS managed tags for the tasks within the service.final BooleanWhether ECS Exec should be enabled.final BooleanFlag to indicate whether to enable logging.The environment variables to pass to the container.final NumberThe amount (in GiB) of ephemeral storage to be allocated to the task.final StringThe name of a family that the task definition is registered to.final HealthCheckThe health check command and associated configuration parameters for the container.final DurationThe 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 ContainerImagegetImage()The image used to start a container.final LogDriverThe log driver to use.final NumberThe 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 NumberThe maximum number of times that a message can be received by consumers.final NumberMaximum capacity to scale to.final NumberThe amount (in MiB) of memory used by the task.final NumberThe 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 NumberMinimum capacity to scale to.final FargatePlatformVersionThe platform version on which to run your service.final PropagatedTagSourceSpecifies whether to propagate the tags from the task definition or the service to the tasks in the service.final IQueuegetQueue()A queue for which to process items from.final DurationThe number of seconds that Dead Letter Queue retains a message.final RuntimePlatformThe runtime platform of the task definition.final List<ScalingInterval> The intervals for scaling based on the SQS queue's ApproximateNumberOfMessagesVisible metric.The secret to expose to the container as an environment variable.final List<ISecurityGroup> The security groups to associate with the service.final StringThe name of the service.final FargateTaskDefinitionThe task definition to use for tasks in the service.final SubnetSelectionThe subnets to associate with the service.final DurationTimeout of processing a single message.final IVpcgetVpc()The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theQueueProcessingFargateServiceProps.Builder.
-
-
Method Details
-
getAssignPublicIp
Description copied from interface:QueueProcessingFargateServicePropsSpecifies 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:
getAssignPublicIpin interfaceQueueProcessingFargateServiceProps
-
getContainerName
Description copied from interface:QueueProcessingFargateServicePropsOptional name for the container added.This name is not used when
taskDefinitionis provided.Default: - QueueProcessingContainer
- Specified by:
getContainerNamein interfaceQueueProcessingFargateServiceProps
-
getHealthCheck
Description copied from interface:QueueProcessingFargateServicePropsThe health check command and associated configuration parameters for the container.Default: - Health check configuration from container.
- Specified by:
getHealthCheckin interfaceQueueProcessingFargateServiceProps
-
getHealthCheckGracePeriod
Description copied from interface:QueueProcessingFargateServicePropsThe 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:
getHealthCheckGracePeriodin interfaceQueueProcessingFargateServiceProps
-
getSecurityGroups
Description copied from interface:QueueProcessingFargateServicePropsThe 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:
getSecurityGroupsin interfaceQueueProcessingFargateServiceProps
-
getTaskSubnets
Description copied from interface:QueueProcessingFargateServicePropsThe 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:
getTaskSubnetsin interfaceQueueProcessingFargateServiceProps
-
getCapacityProviderStrategies
Description copied from interface:QueueProcessingServiceBasePropsA list of Capacity Provider strategies used to place a service.Default: - undefined
- Specified by:
getCapacityProviderStrategiesin interfaceQueueProcessingServiceBaseProps
-
getCircuitBreaker
Description copied from interface:QueueProcessingServiceBasePropsWhether to enable the deployment circuit breaker.If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
- Specified by:
getCircuitBreakerin interfaceQueueProcessingServiceBaseProps
-
getCluster
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getClusterin interfaceQueueProcessingServiceBaseProps
-
getCommand
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getCommandin interfaceQueueProcessingServiceBaseProps
-
getCooldown
Description copied from interface:QueueProcessingServiceBasePropsGrace period after scaling activity in seconds.Subsequent scale outs during the cooldown period are squashed so that only the biggest scale out happens.
Subsequent scale ins during the cooldown period are ignored.
Default: 300 seconds
- Specified by:
getCooldownin interfaceQueueProcessingServiceBaseProps- See Also:
-
getCpuTargetUtilizationPercent
Description copied from interface:QueueProcessingServiceBasePropsThe target CPU utilization percentage for CPU based scaling strategy when enabled.Default: - 50
- Specified by:
getCpuTargetUtilizationPercentin interfaceQueueProcessingServiceBaseProps
-
getDeploymentController
Description copied from interface:QueueProcessingServiceBasePropsSpecifies which deployment controller to use for the service.For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
- Specified by:
getDeploymentControllerin interfaceQueueProcessingServiceBaseProps
-
getDisableCpuBasedScaling
Description copied from interface:QueueProcessingServiceBasePropsFlag to disable CPU based auto scaling strategy on the service.Default: - false
- Specified by:
getDisableCpuBasedScalingin interfaceQueueProcessingServiceBaseProps
-
getEnableECSManagedTags
Description copied from interface:QueueProcessingServiceBasePropsSpecifies 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:
getEnableECSManagedTagsin interfaceQueueProcessingServiceBaseProps
-
getEnableExecuteCommand
Description copied from interface:QueueProcessingServiceBasePropsWhether ECS Exec should be enabled.Default: - false
- Specified by:
getEnableExecuteCommandin interfaceQueueProcessingServiceBaseProps
-
getEnableLogging
Description copied from interface:QueueProcessingServiceBasePropsFlag to indicate whether to enable logging.Default: true
- Specified by:
getEnableLoggingin interfaceQueueProcessingServiceBaseProps
-
getEnvironment
Description copied from interface:QueueProcessingServiceBasePropsThe environment variables to pass to the container.The variable
QUEUE_NAMEwith valuequeue.queueNamewill always be passed.Default: 'QUEUE_NAME: queue.queueName'
- Specified by:
getEnvironmentin interfaceQueueProcessingServiceBaseProps
-
getFamily
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getFamilyin interfaceQueueProcessingServiceBaseProps
-
getImage
Description copied from interface:QueueProcessingServiceBasePropsThe image used to start a container.For
QueueProcessingFargateService, eitherimageortaskDefinitionmust be specified, but not both. ForQueueProcessingEc2Service,imageis required.Default: - the image of the task definition is used for Fargate, required otherwise
- Specified by:
getImagein interfaceQueueProcessingServiceBaseProps
-
getLogDriver
Description copied from interface:QueueProcessingServiceBasePropsThe log driver to use.Default: - AwsLogDriver if enableLogging is true
- Specified by:
getLogDriverin interfaceQueueProcessingServiceBaseProps
-
getMaxHealthyPercent
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getMaxHealthyPercentin interfaceQueueProcessingServiceBaseProps
-
getMaxReceiveCount
Description copied from interface:QueueProcessingServiceBasePropsThe 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.
If the queue construct is specified, maxReceiveCount should be omitted.
Default: 3
- Specified by:
getMaxReceiveCountin interfaceQueueProcessingServiceBaseProps
-
getMaxScalingCapacity
Description copied from interface:QueueProcessingServiceBasePropsMaximum capacity to scale to.Default: 2
- Specified by:
getMaxScalingCapacityin interfaceQueueProcessingServiceBaseProps
-
getMinHealthyPercent
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getMinHealthyPercentin interfaceQueueProcessingServiceBaseProps
-
getMinScalingCapacity
Description copied from interface:QueueProcessingServiceBasePropsMinimum capacity to scale to.Default: 1
- Specified by:
getMinScalingCapacityin interfaceQueueProcessingServiceBaseProps
-
getPropagateTags
Description copied from interface:QueueProcessingServiceBasePropsSpecifies 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:
getPropagateTagsin interfaceQueueProcessingServiceBaseProps
-
getQueue
Description copied from interface:QueueProcessingServiceBasePropsA 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:
getQueuein interfaceQueueProcessingServiceBaseProps
-
getRetentionPeriod
Description copied from interface:QueueProcessingServiceBasePropsThe number of seconds that Dead Letter Queue retains a message.If the queue construct is specified, retentionPeriod should be omitted.
Default: Duration.days(14)
- Specified by:
getRetentionPeriodin interfaceQueueProcessingServiceBaseProps
-
getScalingSteps
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getScalingStepsin interfaceQueueProcessingServiceBaseProps
-
getSecrets
Description copied from interface:QueueProcessingServiceBasePropsThe secret to expose to the container as an environment variable.Default: - No secret environment variables.
- Specified by:
getSecretsin interfaceQueueProcessingServiceBaseProps
-
getServiceName
Description copied from interface:QueueProcessingServiceBasePropsThe name of the service.Default: - CloudFormation-generated name.
- Specified by:
getServiceNamein interfaceQueueProcessingServiceBaseProps
-
getVisibilityTimeout
Description copied from interface:QueueProcessingServiceBasePropsTimeout of processing a single message.After dequeuing, the processor has this much time to handle the message and delete it from the queue before it becomes visible again for dequeueing by another processor. Values must be between 0 and (12 hours).
If the queue construct is specified, visibilityTimeout should be omitted.
Default: Duration.seconds(30)
- Specified by:
getVisibilityTimeoutin interfaceQueueProcessingServiceBaseProps
-
getVpc
Description copied from interface:QueueProcessingServiceBasePropsThe 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:
getVpcin interfaceQueueProcessingServiceBaseProps
-
getCpu
Description copied from interface:FargateServiceBasePropsThe 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:
getCpuin interfaceFargateServiceBaseProps
-
getEphemeralStorageGiB
Description copied from interface:FargateServiceBasePropsThe amount (in GiB) of ephemeral storage to be allocated to the task.The minimum supported value is
21GiB and the maximum supported value is200GiB.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:
getEphemeralStorageGiBin interfaceFargateServiceBaseProps
-
getMemoryLimitMiB
Description copied from interface:FargateServiceBasePropsThe 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:
getMemoryLimitMiBin interfaceFargateServiceBaseProps
-
getPlatformVersion
Description copied from interface:FargateServiceBasePropsThe 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:
getPlatformVersionin interfaceFargateServiceBaseProps
-
getRuntimePlatform
Description copied from interface:FargateServiceBasePropsThe runtime platform of the task definition.Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
- Specified by:
getRuntimePlatformin interfaceFargateServiceBaseProps
-
getTaskDefinition
Description copied from interface:FargateServiceBasePropsThe 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:
getTaskDefinitionin interfaceFargateServiceBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-