Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface PutIndexPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>, SdkBuilder<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutIndexPolicyRequest

@Mutable
@NotThreadSafe
public static interface PutIndexPolicyRequest.Builder
extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>

Method Summary

Modifier and Type	Method	Description
PutIndexPolicyRequest.Builder	logGroupIdentifier(String logGroupIdentifier)	Specify either the log group name or log group ARN to apply this field index policy to.
PutIndexPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutIndexPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutIndexPolicyRequest.Builder	policyDocument(String policyDocument)	The index policy document, in JSON format.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest.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

logGroupIdentifier

PutIndexPolicyRequest.Builder logGroupIdentifier(String logGroupIdentifier)

Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

Parameters:

logGroupIdentifier - Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

Returns:

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

policyDocument

PutIndexPolicyRequest.Builder policyDocument(String policyDocument)

The index policy document, in JSON format. The following is an example of an index policy document that creates indexes with different types.

"policyDocument": "{"Fields": [ "TransactionId" ], "FieldsV2": {"RequestId": {"type": "FIELD_INDEX"}, "APIName": {"type": "FACET"}, "StatusCode": {"type": "FACET"}}}"

You can use FieldsV2 to specify the type for each field. Supported types are FIELD_INDEX and FACET. Field names within Fields and FieldsV2 must be mutually exclusive.

The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas.

Parameters:

policyDocument - The index policy document, in JSON format. The following is an example of an index policy document that creates indexes with different types.

"policyDocument": "{"Fields": [ "TransactionId" ], "FieldsV2": {"RequestId": {"type": "FIELD_INDEX"}, "APIName": {"type": "FACET"}, "StatusCode": {"type": "FACET"}}}"

You can use FieldsV2 to specify the type for each field. Supported types are FIELD_INDEX and FACET. Field names within Fields and FieldsV2 must be mutually exclusive.

The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas.

Returns:

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

overrideConfiguration

PutIndexPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder