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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6160

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 two indexes, RequestId and TransactionId.

"policyDocument": "{ "Fields": [ "RequestId", "TransactionId" ] }"

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.