software.amazon.awscdk.services.ecs.patterns

Interface ScheduledTaskBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ScheduledEc2TaskProps, ScheduledFargateTaskProps

All Known Implementing Classes:

ScheduledEc2TaskProps.Jsii$Proxy, ScheduledFargateTaskProps.Jsii$Proxy, ScheduledTaskBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.845Z")
 @Stability(value=Stable)
public interface ScheduledTaskBaseProps
extends software.amazon.jsii.JsiiSerializable

The properties for the base ScheduledEc2Task or ScheduledFargateTask task.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationautoscaling.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 Cluster cluster;
 Schedule schedule;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 ScheduledTaskBaseProps scheduledTaskBaseProps = ScheduledTaskBaseProps.builder()
         .schedule(schedule)
         // the properties below are optional
         .cluster(cluster)
         .desiredTaskCount(123)
         .enabled(false)
         .ruleName("ruleName")
         .securityGroups(List.of(securityGroup))
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScheduledTaskBaseProps.Builder A builder for ScheduledTaskBaseProps
static class	ScheduledTaskBaseProps.Jsii$Proxy An implementation for ScheduledTaskBaseProps

Method Summary

Modifier and Type	Method and Description
static ScheduledTaskBaseProps.Builder	builder()
default ICluster	getCluster() The name of the cluster that hosts the service.
default Number	getDesiredTaskCount() The desired number of instantiations of the task definition to keep running on the service.
default Boolean	getEnabled() Indicates whether the rule is enabled.
default String	getRuleName() A name for the rule.
Schedule	getSchedule() The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
default List<ISecurityGroup>	getSecurityGroups() Existing security groups to use for your service.
default SubnetSelection	getSubnetSelection() In what subnets to place the task's ENIs.
default IVpc	getVpc() The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSchedule

@Stability(value=Stable)
 @NotNull
Schedule getSchedule()

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.

getCluster

@Stability(value=Stable)
 @Nullable
default ICluster getCluster()

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.

getDesiredTaskCount

@Stability(value=Stable)
 @Nullable
default Number getDesiredTaskCount()

The desired number of instantiations of the task definition to keep running on the service.

Default: 1

getEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getEnabled()

Indicates whether the rule is enabled.

Default: true

getRuleName

@Stability(value=Stable)
 @Nullable
default String getRuleName()

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).

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

Existing security groups to use for your service.

Default: - a new security group will be created.

getSubnetSelection

@Stability(value=Stable)
 @Nullable
default SubnetSelection getSubnetSelection()

In what subnets to place the task's ENIs.

(Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Default: Private subnets

getVpc

@Stability(value=Stable)
 @Nullable
default IVpc getVpc()

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.

builder

@Stability(value=Stable)
static ScheduledTaskBaseProps.Builder builder()

Returns:

a ScheduledTaskBaseProps.Builder of ScheduledTaskBaseProps