software.amazon.awscdk.services.events.targets

Class EcsTask

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.EcsTask

All Implemented Interfaces:

IRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.324Z")
 @Stability(value=Stable)
public class EcsTask
extends software.amazon.jsii.JsiiObject
implements IRuleTarget

Start a task on an ECS cluster.

Example:

 import software.amazon.awscdk.services.events.Rule;
 import software.amazon.awscdk.services.events.Schedule;
 import software.amazon.awscdk.services.events.targets.EcsTask;
 import software.amazon.awscdk.services.ecs.Cluster;
 import software.amazon.awscdk.services.ecs.TaskDefinition;
 import software.amazon.awscdk.services.iam.Role;
 Cluster cluster;
 TaskDefinition taskDefinition;
 Role role;
 EcsTask ecsTaskTarget = EcsTask.Builder.create().cluster(cluster).taskDefinition(taskDefinition).role(role).build();
 Rule.Builder.create(this, "ScheduleRule")
         .schedule(Schedule.cron(CronOptions.builder().minute("0").hour("4").build()))
         .targets(List.of(ecsTaskTarget))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EcsTask.Builder A fluent builder for EcsTask.

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.events.IRuleTarget

IRuleTarget.Jsii$Default, IRuleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	EcsTask(EcsTaskProps props)
protected	EcsTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EcsTask(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig	bind(IRule _rule) Allows using tasks as target of EventBridge events.
RuleTargetConfig	bind(IRule _rule, String _id) Allows using tasks as target of EventBridge events.
List<ISecurityGroup>	getSecurityGroups() The security groups associated with the task.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

EcsTask

protected EcsTask(software.amazon.jsii.JsiiObjectRef objRef)

EcsTask

protected EcsTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EcsTask

@Stability(value=Stable)
public EcsTask(@NotNull
                                        EcsTaskProps props)

Parameters:

props - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule,
                                                                @Nullable
                                                                String _id)

Allows using tasks as target of EventBridge events.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

_id -

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule)

Allows using tasks as target of EventBridge events.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

getSecurityGroups

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

The security groups associated with the task.

Only applicable with awsvpc network mode.

Default: - A new security group is created.