Class CfnRule
A CloudFormation AWS::Events::Rule
.
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class CfnRule : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRule
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule .
A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus .
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule
command. If you omit arguments in PutRule
, the old values for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets .
CloudformationResource: AWS::Events::Rule
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var eventPattern;
var cfnRule = new CfnRule(this, "MyCfnRule", new CfnRuleProps {
Description = "description",
EventBusName = "eventBusName",
EventPattern = eventPattern,
Name = "name",
RoleArn = "roleArn",
ScheduleExpression = "scheduleExpression",
State = "state",
Targets = new [] { new TargetProperty {
Arn = "arn",
Id = "id",
// the properties below are optional
BatchParameters = new BatchParametersProperty {
JobDefinition = "jobDefinition",
JobName = "jobName",
// the properties below are optional
ArrayProperties = new BatchArrayPropertiesProperty {
Size = 123
},
RetryStrategy = new BatchRetryStrategyProperty {
Attempts = 123
}
},
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
EcsParameters = new EcsParametersProperty {
TaskDefinitionArn = "taskDefinitionArn",
// the properties below are optional
CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
EnableEcsManagedTags = false,
EnableExecuteCommand = false,
Group = "group",
LaunchType = "launchType",
NetworkConfiguration = new NetworkConfigurationProperty {
AwsVpcConfiguration = new AwsVpcConfigurationProperty {
Subnets = new [] { "subnets" },
// the properties below are optional
AssignPublicIp = "assignPublicIp",
SecurityGroups = new [] { "securityGroups" }
}
},
PlacementConstraints = new [] { new PlacementConstraintProperty {
Expression = "expression",
Type = "type"
} },
PlacementStrategies = new [] { new PlacementStrategyProperty {
Field = "field",
Type = "type"
} },
PlatformVersion = "platformVersion",
PropagateTags = "propagateTags",
ReferenceId = "referenceId",
TagList = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TaskCount = 123
},
HttpParameters = new HttpParametersProperty {
HeaderParameters = new Dictionary<string, string> {
{ "headerParametersKey", "headerParameters" }
},
PathParameterValues = new [] { "pathParameterValues" },
QueryStringParameters = new Dictionary<string, string> {
{ "queryStringParametersKey", "queryStringParameters" }
}
},
Input = "input",
InputPath = "inputPath",
InputTransformer = new InputTransformerProperty {
InputTemplate = "inputTemplate",
// the properties below are optional
InputPathsMap = new Dictionary<string, string> {
{ "inputPathsMapKey", "inputPathsMap" }
}
},
KinesisParameters = new KinesisParametersProperty {
PartitionKeyPath = "partitionKeyPath"
},
RedshiftDataParameters = new RedshiftDataParametersProperty {
Database = "database",
Sql = "sql",
// the properties below are optional
DbUser = "dbUser",
SecretManagerArn = "secretManagerArn",
StatementName = "statementName",
WithEvent = false
},
RetryPolicy = new RetryPolicyProperty {
MaximumEventAgeInSeconds = 123,
MaximumRetryAttempts = 123
},
RoleArn = "roleArn",
RunCommandParameters = new RunCommandParametersProperty {
RunCommandTargets = new [] { new RunCommandTargetProperty {
Key = "key",
Values = new [] { "values" }
} }
},
SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
Name = "name",
Value = "value"
} }
},
SqsParameters = new SqsParametersProperty {
MessageGroupId = "messageGroupId"
}
} }
});
Synopsis
Constructors
CfnRule(Construct, String, ICfnRuleProps) | Create a new |
CfnRule(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRule(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the rule, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Targets | Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRule(Construct, String, ICfnRuleProps)
Create a new AWS::Events::Rule
.
public CfnRule(Construct scope, string id, ICfnRuleProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRuleProps
- resource properties.
CfnRule(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRule(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRule(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRule(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the rule.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EventBusName
The name or ARN of the event bus associated with the rule.
public virtual string EventBusName { get; set; }
Property Value
System.String
Remarks
If you omit this, the default event bus is used.
EventPattern
The event pattern of the rule.
public virtual object EventPattern { get; set; }
Property Value
System.Object
Remarks
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
Name
The name of the rule.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of the role that is used for target invocation.
public virtual string RoleArn { get; set; }
Property Value
System.String
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.
ScheduleExpression
The scheduling expression.
public virtual string ScheduleExpression { get; set; }
Property Value
System.String
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 virtual string State { get; set; }
Property Value
System.String
Remarks
Targets
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
public virtual object Targets { get; set; }
Property Value
System.Object
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 .
Input
, InputPath
, and InputTransformer
are not available with PutTarget
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 PutTargets
call without a role on the same target (same Id
and Arn
) 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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>