Package software.amazon.awssdk.services.cloudwatch.model

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 Summary

Modifier and Type	Method	Description
PutInsightRuleRequest.Builder	applyOnTransformedLogs(Boolean applyOnTransformedLogs)	Specify true to have this rule evalute log events after they have been transformed by Log transformation.
PutInsightRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutInsightRuleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutInsightRuleRequest.Builder	ruleDefinition(String ruleDefinition)	The definition of the rule, as a JSON object.
PutInsightRuleRequest.Builder	ruleName(String ruleName)	A unique name for the rule.
PutInsightRuleRequest.Builder	ruleState(String ruleState)	The state of the rule.
PutInsightRuleRequest.Builder	tags(Collection<Tag> tags)	A list of key-value pairs to associate with the Contributor Insights rule.
PutInsightRuleRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of key-value pairs to associate with the Contributor Insights rule.
PutInsightRuleRequest.Builder	tags(Tag... tags)	A list of key-value pairs to associate with the Contributor Insights rule.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

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

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)

applyOnTransformedLogs

PutInsightRuleRequest.Builder applyOnTransformedLogs(Boolean applyOnTransformedLogs)

Specify true to have this rule evalute 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 evalute 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutInsightRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder