Package software.amazon.awscdk.services.events

Class CfnRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.events.CfnRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.990Z") @Stability(Stable) public class CfnRule extends CfnResource implements IInspectable
A CloudFormation AWS::Events::Rule.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 Object eventPattern;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .description("description")
         .eventBusName("eventBusName")
         .eventPattern(eventPattern)
         .name("name")
         .roleArn("roleArn")
         .scheduleExpression("scheduleExpression")
         .state("state")
         .targets(List.of(TargetProperty.builder()
                 .arn("arn")
                 .id("id")
                 // the properties below are optional
                 .batchParameters(BatchParametersProperty.builder()
                         .jobDefinition("jobDefinition")
                         .jobName("jobName")
                         // the properties below are optional
                         .arrayProperties(BatchArrayPropertiesProperty.builder()
                                 .size(123)
                                 .build())
                         .retryStrategy(BatchRetryStrategyProperty.builder()
                                 .attempts(123)
                                 .build())
                         .build())
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .ecsParameters(EcsParametersProperty.builder()
                         .taskDefinitionArn("taskDefinitionArn")
                         // the properties below are optional
                         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                                 .capacityProvider("capacityProvider")
                                 // the properties below are optional
                                 .base(123)
                                 .weight(123)
                                 .build()))
                         .enableEcsManagedTags(false)
                         .enableExecuteCommand(false)
                         .group("group")
                         .launchType("launchType")
                         .networkConfiguration(NetworkConfigurationProperty.builder()
                                 .awsVpcConfiguration(AwsVpcConfigurationProperty.builder()
                                         .subnets(List.of("subnets"))
                                         // the properties below are optional
                                         .assignPublicIp("assignPublicIp")
                                         .securityGroups(List.of("securityGroups"))
                                         .build())
                                 .build())
                         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                                 .expression("expression")
                                 .type("type")
                                 .build()))
                         .placementStrategies(List.of(PlacementStrategyProperty.builder()
                                 .field("field")
                                 .type("type")
                                 .build()))
                         .platformVersion("platformVersion")
                         .propagateTags("propagateTags")
                         .referenceId("referenceId")
                         .tagList(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .taskCount(123)
                         .build())
                 .httpParameters(HttpParametersProperty.builder()
                         .headerParameters(Map.of(
                                 "headerParametersKey", "headerParameters"))
                         .pathParameterValues(List.of("pathParameterValues"))
                         .queryStringParameters(Map.of(
                                 "queryStringParametersKey", "queryStringParameters"))
                         .build())
                 .input("input")
                 .inputPath("inputPath")
                 .inputTransformer(InputTransformerProperty.builder()
                         .inputTemplate("inputTemplate")
                         // the properties below are optional
                         .inputPathsMap(Map.of(
                                 "inputPathsMapKey", "inputPathsMap"))
                         .build())
                 .kinesisParameters(KinesisParametersProperty.builder()
                         .partitionKeyPath("partitionKeyPath")
                         .build())
                 .redshiftDataParameters(RedshiftDataParametersProperty.builder()
                         .database("database")
                         .sql("sql")
                         // the properties below are optional
                         .dbUser("dbUser")
                         .secretManagerArn("secretManagerArn")
                         .statementName("statementName")
                         .withEvent(false)
                         .build())
                 .retryPolicy(RetryPolicyProperty.builder()
                         .maximumEventAgeInSeconds(123)
                         .maximumRetryAttempts(123)
                         .build())
                 .roleArn("roleArn")
                 .runCommandParameters(RunCommandParametersProperty.builder()
                         .runCommandTargets(List.of(RunCommandTargetProperty.builder()
                                 .key("key")
                                 .values(List.of("values"))
                                 .build()))
                         .build())
                 .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                         .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .build())
                 .sqsParameters(SqsParametersProperty.builder()
                         .messageGroupId("messageGroupId")
                         .build())
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRule

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

    • CfnRule

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

    • CfnRule

      @Stability(Stable) public CfnRule(@NotNull Construct scope, @NotNull String id, @Nullable CfnRuleProps props)
      Create a new AWS::Events::Rule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnRule

      @Stability(Stable) public CfnRule(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Events::Rule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEventPattern

      @Stability(Stable) @NotNull public Object getEventPattern()
      The event pattern of the rule.

      For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

    • setEventPattern

      @Stability(Stable) public void setEventPattern(@NotNull Object value)
      The event pattern of the rule.

      For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the rule.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the rule.

    • getEventBusName

      @Stability(Stable) @Nullable public String getEventBusName()
      The name or ARN of the event bus associated with the rule.

      If you omit this, the default event bus is used.

    • setEventBusName

      @Stability(Stable) public void setEventBusName(@Nullable String value)
      The name or ARN of the event bus associated with the rule.

      If you omit this, the default event bus is used.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the rule.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the rule.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) of the role that is used for target invocation.

      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.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the role that is used for target invocation.

      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.

    • getScheduleExpression

      @Stability(Stable) @Nullable public String getScheduleExpression()
      The scheduling expression.

      For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .

    • setScheduleExpression

      @Stability(Stable) public void setScheduleExpression(@Nullable String value)
      The scheduling expression.

      For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule .

    • getState

      @Stability(Stable) @Nullable public String getState()
      The state of the rule.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The state of the rule.

    • getTargets

      @Stability(Stable) @Nullable public Object getTargets()
      Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

      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:

      • Amazon EBS CreateSnapshot API call
      • Amazon EC2 RebootInstances API call
      • Amazon EC2 StopInstances API call
      • Amazon EC2 TerminateInstances API call

      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 AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
      • For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

      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:

      • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
      • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
      • If InputPath is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
      • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

      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.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable IResolvable value)
      Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

      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:

      • Amazon EBS CreateSnapshot API call
      • Amazon EC2 RebootInstances API call
      • Amazon EC2 StopInstances API call
      • Amazon EC2 TerminateInstances API call

      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 AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
      • For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

      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:

      • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
      • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
      • If InputPath is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
      • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

      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.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable List<Object> value)
      Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

      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:

      • Amazon EBS CreateSnapshot API call
      • Amazon EC2 RebootInstances API call
      • Amazon EC2 StopInstances API call
      • Amazon EC2 TerminateInstances API call

      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 AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
      • For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets .

      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:

      • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
      • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
      • If InputPath is specified in the form of JSONPath (for example, $.detail ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
      • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

      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.