Class Group

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Scheduler.Alpha

Assembly: Amazon.CDK.AWS.Scheduler.Alpha.dll

Syntax (csharp)

public class Group : Resource, IGroup, IResource

Syntax (vb)

Public Class Group
    Inherits Resource
    Implements IGroup, IResource

Remarks

Stability: Experimental

Resource: AWS::Scheduler::ScheduleGroup

ExampleMetadata: infused

Examples

LambdaInvoke target;


var group = new Group(this, "Group", new GroupProps {
    GroupName = "MyGroup"
});

new Schedule(this, "Schedule", new ScheduleProps {
    Schedule = ScheduleExpression.Rate(Duration.Minutes(10)),
    Target = target,
    Group = group
});

Synopsis

Constructors

Group(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Group(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Group(Construct, String, IGroupProps)

Properties

GroupArn	(experimental) The arn of the schedule group.
GroupName	(experimental) The name of the schedule group.

Methods

FromDefaultGroup(Construct, String)	(experimental) Import a default schedule group.
FromGroupArn(Construct, String, String)	(experimental) Import an external group by ARN.
FromGroupName(Construct, String, String)	(experimental) Import an existing group with a given name.
Grant(IGrantable, String[])	(experimental) Grant the indicated permissions on this group to the given principal.
GrantDeleteSchedules(IGrantable)	(experimental) Grant delete schedule permission for schedules in this group to the given principal.
GrantReadSchedules(IGrantable)	(experimental) Grant list and get schedule permissions for schedules in this group to the given principal.
GrantWriteSchedules(IGrantable)	(experimental) Grant create and update schedule permissions for schedules in this group to the given principal.
Metric(String, IMetricOptions)	(experimental) Return the given named metric for this group schedules.
MetricAttempts(IMetricOptions)	(experimental) Metric for all invocation attempts.
MetricDropped(IMetricOptions)	(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
MetricFailedToBeSentToDLQ(String, IMetricOptions)	(experimental) Metric for failed invocations that also failed to deliver to DLQ.
MetricSentToDLQ(IMetricOptions)	(experimental) Metric for invocations delivered to the DLQ.
MetricSentToDLQTruncated(IMetricOptions)	(experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
MetricTargetErrors(IMetricOptions)	(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
MetricTargetThrottled(IMetricOptions)	(experimental) Metric for invocation failures due to API throttling by the target.
MetricThrottled(IMetricOptions)	(experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.

Constructors

Group(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Group(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

Group(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Group(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Group(Construct, String, IGroupProps)

public Group(Construct scope, string id, IGroupProps props)

Parameters

scope Constructs.Construct
id System.String
props IGroupProps

Remarks

Stability: Experimental

Properties

GroupArn

(experimental) The arn of the schedule group.

public virtual string GroupArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

GroupName

(experimental) The name of the schedule group.

public virtual string GroupName { get; }

Property Value

System.String

Remarks

Stability: Experimental

Methods

FromDefaultGroup(Construct, String)

(experimental) Import a default schedule group.

public static IGroup FromDefaultGroup(Construct scope, string id)

Parameters

scope Constructs.Construct: construct scope.
id System.String: construct id.

Returns

Remarks

Stability: Experimental

FromGroupArn(Construct, String, String)

(experimental) Import an external group by ARN.

public static IGroup FromGroupArn(Construct scope, string id, string groupArn)

Parameters

scope Constructs.Construct: construct scope.
id System.String: construct id.
groupArn System.String: the ARN of the group to import (e.g. arn:aws:scheduler:region:account-id:schedule-group/group-name).

Returns

Remarks

Stability: Experimental

FromGroupName(Construct, String, String)

(experimental) Import an existing group with a given name.

public static IGroup FromGroupName(Construct scope, string id, string groupName)

Parameters

scope Constructs.Construct: construct scope.
id System.String: construct id.
groupName System.String: the name of the existing group to import.

Returns

Remarks

Stability: Experimental

Grant(IGrantable, String[])

(experimental) Grant the indicated permissions on this group to the given principal.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable
actions System.String[]

Returns

Remarks

Stability: Experimental

GrantDeleteSchedules(IGrantable)

(experimental) Grant delete schedule permission for schedules in this group to the given principal.

public virtual Grant GrantDeleteSchedules(IGrantable identity)

Parameters

identity IGrantable

Returns

Remarks

Stability: Experimental

GrantReadSchedules(IGrantable)

(experimental) Grant list and get schedule permissions for schedules in this group to the given principal.

public virtual Grant GrantReadSchedules(IGrantable identity)

Parameters

identity IGrantable

Returns

Remarks

Stability: Experimental

GrantWriteSchedules(IGrantable)

(experimental) Grant create and update schedule permissions for schedules in this group to the given principal.

public virtual Grant GrantWriteSchedules(IGrantable identity)

Parameters

identity IGrantable

Returns

Remarks

Stability: Experimental

Metric(String, IMetricOptions)

(experimental) Return the given named metric for this group schedules.

public virtual Metric Metric(string metricName, IMetricOptions props = null)

Parameters

metricName System.String
props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricAttempts(IMetricOptions)

(experimental) Metric for all invocation attempts.

public virtual Metric MetricAttempts(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricDropped(IMetricOptions)

(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.

public virtual Metric MetricDropped(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricFailedToBeSentToDLQ(String, IMetricOptions)

(experimental) Metric for failed invocations that also failed to deliver to DLQ.

public virtual Metric MetricFailedToBeSentToDLQ(string errorCode = null, IMetricOptions props = null)

Parameters

errorCode System.String
props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricSentToDLQ(IMetricOptions)

(experimental) Metric for invocations delivered to the DLQ.

public virtual Metric MetricSentToDLQ(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricSentToDLQTruncated(IMetricOptions)

(experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.

public virtual Metric MetricSentToDLQTruncated(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricTargetErrors(IMetricOptions)

(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.

public virtual Metric MetricTargetErrors(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricTargetThrottled(IMetricOptions)

(experimental) Metric for invocation failures due to API throttling by the target.

public virtual Metric MetricTargetThrottled(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Remarks

Default: - sum over 5 minutes

Stability: Experimental

MetricThrottled(IMetricOptions)

(experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.

public virtual Metric MetricThrottled(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns