Package software.amazon.awssdk.services.cloudtrail.model

Class DataResource

java.lang.Object

software.amazon.awssdk.services.cloudtrail.model.DataResource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataResource.Builder,DataResource>

@Generated("software.amazon.awssdk:codegen")
public final class DataResource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataResource.Builder,DataResource>

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. 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.

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.

1. A user uploads an image file to bucket-1.

2. 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.

3. A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2.

4. 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.

1. A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

2. 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.

3. 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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataResource.Builder

Method Summary

Modifier and Type	Method	Description
static DataResource.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
final List<SdkField<?>>	sdkFields()
static Class<? extends DataResource.Builder>	serializableBuilderClass()
DataResource.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final String	type()	The resource type in which you want to log data events.
final List<String>	values()	An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

type

public final 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

The following resource types are also available through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector.

• AWS::CloudTrail::Channel

• AWS::CodeWhisperer::Customization

• AWS::CodeWhisperer::Profile

• AWS::Cognito::IdentityPool

• AWS::DynamoDB::Stream

• AWS::EC2::Snapshot

• AWS::EMRWAL::Workspace

• AWS::FinSpace::Environment

• AWS::Glue::Table

• AWS::GuardDuty::Detector

• AWS::KendraRanking::ExecutionPlan

• AWS::KinesisVideo::Stream

• AWS::ManagedBlockchain::Network

• AWS::ManagedBlockchain::Node

• AWS::MedicalImaging::Datastore

• AWS::PCAConnectorAD::Connector

• AWS::SageMaker::Endpoint

• AWS::SageMaker::ExperimentTrialComponent

• AWS::SageMaker::FeatureGroup

• AWS::SNS::PlatformEndpoint

• AWS::SNS::Topic

• AWS::S3::AccessPoint

• AWS::S3ObjectLambda::AccessPoint

• AWS::S3Outposts::Object

• AWS::SSMMessages::ControlChannel

• AWS::Timestream::Database

• AWS::Timestream::Table

• AWS::VerifiedPermissions::PolicyStore

Returns:

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

The following resource types are also available through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector.

• AWS::CloudTrail::Channel

• AWS::CodeWhisperer::Customization

• AWS::CodeWhisperer::Profile

• AWS::Cognito::IdentityPool

• AWS::DynamoDB::Stream

• AWS::EC2::Snapshot

• AWS::EMRWAL::Workspace

• AWS::FinSpace::Environment

• AWS::Glue::Table

• AWS::GuardDuty::Detector

• AWS::KendraRanking::ExecutionPlan

• AWS::KinesisVideo::Stream

• AWS::ManagedBlockchain::Network

• AWS::ManagedBlockchain::Node

• AWS::MedicalImaging::Datastore

• AWS::PCAConnectorAD::Connector

• AWS::SageMaker::Endpoint

• AWS::SageMaker::ExperimentTrialComponent

• AWS::SageMaker::FeatureGroup

• AWS::SNS::PlatformEndpoint

• AWS::SNS::Topic

• AWS::S3::AccessPoint

• AWS::S3ObjectLambda::AccessPoint

• AWS::S3Outposts::Object

• AWS::SSMMessages::ControlChannel

• AWS::Timestream::Database

• AWS::Timestream::Table

• AWS::VerifiedPermissions::PolicyStore

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

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

• 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

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

• 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.

toBuilder

public DataResource.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DataResource.Builder,DataResource>

Returns:

a builder for type T

builder

public static DataResource.Builder builder()

serializableBuilderClass

public static Class<? extends DataResource.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.