ScheduledFargateTask.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.ecs.patterns.ScheduledFargateTask.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<ScheduledFargateTask>

Enclosing class:: ScheduledFargateTask

@Stability(value=Stable)
public static final class ScheduledFargateTask.Builder
extends Object
implements software.amazon.jsii.Builder<ScheduledFargateTask>

A fluent builder for ScheduledFargateTask.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScheduledFargateTask`	`build()`
`ScheduledFargateTask.Builder`	`cluster(ICluster cluster)` The name of the cluster that hosts the service.
`ScheduledFargateTask.Builder`	`cpu(Number cpu)` The number of cpu units used by the task.
`static ScheduledFargateTask.Builder`	`create(software.constructs.Construct scope, String id)`
`ScheduledFargateTask.Builder`	`desiredTaskCount(Number desiredTaskCount)` The desired number of instantiations of the task definition to keep running on the service.
`ScheduledFargateTask.Builder`	`enabled(Boolean enabled)` Indicates whether the rule is enabled.
`ScheduledFargateTask.Builder`	`memoryLimitMiB(Number memoryLimitMiB)` The amount (in MiB) of memory used by the task.
`ScheduledFargateTask.Builder`	`platformVersion(FargatePlatformVersion platformVersion)` The platform version on which to run your service.
`ScheduledFargateTask.Builder`	`ruleName(String ruleName)` A name for the rule.
`ScheduledFargateTask.Builder`	`runtimePlatform(RuntimePlatform runtimePlatform)` The runtime platform of the task definition.
`ScheduledFargateTask.Builder`	`schedule(Schedule schedule)` The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
`ScheduledFargateTask.Builder`	`scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions)` The properties to define if using an existing TaskDefinition in this construct.
`ScheduledFargateTask.Builder`	`scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions)` The properties to define if the construct is to create a TaskDefinition.
`ScheduledFargateTask.Builder`	`securityGroups(List<? extends ISecurityGroup> securityGroups)` Existing security groups to use for your service.
`ScheduledFargateTask.Builder`	`subnetSelection(SubnetSelection subnetSelection)` In what subnets to place the task's ENIs.
`ScheduledFargateTask.Builder`	`taskDefinition(FargateTaskDefinition taskDefinition)` The task definition to use for tasks in the service.
`ScheduledFargateTask.Builder`	`vpc(IVpc vpc)` The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static ScheduledFargateTask.Builder create(software.constructs.Construct scope,
                                                                           String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of ScheduledFargateTask.Builder.
  - schedule
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder schedule(Schedule schedule)
```
    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.
    
    Parameters:
    
    schedule - The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. This parameter is required.
    
    Returns:
    
    this
  - cluster
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder cluster(ICluster cluster)
```
    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.
    
    Parameters:
    
    cluster - The name of the cluster that hosts the service. This parameter is required.
    
    Returns:
    
    this
  - desiredTaskCount
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder desiredTaskCount(Number desiredTaskCount)
```
    The desired number of instantiations of the task definition to keep running on the service.
    Default: 1
    
    Parameters:
    
    desiredTaskCount - The desired number of instantiations of the task definition to keep running on the service. This parameter is required.
    
    Returns:
    
    this
  - enabled
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder enabled(Boolean enabled)
```
    Indicates whether the rule is enabled.
    Default: true
    
    Parameters:
    
    enabled - Indicates whether the rule is enabled. This parameter is required.
    
    Returns:
    
    this
  - ruleName
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder ruleName(String ruleName)
```
    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).
    
    Parameters:
    
    ruleName - A name for the rule. This parameter is required.
    
    Returns:
    
    this
  - securityGroups
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
```
    Existing security groups to use for your service.
    Default: - a new security group will be created.
    
    Parameters:
    
    securityGroups - Existing security groups to use for your service. This parameter is required.
    
    Returns:
    
    this
  - subnetSelection
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder subnetSelection(SubnetSelection subnetSelection)
```
    In what subnets to place the task's ENIs.
    (Only applicable in case the TaskDefinition is configured for AwsVpc networking)
    Default: Private subnets
    
    Parameters:
    
    subnetSelection - In what subnets to place the task's ENIs. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder vpc(IVpc vpc)
```
    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.
    
    Parameters:
    
    vpc - The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. This parameter is required.
    
    Returns:
    
    this
  - cpu
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder cpu(Number 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: 256
    
    Parameters:
    
    cpu - The number of cpu units used by the task. This parameter is required.
    
    Returns:
    
    this
  - memoryLimitMiB
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder memoryLimitMiB(Number memoryLimitMiB)
```
    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)
    This default is set in the underlying FargateTaskDefinition construct.
    Default: 512
    
    Parameters:
    
    memoryLimitMiB - The amount (in MiB) of memory used by the task. This parameter is required.
    
    Returns:
    
    this
  - platformVersion
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder platformVersion(FargatePlatformVersion platformVersion)
```
    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
    
    Parameters:
    
    platformVersion - The platform version on which to run your service. This parameter is required.
    
    Returns:
    
    this
  - runtimePlatform
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder runtimePlatform(RuntimePlatform runtimePlatform)
```
    The runtime platform of the task definition.
    Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
    
    Parameters:
    
    runtimePlatform - The runtime platform of the task definition. This parameter is required.
    
    Returns:
    
    this
  - taskDefinition
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder taskDefinition(FargateTaskDefinition taskDefinition)
```
    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
    
    Parameters:
    
    taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. This parameter is required.
    
    Returns:
    
    this
  - scheduledFargateTaskDefinitionOptions
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions)
```
    The properties to define if using an existing TaskDefinition in this construct.
    ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
    Default: none
    
    Parameters:
    
    scheduledFargateTaskDefinitionOptions - The properties to define if using an existing TaskDefinition in this construct. This parameter is required.
    
    Returns:
    
    this
  - scheduledFargateTaskImageOptions
```
@Stability(value=Stable)
public ScheduledFargateTask.Builder scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions)
```
    The properties to define if the construct is to create a TaskDefinition.
    ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
    Default: none
    
    Parameters:
    
    scheduledFargateTaskImageOptions - The properties to define if the construct is to create a TaskDefinition. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public ScheduledFargateTask build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<ScheduledFargateTask>

Class ScheduledFargateTask.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

schedule

cluster

desiredTaskCount

enabled

ruleName

securityGroups

subnetSelection

vpc

cpu

memoryLimitMiB

platformVersion

runtimePlatform

taskDefinition

scheduledFargateTaskDefinitionOptions

scheduledFargateTaskImageOptions

build