Class ScheduledFargateTaskProps.Jsii$Proxy
- All Implemented Interfaces:
FargateServiceBaseProps
,ScheduledFargateTaskProps
,ScheduledTaskBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
ScheduledFargateTaskProps
ScheduledFargateTaskProps
-
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.ScheduledFargateTaskProps
ScheduledFargateTaskProps.Builder, ScheduledFargateTaskProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theScheduledFargateTaskProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final ICluster
The name of the cluster that hosts the service.final Number
getCpu()
The number of cpu units used by the task.final Number
The desired number of instantiations of the task definition to keep running on the service.final Boolean
Indicates whether the rule is enabled.final Number
The amount (in GiB) of ephemeral storage to be allocated to the task.final Number
The amount (in MiB) of memory used by the task.final FargatePlatformVersion
The platform version on which to run your service.final PropagatedTagSource
Specifies whether to propagate the tags from the task definition to the task.final String
A name for the rule.final RuntimePlatform
The runtime platform of the task definition.final Schedule
The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.The properties to define if using an existing TaskDefinition in this construct.The properties to define if the construct is to create a TaskDefinition.final List<ISecurityGroup>
Existing security groups to use for your service.final SubnetSelection
In what subnets to place the task's ENIs.getTags()
The metadata that you apply to the task to help you categorize and organize them.final FargateTaskDefinition
The task definition to use for tasks in the service.final IVpc
getVpc()
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.final int
hashCode()
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 theScheduledFargateTaskProps.Builder
.
-
-
Method Details
-
getScheduledFargateTaskDefinitionOptions
Description copied from interface:ScheduledFargateTaskProps
The properties to define if using an existing TaskDefinition in this construct.ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
Default: none
- Specified by:
getScheduledFargateTaskDefinitionOptions
in interfaceScheduledFargateTaskProps
-
getScheduledFargateTaskImageOptions
Description copied from interface:ScheduledFargateTaskProps
The properties to define if the construct is to create a TaskDefinition.ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
Default: none
- Specified by:
getScheduledFargateTaskImageOptions
in interfaceScheduledFargateTaskProps
-
getSchedule
Description copied from interface:ScheduledTaskBaseProps
The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.
- Specified by:
getSchedule
in interfaceScheduledTaskBaseProps
-
getCluster
Description copied from interface:ScheduledTaskBaseProps
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 interfaceScheduledTaskBaseProps
-
getDesiredTaskCount
Description copied from interface:ScheduledTaskBaseProps
The desired number of instantiations of the task definition to keep running on the service.Default: 1
- Specified by:
getDesiredTaskCount
in interfaceScheduledTaskBaseProps
-
getEnabled
Description copied from interface:ScheduledTaskBaseProps
Indicates whether the rule is enabled.Default: true
- Specified by:
getEnabled
in interfaceScheduledTaskBaseProps
-
getPropagateTags
Description copied from interface:ScheduledTaskBaseProps
Specifies whether to propagate the tags from the task definition to the task.If no value is specified, the tags are not propagated.
Default: - Tags will not be propagated
- Specified by:
getPropagateTags
in interfaceScheduledTaskBaseProps
-
getRuleName
Description copied from interface:ScheduledTaskBaseProps
A name for the rule.Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
- Specified by:
getRuleName
in interfaceScheduledTaskBaseProps
-
getSecurityGroups
Description copied from interface:ScheduledTaskBaseProps
Existing security groups to use for your service.Default: - a new security group will be created.
- Specified by:
getSecurityGroups
in interfaceScheduledTaskBaseProps
-
getSubnetSelection
Description copied from interface:ScheduledTaskBaseProps
In what subnets to place the task's ENIs.(Only applicable in case the TaskDefinition is configured for AwsVpc networking)
Default: Private subnets
- Specified by:
getSubnetSelection
in interfaceScheduledTaskBaseProps
-
getTags
Description copied from interface:ScheduledTaskBaseProps
The metadata that you apply to the task to help you categorize and organize them.Each tag consists of a key and an optional value, both of which you define.
Default: - No tags are applied to the task
- Specified by:
getTags
in interfaceScheduledTaskBaseProps
-
getVpc
Description copied from interface:ScheduledTaskBaseProps
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 interfaceScheduledTaskBaseProps
-
getCpu
Description copied from interface:FargateServiceBaseProps
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
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:
getCpu
in interfaceFargateServiceBaseProps
-
getEphemeralStorageGiB
Description copied from interface:FargateServiceBaseProps
The amount (in GiB) of ephemeral storage to be allocated to the task.The minimum supported value is
21
GiB and the maximum supported value is200
GiB.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:
getEphemeralStorageGiB
in interfaceFargateServiceBaseProps
-
getMemoryLimitMiB
Description copied from interface:FargateServiceBaseProps
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:
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:
getMemoryLimitMiB
in interfaceFargateServiceBaseProps
-
getPlatformVersion
Description copied from interface:FargateServiceBaseProps
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 interfaceFargateServiceBaseProps
-
getRuntimePlatform
Description copied from interface:FargateServiceBaseProps
The runtime platform of the task definition.Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
- Specified by:
getRuntimePlatform
in interfaceFargateServiceBaseProps
-
getTaskDefinition
Description copied from interface:FargateServiceBaseProps
The 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:
getTaskDefinition
in interfaceFargateServiceBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-