Class: Aws::CloudTrail::Types::AdvancedFieldSelector

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudtrail/types.rb

Overview

Note:

When making an API call, you may pass AdvancedFieldSelector data as a hash:

{
  field: "SelectorField", # required
  equals: ["OperatorValue"],
  starts_with: ["OperatorValue"],
  ends_with: ["OperatorValue"],
  not_equals: ["OperatorValue"],
  not_starts_with: ["OperatorValue"],
  not_ends_with: ["OperatorValue"],
}

A single selector statement in an advanced event selector.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ends_withArray<String>

An operator that includes events that match the last few characters of the event record field specified as the value of `Field`.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#equalsArray<String>

An operator that includes events that match the exact value of the event record field specified as the value of `Field`. This is the only valid operator that you can use with the `readOnly`, `eventCategory`, and `resources.type` fields.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#fieldString

A field in an event record on which to filter events to be logged. Supported fields include `readOnly`, `eventCategory`, `eventSource` (for management events), `eventName`, `resources.type`, and `resources.ARN`.

  • readOnly - Optional. Can be set to `Equals` a value of `true` or `false`. If you do not add this field, CloudTrail logs both `read` and `write` events. A value of `true` logs only `read` events. A value of `false` logs only `write` events.

  • eventSource - For filtering management events only. This can be set only to `NotEquals` `kms.amazonaws.com`.

  • eventName - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock`. You can have multiple values for this field, separated by commas.

  • eventCategory - This is required. It must be set to `Equals`, and the value must be `Management` or `Data`.

  • resources.type - This field is required. `resources.type` can only use the `Equals` operator, and the value can be one of the following:

    • `AWS::S3::Object`

    • `AWS::Lambda::Function`

    • `AWS::DynamoDB::Table`

    • `AWS::S3Outposts::Object`

    • `AWS::ManagedBlockchain::Node`

    • `AWS::S3ObjectLambda::AccessPoint`

    • `AWS::EC2::Snapshot`

    • `AWS::S3::AccessPoint`

    • `AWS::DynamoDB::Stream`

    • `AWS::Glue::Table`

    You can have only one `resources.type` field per selector. To log data events on more than one resource type, add another selector.

  • resources.ARN - You can use any operator with `resources.ARN`, but if you use `Equals` or `NotEquals`, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals `AWS::S3::Object`, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the `StartsWith` operator, and include only the bucket ARN as the matching value.

    The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (&lt;&gt;) with resource-specific information.

    • `arn:<partition>:s3:::<bucket_name>/`

    • `arn:<partition>:s3:::<bucket_name>/<object_path>/`

    When `resources.type` equals `AWS::S3::AccessPoint`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the `StartsWith` or `NotStartsWith` operators.

    • `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>`

    • `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>`

    When resources.type equals `AWS::Lambda::Function`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>`

    ^

    When resources.type equals `AWS::DynamoDB::Table`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>`

    ^

    When `resources.type` equals `AWS::S3Outposts::Object`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>`

    ^

    When `resources.type` equals `AWS::ManagedBlockchain::Node`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>`

    ^

    When `resources.type` equals `AWS::S3ObjectLambda::AccessPoint`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>`

    ^

    When `resources.type` equals `AWS::EC2::Snapshot`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>`

    ^

    When `resources.type` equals `AWS::DynamoDB::Stream`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>`

    ^

    When `resources.type` equals `AWS::Glue::Table`, and the operator is set to `Equals` or `NotEquals`, the ARN must be in the following format:

    • `arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>`

    ^

Returns:

  • (String)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#not_ends_withArray<String>

An operator that excludes events that match the last few characters of the event record field specified as the value of `Field`.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#not_equalsArray<String>

An operator that excludes events that match the exact value of the event record field specified as the value of `Field`.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#not_starts_withArray<String>

An operator that excludes events that match the first few characters of the event record field specified as the value of `Field`.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end

#starts_withArray<String>

An operator that includes events that match the first few characters of the event record field specified as the value of `Field`.

Returns:

  • (Array<String>)

316
317
318
319
320
321
322
323
324
325
326
# File 'lib/aws-sdk-cloudtrail/types.rb', line 316

class AdvancedFieldSelector < Struct.new(
  :field,
  :equals,
  :starts_with,
  :ends_with,
  :not_equals,
  :not_starts_with,
  :not_ends_with)
  SENSITIVE = []
  include Aws::Structure
end