Package com.pulumi.aws.cloudwatch

Class EventRuleArgs.Builder

  • Enclosing class:
    EventRuleArgs
    public static final class EventRuleArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • description

        public EventRuleArgs.Builder description​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> description)
        Parameters:
        description - The description of the rule.
        Returns:
        builder

      • description

        public EventRuleArgs.Builder description​(java.lang.String description)
        Parameters:
        description - The description of the rule.
        Returns:
        builder

      • eventBusName

        public EventRuleArgs.Builder eventBusName​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> eventBusName)
        Parameters:
        eventBusName - The name or ARN of the event bus to associate with this rule. If you omit this, the `default` event bus is used.
        Returns:
        builder

      • eventBusName

        public EventRuleArgs.Builder eventBusName​(java.lang.String eventBusName)
        Parameters:
        eventBusName - The name or ARN of the event bus to associate with this rule. If you omit this, the `default` event bus is used.
        Returns:
        builder

      • eventPattern

        public EventRuleArgs.Builder eventPattern​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> eventPattern)
        Parameters:
        eventPattern - The event pattern described a JSON object. At least one of `scheduleExpression` or `eventPattern` 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.
        Returns:
        builder

      • eventPattern

        public EventRuleArgs.Builder eventPattern​(java.lang.String eventPattern)
        Parameters:
        eventPattern - The event pattern described a JSON object. At least one of `scheduleExpression` or `eventPattern` 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.
        Returns:
        builder

      • forceDestroy

        public EventRuleArgs.Builder forceDestroy​(@Nullable
                                          com.pulumi.core.Output<java.lang.Boolean> forceDestroy)
        Parameters:
        forceDestroy - Used to delete managed rules created by AWS. Defaults to `false`.
        Returns:
        builder

      • forceDestroy

        public EventRuleArgs.Builder forceDestroy​(java.lang.Boolean forceDestroy)
        Parameters:
        forceDestroy - Used to delete managed rules created by AWS. Defaults to `false`.
        Returns:
        builder

      • isEnabled

        @Deprecated
public EventRuleArgs.Builder isEnabled​(@Nullable
                                       com.pulumi.core.Output<java.lang.Boolean> isEnabled)
        Deprecated.
        is_enabled is deprecated. Use state instead.
        Parameters:
        isEnabled - Whether the rule should be enabled. Defaults to `true`. Conflicts with `state`.
        Returns:
        builder

      • isEnabled

        @Deprecated
public EventRuleArgs.Builder isEnabled​(java.lang.Boolean isEnabled)
        Deprecated.
        is_enabled is deprecated. Use state instead.
        Parameters:
        isEnabled - Whether the rule should be enabled. Defaults to `true`. Conflicts with `state`.
        Returns:
        builder

      • name

        public EventRuleArgs.Builder name​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - The name of the rule. If omitted, this provider will assign a random, unique name. Conflicts with `namePrefix`.
        Returns:
        builder

      • name

        public EventRuleArgs.Builder name​(java.lang.String name)
        Parameters:
        name - The name of the rule. If omitted, this provider will assign a random, unique name. Conflicts with `namePrefix`.
        Returns:
        builder

      • namePrefix

        public EventRuleArgs.Builder namePrefix​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> namePrefix)
        Parameters:
        namePrefix - 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.
        Returns:
        builder

      • namePrefix

        public EventRuleArgs.Builder namePrefix​(java.lang.String namePrefix)
        Parameters:
        namePrefix - 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.
        Returns:
        builder

      • region

        public EventRuleArgs.Builder region​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public EventRuleArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • roleArn

        public EventRuleArgs.Builder roleArn​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> roleArn)
        Parameters:
        roleArn - ARN associated with the role that is used for target invocation.
        Returns:
        builder

      • roleArn

        public EventRuleArgs.Builder roleArn​(java.lang.String roleArn)
        Parameters:
        roleArn - ARN associated with the role that is used for target invocation.
        Returns:
        builder

      • scheduleExpression

        public EventRuleArgs.Builder scheduleExpression​(@Nullable
                                                com.pulumi.core.Output<java.lang.String> scheduleExpression)
        Parameters:
        scheduleExpression - The scheduling expression. For example, `cron(0 20 * * ? *)` or `rate(5 minutes)`. At least one of `scheduleExpression` or `eventPattern` 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).
        Returns:
        builder

      • scheduleExpression

        public EventRuleArgs.Builder scheduleExpression​(java.lang.String scheduleExpression)
        Parameters:
        scheduleExpression - The scheduling expression. For example, `cron(0 20 * * ? *)` or `rate(5 minutes)`. At least one of `scheduleExpression` or `eventPattern` 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).
        Returns:
        builder

      • state

        public EventRuleArgs.Builder state​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> state)
        Parameters:
        state - 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 `isEnabled`.
        Returns:
        builder

      • state

        public EventRuleArgs.Builder state​(java.lang.String state)
        Parameters:
        state - 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 `isEnabled`.
        Returns:
        builder

      • tags

        public EventRuleArgs.Builder tags​(@Nullable
                                  com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. **NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `scheduleExpression` argument.
        Returns:
        builder

      • tags

        public EventRuleArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. **NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `scheduleExpression` argument.
        Returns:
        builder