putRule method

Future<PutRuleResponse> putRule({ required String name, String? description, String? eventBusName, String? eventPattern, String? roleArn, String? scheduleExpression, RuleState? state, List<Tag>? tags, })

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.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

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.

May throw InvalidEventPatternException. May throw LimitExceededException. May throw ConcurrentModificationException. May throw ManagedRuleException. May throw InternalException. May throw ResourceNotFoundException.

Parameter name : The name of the rule that you are creating or updating.

Parameter description : A description of the rule.

Parameter eventBusName : The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Parameter eventPattern : The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Parameter roleArn : The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Parameter scheduleExpression : The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Parameter state : Indicates whether the rule is enabled or disabled.

Parameter tags : The list of key-value pairs to associate with the rule.

Implementation

Future<PutRuleResponse> putRule({
  required String name,
  String? description,
  String? eventBusName,
  String? eventPattern,
  String? roleArn,
  String? scheduleExpression,
  RuleState? state,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    64,
    isRequired: true,
  );
  _s.validateStringLength(
    'description',
    description,
    0,
    512,
  );
  _s.validateStringLength(
    'eventBusName',
    eventBusName,
    1,
    1600,
  );
  _s.validateStringLength(
    'roleArn',
    roleArn,
    1,
    1600,
  );
  _s.validateStringLength(
    'scheduleExpression',
    scheduleExpression,
    0,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSEvents.PutRule'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Name': name,
      if (description != null) 'Description': description,
      if (eventBusName != null) 'EventBusName': eventBusName,
      if (eventPattern != null) 'EventPattern': eventPattern,
      if (roleArn != null) 'RoleArn': roleArn,
      if (scheduleExpression != null)
        'ScheduleExpression': scheduleExpression,
      if (state != null) 'State': state.toValue(),
      if (tags != null) 'Tags': tags,
    },
  );

  return PutRuleResponse.fromJson(jsonResponse.body);
}