Class: AWSCDK::CloudTrail::CfnTrail::DataResourceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_trail/cfn_trail.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 event_name field.

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

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.

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, values: nil) ⇒ DataResourceProperty

Returns a new instance of DataResourceProperty.

Parameters:

  • type (String) —

    The resource type in which you want to log data events.

  • values (Array<String>, nil) (defaults to: nil) —

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



1060
1061
1062
1063
1064
1065
 
# File 'cloud_trail/cfn_trail.rb', line 1060

def initialize(type:, values: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @values = values
  Jsii::Type.check_type(@values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "values") unless @values.nil?
end

Instance Attribute Details

#type ⇒ String (readonly)

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 .

Returns:

  • (String)

See Also:



1079
1080
1081
 
# File 'cloud_trail/cfn_trail.rb', line 1079

def type
  @type
end

#values ⇒ Array<String>? (readonly)

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 AWS account , specify the prefix as arn:aws:s3 .

This also enables logging of data event activity performed by any user or role in your AWS account , even if that activity is performed on a bucket that belongs to another AWS 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:::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 AWS account , specify the prefix as arn:aws:lambda .

This also enables logging of Invoke activity performed by any user or role in your AWS account , even if that activity is performed on a function that belongs to another AWS 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 AWS account , specify the prefix as arn:aws:dynamodb .

Returns:

  • (Array<String>, nil)

See Also:



1100
1101
1102
 
# File 'cloud_trail/cfn_trail.rb', line 1100

def values
  @values
end

Class Method Details

.jsii_properties ⇒ Object 



1102
1103
1104
1105
1106
1107
 
# File 'cloud_trail/cfn_trail.rb', line 1102

def self.jsii_properties
  {
    :type => "type",
    :values => "values",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'cloud_trail/cfn_trail.rb', line 1109

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "values" => @values,
  })
  result.compact
end