Class: Aws::CloudTrail::Types::DataResource

Inherits:

Struct

Object
Struct
Aws::CloudTrail::Types::DataResource

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudtrail/types.rb

Overview

You can configure the ‘DataResource` in an `EventSelector` to log data events for the following three resource types:

‘AWS::DynamoDB::Table`
‘AWS::Lambda::Function`
‘AWS::S3::Object`

To log data events for all other resource types including objects stored in [directory buckets], you must use [AdvancedEventSelectors]. You must also use ‘AdvancedEventSelectors` if you want to filter on the `eventName` field.

Configure the ‘DataResource` to specify the resource type and resource ARNs for which you want to log data events.

<note markdown=“1”> The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

</note>

The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named ‘amzn-s3-demo-bucket1`. In this example, the CloudTrail user specified an empty prefix, and the option to log both `Read` and `Write` data events.

A user uploads an image file to ‘amzn-s3-demo-bucket1`.
The ‘PutObject` API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
A user uploads an object to an Amazon S3 bucket named ‘arn:aws:s3:::amzn-s3-demo-bucket1`.
The ‘PutObject` API operation occurred for an object in an S3 bucket that the CloudTrail user didn’t specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.

A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
The ‘Invoke` API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.
The ‘Invoke` API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the `Invoke` operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html [2]: docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#type ⇒ String

The resource type in which you want to log data events.
#values ⇒ Array<String>

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

Instance Attribute Details

#type ⇒ `String`

The resource type in which you want to log data events. You can specify the following basic event selector resource types:

‘AWS::DynamoDB::Table`
‘AWS::Lambda::Function`
‘AWS::S3::Object`

Additional resource types are available through advanced event selectors. For more information, see [AdvancedEventSelector].

[1]: docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html

Returns:

(String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 1169

class DataResource < Struct.new(
  :type,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ `Array<String>`

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.

To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as ‘arn:aws:s3`.

<note markdown=“1”> This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
```
</note>
```
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as ‘arn:aws:s3:::amzn-s3-demo-bucket1/`. The trail logs data events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such as ‘arn:aws:s3:::amzn-s3-demo-bucket1/example-images`. The trail logs data events for objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as ‘arn:aws:lambda`.

<note markdown=“1”> This also enables logging of ‘Invoke` activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
```
</note>
```
To log data events for a specific Lambda function, specify the function ARN.

<note markdown=“1”> Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
```
</note>
```
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as ‘arn:aws:dynamodb`.