Class: Aws::CloudWatchLogs::Types::PutIndexPolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::PutIndexPolicyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #log_group_identifier ⇒ String

  Specify either the log group name or log group ARN to apply this field index policy to.

• #policy_document ⇒ String

  The index policy document, in JSON format.

Instance Attribute Details

#log_group_identifier ⇒ String

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:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 7710

class PutIndexPolicyRequest < Struct.new(
  :log_group_identifier,
  :policy_document)
  SENSITIVE = []
  include Aws::Structure
end

#policy_document ⇒ String

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

‘“policyDocument”: “[ ”TransactionId“ ], ”FieldsV2“: {”RequestId“: {”type“: ”FIELD_INDEX“, ”APIName“: ”FACET“, ”StatusCode“: ”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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Syntax.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 7710

class PutIndexPolicyRequest < Struct.new(
  :log_group_identifier,
  :policy_document)
  SENSITIVE = []
  include Aws::Structure
end