Interface PutInsightRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchRequest.Builder, CopyableBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>, SdkBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutInsightRuleRequest
@Mutable @NotThreadSafe public static interface PutInsightRuleRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>

  • Method Details

    • ruleName

      PutInsightRuleRequest.Builder ruleName(String ruleName)

      A unique name for the rule.

      Parameters:
      ruleName - A unique name for the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleState

      PutInsightRuleRequest.Builder ruleState(String ruleState)

      The state of the rule. Valid values are ENABLED and DISABLED.

      Parameters:
      ruleState - The state of the rule. Valid values are ENABLED and DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleDefinition

      PutInsightRuleRequest.Builder ruleDefinition(String ruleDefinition)

      The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

      Parameters:
      ruleDefinition - The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutInsightRuleRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

      To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

      If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

      To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

      If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

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

    • tags

      PutInsightRuleRequest.Builder tags(Tag... tags)

      A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

      To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

      If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

      To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

      If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

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

    • tags

      PutInsightRuleRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a 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 the resources that have certain tag values.

      To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

      If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

      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<Tag>).

      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:

    • applyOnTransformedLogs

      PutInsightRuleRequest.Builder applyOnTransformedLogs(Boolean applyOnTransformedLogs)

      Specify true to have this rule evaluate log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.

      The default is false

      If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.

      Parameters:
      applyOnTransformedLogs - Specify true to have this rule evaluate log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.

      The default is false

      If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.

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

    • overrideConfiguration

      PutInsightRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutInsightRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.