Package software.amazon.awssdk.services.eventbridge.model

Interface Rule.Builder

    • Method Detail

      • name

        Rule.Builder name​(String name)

        The name of the rule.

        Parameters:
        name - The name of the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        Rule.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the rule.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventPattern

        Rule.Builder eventPattern​(String eventPattern)

        The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

        Parameters:
        eventPattern - The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        Rule.Builder state​(String state)

        The state of the rule.

        Valid values include:

        • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

        • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

        • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

          Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

          This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

        Parameters:
        state - The state of the rule.

        Valid values include:

        • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

        • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

        • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

          Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

          This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleState, RuleState

      • state

        Rule.Builder state​(RuleState state)

        The state of the rule.

        Valid values include:

        • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

        • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

        • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

          Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

          This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

        Parameters:
        state - The state of the rule.

        Valid values include:

        • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

        • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

        • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

          Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide.

          This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleState, RuleState

      • description

        Rule.Builder description​(String description)

        The description of the rule.

        Parameters:
        description - The description of the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        Rule.Builder roleArn​(String roleArn)

        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.

        Parameters:
        roleArn - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managedBy

        Rule.Builder managedBy​(String managedBy)

        If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

        Parameters:
        managedBy - If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventBusName

        Rule.Builder eventBusName​(String eventBusName)

        The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

        Parameters:
        eventBusName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.