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

Interface PutRuleRequest.Builder

    • Method Detail

      • name

        PutRuleRequest.Builder name​(String name)

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

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

      • scheduleExpression

        PutRuleRequest.Builder scheduleExpression​(String scheduleExpression)

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

        Parameters:
        scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        PutRuleRequest.Builder state​(String state)

        Indicates whether the rule is enabled or disabled.

        Parameters:
        state - Indicates whether the rule is enabled or disabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleState, RuleState

      • state

        PutRuleRequest.Builder state​(RuleState state)

        Indicates whether the rule is enabled or disabled.

        Parameters:
        state - Indicates whether the rule is enabled or disabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleState, RuleState

      • description

        PutRuleRequest.Builder description​(String description)

        A description of the rule.

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

      • roleArn

        PutRuleRequest.Builder roleArn​(String roleArn)

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

        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 IAM role associated with the rule.

        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.

      • tags

        PutRuleRequest.Builder tags​(Collection<Tag> tags)

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

        Parameters:
        tags - The list of key-value pairs to associate with the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        PutRuleRequest.Builder tags​(Tag... tags)

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

        Parameters:
        tags - The list of key-value pairs to associate with the rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        PutRuleRequest.Builder tags​(Consumer<Tag.Builder>... tags)

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • eventBusName

        PutRuleRequest.Builder eventBusName​(String eventBusName)

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

        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:
        Returns a reference to this object so that method calls can be chained together.