ScheduledFargateTaskImageOptions¶

class aws_cdk.aws_ecs_patterns.ScheduledFargateTaskImageOptions(*, image, command=None, environment=None, log_driver=None, secrets=None, cpu=None, memory_limit_mib=None)¶

Bases: aws_cdk.aws_ecs_patterns.ScheduledTaskImageProps

__init__(*, image, command=None, environment=None, log_driver=None, secrets=None, cpu=None, memory_limit_mib=None)¶

The properties for the ScheduledFargateTask using an image.

Parameters

image (ContainerImage) – The image used to start a container. Image or taskDefinition must be specified, but not both. Default: - none
command (Optional[List[str]]) – 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.
environment (Optional[Mapping[str, str]]) – The environment variables to pass to the container. Default: none
log_driver (Optional[LogDriver]) – The log driver to use. Default: - AwsLogDriver if enableLogging is true
secrets (Optional[Mapping[str, Secret]]) – The secret to expose to the container as an environment variable. Default: - No secret environment variables.
cpu (Union[int, float, None]) – 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
memory_limit_mib (Union[int, float, None]) – The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated. Default: 512

Return type

None

Attributes

command¶

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 :default: - CMD value built into container image.

Return type: Optional[List[str]]

cpu¶

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 :default: 256

Return type: Union[int, float, None]

environment¶

The environment variables to pass to the container.

default :default: none

Return type: Optional[Mapping[str, str]]

image¶

The image used to start a container.

Image or taskDefinition must be specified, but not both.

default :default: - none

Return type: ContainerImage

log_driver¶

The log driver to use.

default :default: - AwsLogDriver if enableLogging is true

Return type: Optional[LogDriver]

memory_limit_mib¶

The hard limit (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

default :default: 512

Return type: Union[int, float, None]

secrets¶

The secret to expose to the container as an environment variable.

default :default: - No secret environment variables.

Return type: Optional[Mapping[str, Secret]]