Package com.pulumi.aws.cloudwatch

Class EventRuleArgs

  • public final class EventRuleArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  EventRuleArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static EventRuleArgs.Builder builder()  
      static EventRuleArgs.Builder builder​(EventRuleArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> eventBusName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> eventPattern()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()
      Deprecated.
      Use "state" instead
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> scheduleExpression()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> state()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        The description of the rule.

      • eventBusName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> eventBusName()
        Returns:
        The name or ARN of the event bus to associate with this rule. If you omit this, the `default` event bus is used.

      • eventPattern

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> eventPattern()
        Returns:
        The event pattern described a JSON object. At least one of `schedule_expression` or `event_pattern` is required. See full documentation of [Events and Event Patterns in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) for details. **Note**: The event pattern size is 2048 by default but it is adjustable up to 4096 characters by submitting a service quota increase request. See [Amazon EventBridge quotas](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-quota.html) for details.

      • forceDestroy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()
        Returns:
        Used to delete managed rules created by AWS. Defaults to `false`.

      • isEnabled

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> isEnabled()
        Deprecated.
        Use "state" instead
        Returns:
        Whether the rule should be enabled. Defaults to `true`. Conflicts with `state`.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The name of the rule. If omitted, this provider will assign a random, unique name. Conflicts with `name_prefix`.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`. **Note**: Due to the length of the generated suffix, must be 38 characters or less.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()
        Returns:
        The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

      • scheduleExpression

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> scheduleExpression()
        Returns:
        The scheduling expression. For example, `cron(0 20 * * ? *)` or `rate(5 minutes)`. At least one of `schedule_expression` or `event_pattern` is required. Can only be used on the default event bus. For more information, refer to the AWS documentation [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html).

      • state

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> state()
        Returns:
        State of the rule. Valid values are `DISABLED`, `ENABLED`, and `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. When state is `ENABLED`, the rule is enabled for all events except those delivered by CloudTrail. To also enable the rule for events delivered by CloudTrail, set `state` to `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. Defaults to `ENABLED`. Conflicts with `is_enabled`. **NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `schedule_expression` argument.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.