@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:43.436Z") public class Activity extends Resource implements IActivity
Example:
Activity activity = new Activity(this, "Activity"); // Read this CloudFormation Output from your application and use it to poll for work on // the activity. // Read this CloudFormation Output from your application and use it to poll for work on // the activity. CfnOutput.Builder.create(this, "ActivityArn").value(activity.getActivityArn()).build();
Modifier and Type | Class and Description |
---|---|
static class |
Activity.Builder
A fluent builder for
Activity . |
IActivity.Jsii$Default, IActivity.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Activity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Activity(software.amazon.jsii.JsiiObjectRef objRef) |
|
Activity(software.constructs.Construct scope,
java.lang.String id) |
|
Activity(software.constructs.Construct scope,
java.lang.String id,
ActivityProps props) |
Modifier and Type | Method and Description |
---|---|
static IActivity |
fromActivityArn(software.constructs.Construct scope,
java.lang.String id,
java.lang.String activityArn)
Construct an Activity from an existing Activity ARN.
|
static IActivity |
fromActivityName(software.constructs.Construct scope,
java.lang.String id,
java.lang.String activityName)
Construct an Activity from an existing Activity Name.
|
java.lang.String |
getActivityArn()
The ARN of the activity.
|
java.lang.String |
getActivityName()
The name of the activity.
|
Grant |
grant(IGrantable identity,
java.lang.String... actions)
Grant the given identity permissions on this Activity.
|
Metric |
metric(java.lang.String metricName)
Return the given named metric for this Activity.
|
Metric |
metric(java.lang.String metricName,
MetricOptions props)
Return the given named metric for this Activity.
|
Metric |
metricFailed()
Metric for the number of times this activity fails.
|
Metric |
metricFailed(MetricOptions props)
Metric for the number of times this activity fails.
|
Metric |
metricHeartbeatTimedOut()
Metric for the number of times the heartbeat times out for this activity.
|
Metric |
metricHeartbeatTimedOut(MetricOptions props)
Metric for the number of times the heartbeat times out for this activity.
|
Metric |
metricRunTime()
The interval, in milliseconds, between the time the activity starts and the time it closes.
|
Metric |
metricRunTime(MetricOptions props)
The interval, in milliseconds, between the time the activity starts and the time it closes.
|
Metric |
metricScheduled()
Metric for the number of times this activity is scheduled.
|
Metric |
metricScheduled(MetricOptions props)
Metric for the number of times this activity is scheduled.
|
Metric |
metricScheduleTime()
The interval, in milliseconds, for which the activity stays in the schedule state.
|
Metric |
metricScheduleTime(MetricOptions props)
The interval, in milliseconds, for which the activity stays in the schedule state.
|
Metric |
metricStarted()
Metric for the number of times this activity is started.
|
Metric |
metricStarted(MetricOptions props)
Metric for the number of times this activity is started.
|
Metric |
metricSucceeded()
Metric for the number of times this activity succeeds.
|
Metric |
metricSucceeded(MetricOptions props)
Metric for the number of times this activity succeeds.
|
Metric |
metricTime()
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
|
Metric |
metricTime(MetricOptions props)
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
|
Metric |
metricTimedOut()
Metric for the number of times this activity times out.
|
Metric |
metricTimedOut(MetricOptions props)
Metric for the number of times this activity times out.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected Activity(software.amazon.jsii.JsiiObjectRef objRef)
protected Activity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public Activity(software.constructs.Construct scope, java.lang.String id, ActivityProps props)
scope
- This parameter is required.id
- This parameter is required.props
- public Activity(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static IActivity fromActivityArn(software.constructs.Construct scope, java.lang.String id, java.lang.String activityArn)
scope
- This parameter is required.id
- This parameter is required.activityArn
- This parameter is required.public static IActivity fromActivityName(software.constructs.Construct scope, java.lang.String id, java.lang.String activityName)
scope
- This parameter is required.id
- This parameter is required.activityName
- This parameter is required.public Grant grant(IGrantable identity, java.lang.String... actions)
identity
- The principal. This parameter is required.actions
- The list of desired actions. This parameter is required.public Metric metric(java.lang.String metricName, MetricOptions props)
Default: sum over 5 minutes
metricName
- This parameter is required.props
- public Metric metric(java.lang.String metricName)
Default: sum over 5 minutes
metricName
- This parameter is required.public Metric metricFailed(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricFailed()
Default: sum over 5 minutes
public Metric metricHeartbeatTimedOut(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricHeartbeatTimedOut()
Default: sum over 5 minutes
public Metric metricRunTime(MetricOptions props)
Default: average over 5 minutes
props
- public Metric metricRunTime()
Default: average over 5 minutes
public Metric metricScheduled(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricScheduled()
Default: sum over 5 minutes
public Metric metricScheduleTime(MetricOptions props)
Default: average over 5 minutes
props
- public Metric metricScheduleTime()
Default: average over 5 minutes
public Metric metricStarted(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricStarted()
Default: sum over 5 minutes
public Metric metricSucceeded(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricSucceeded()
Default: sum over 5 minutes
public Metric metricTime(MetricOptions props)
Default: average over 5 minutes
props
- public Metric metricTime()
Default: average over 5 minutes
public Metric metricTimedOut(MetricOptions props)
Default: sum over 5 minutes
props
- public Metric metricTimedOut()
Default: sum over 5 minutes
public java.lang.String getActivityArn()
getActivityArn
in interface IActivity
public java.lang.String getActivityName()
getActivityName
in interface IActivity