@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DataResource extends Object implements Serializable, Cloneable, StructuredPojo
Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
Configure the DataResource
to specify the resource type and resource ARNs for which you want to log data
events.
You can specify the following resource types in your event selectors for your trail:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
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.
If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.
The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket
named bucket-1
. 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 bucket-1
.
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:::bucket-2
.
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.
Constructor and Description |
---|
DataResource() |
Modifier and Type | Method and Description |
---|---|
DataResource |
clone() |
boolean |
equals(Object obj) |
String |
getType()
The resource type in which you want to log data events.
|
List<String> |
getValues()
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setType(String type)
The resource type in which you want to log data events.
|
void |
setValues(Collection<String> values)
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
|
String |
toString()
Returns a string representation of this object.
|
DataResource |
withType(String type)
The resource type in which you want to log data events.
|
DataResource |
withValues(Collection<String> values)
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
|
DataResource |
withValues(String... values)
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
|
public void setType(String type)
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 about these additional resource types, see AdvancedFieldSelector.
type
- 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 about these additional resource types, see AdvancedFieldSelector.
public String getType()
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 about these additional resource types, see AdvancedFieldSelector.
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
Additional resource types are available through advanced event selectors. For more information about these additional resource types, see AdvancedFieldSelector.
public DataResource withType(String type)
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 about these additional resource types, see AdvancedFieldSelector.
type
- 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 about these additional resource types, see AdvancedFieldSelector.
public List<String> getValues()
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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the
prefix as arn:aws:s3
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
public void setValues(Collection<String> values)
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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
values
- 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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
public DataResource withValues(String... values)
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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
or withValues(java.util.Collection)
if you want to override the
existing values.
values
- 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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
public DataResource withValues(Collection<String> values)
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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
values
- 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
.
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.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/
. 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:::bucket-1/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
.
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.
To log data events for a specific Lambda function, specify the function ARN.
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.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb
.
public String toString()
toString
in class Object
Object.toString()
public DataResource clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.