Class CfnRuleProps
Properties for defining a CfnRule.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRuleProps : ICfnRulePropsSyntax (vb)
Public Class CfnRuleProps Implements ICfnRulePropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
ExampleMetadata: infused
Examples
using Amazon.CDK.Mixins.Preview.AWS.S3.Events;
using Amazon.CDK.AWS.Events;
using Amazon.CDK.AWS.Events.Targets;
Function fn;
// Works with L2 constructs
var bucket = new Bucket(scope, "Bucket");
var bucketEvents = BucketEvents.FromBucket(bucket);
new Rule(scope, "Rule", new RuleProps {
EventPattern = bucketEvents.ObjectCreatedPattern(new ObjectCreatedProps {
Object = new ObjectType { Key = Match.Wildcard("uploads/*") }
}),
Targets = new [] { new LambdaFunction(fn) }
});
// Also works with L1 constructs
var cfnBucket = new CfnBucket(scope, "CfnBucket");
var cfnBucketEvents = BucketEvents.FromBucket(cfnBucket);
new CfnRule(scope, "CfnRule", new CfnRuleProps {
State = "ENABLED",
EventPattern = cfnBucketEvents.ObjectCreatedPattern(new ObjectCreatedProps {
Object = new ObjectType { Key = Match.Wildcard("uploads/*") }
}),
Targets = new [] { new TargetProperty { Arn = fn.FunctionArn, Id = "L1" } }
});Synopsis
Constructors
| CfnRuleProps() | Properties for defining a |
Properties
| Description | The description of the rule. |
| EventBusName | The name or ARN of the event bus associated with the rule. |
| EventPattern | The event pattern of the rule. |
| Name | The name of the rule. |
| RoleArn | The Amazon Resource Name (ARN) of the role that is used for target invocation. |
| ScheduleExpression | The scheduling expression. |
| State | The state of the rule. |
| Tags | Any tags assigned to the event rule. |
| Targets | Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. |
Constructors
CfnRuleProps()
Properties for defining a CfnRule.
public CfnRuleProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
ExampleMetadata: infused
Examples
using Amazon.CDK.Mixins.Preview.AWS.S3.Events;
using Amazon.CDK.AWS.Events;
using Amazon.CDK.AWS.Events.Targets;
Function fn;
// Works with L2 constructs
var bucket = new Bucket(scope, "Bucket");
var bucketEvents = BucketEvents.FromBucket(bucket);
new Rule(scope, "Rule", new RuleProps {
EventPattern = bucketEvents.ObjectCreatedPattern(new ObjectCreatedProps {
Object = new ObjectType { Key = Match.Wildcard("uploads/*") }
}),
Targets = new [] { new LambdaFunction(fn) }
});
// Also works with L1 constructs
var cfnBucket = new CfnBucket(scope, "CfnBucket");
var cfnBucketEvents = BucketEvents.FromBucket(cfnBucket);
new CfnRule(scope, "CfnRule", new CfnRuleProps {
State = "ENABLED",
EventPattern = cfnBucketEvents.ObjectCreatedPattern(new ObjectCreatedProps {
Object = new ObjectType { Key = Match.Wildcard("uploads/*") }
}),
Targets = new [] { new TargetProperty { Arn = fn.FunctionArn, Id = "L1" } }
});Properties
Description
The description of the rule.
public string? Description { get; set; }Property Value
Remarks
EventBusName
The name or ARN of the event bus associated with the rule.
public object? EventBusName { get; set; }Property Value
Remarks
If you omit this, the default event bus is used.
Type union: either string or IEventBusRef
EventPattern
The event pattern of the rule.
public object? EventPattern { get; set; }Property Value
Remarks
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
Name
The name of the rule.
public string? Name { get; set; }Property Value
Remarks
RoleArn
The Amazon Resource Name (ARN) of the role that is used for target invocation.
public object? RoleArn { get; set; }Property Value
Remarks
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
Type union: either string or IRoleRef
ScheduleExpression
The scheduling expression.
public string? ScheduleExpression { get; set; }Property Value
Remarks
For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .
State
The state of the rule.
public string? State { get; set; }Property Value
Remarks
Valid values include:
Management events provide visibility into management operations that are performed on resources in your AWS account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide , and Filtering management events from AWS services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses . It does not apply to partner event buses .
Tags
Any tags assigned to the event rule.
public ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
Targets
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
public object? Targets { get; set; }Property Value
Remarks
Targets are the resources that are invoked when a rule is triggered.
The maximum number of entries per request is 10.
Each rule can have up to five (5) targets associated with it at one time.
For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide .
Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .
If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing .
<code>Input</code> , <code>InputPath</code> , and <code>InputTransformer</code> are not available with <code>PutTarget</code> if the target is an event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide .
If you have an IAM role on a cross-account event bus target, a <code>PutTargets</code> call without a role on the same target (same <code>Id</code> and <code>Arn</code> ) will not remove the role.
For more information about enabling cross-account events, see PutPermission .
Input , InputPath , and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Type union: either IResolvable or (either IResolvable or CfnRule.ITargetProperty)[]