software.amazon.awscdk.services.cloudtrail

Class Trail

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudtrail.Trail

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.249Z")
 @Stability(value=Experimental)
public class Trail
extends Resource

(experimental) Cloud trail allows you to log events that happen in your AWS account For example:.

import { CloudTrail } from '@aws-cdk/aws-cloudtrail'

const cloudTrail = new CloudTrail(this, 'MyTrail');

NOTE the above example creates an UNENCRYPTED bucket by default, If you are required to use an Encrypted bucket you can supply a preconfigured bucket via TrailProps

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Trail.Builder (experimental) A fluent builder for Trail.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Trail(software.constructs.Construct scope, String id)
	Trail(software.constructs.Construct scope, String id, TrailProps props)
protected	Trail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Trail(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addEventSelector(DataResourceType dataResourceType, List<String> dataResourceValues) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
void	addEventSelector(DataResourceType dataResourceType, List<String> dataResourceValues, AddEventSelectorOptions options) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
void	addLambdaEventSelector(List<IFunction> handlers) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
void	addLambdaEventSelector(List<IFunction> handlers, AddEventSelectorOptions options) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
void	addS3EventSelector(List<S3EventSelector> s3Selector) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
void	addS3EventSelector(List<S3EventSelector> s3Selector, AddEventSelectorOptions options) (experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.
ILogGroup	getLogGroup() (experimental) The CloudWatch log group to which CloudTrail events are sent.
String	getTrailArn() (experimental) ARN of the CloudTrail trail i.e.
String	getTrailSnsTopicArn() (experimental) ARN of the Amazon SNS topic that's associated with the CloudTrail trail, i.e.
void	logAllLambdaDataEvents() (experimental) Log all Lamda data events for all lambda functions the account.
void	logAllLambdaDataEvents(AddEventSelectorOptions options) (experimental) Log all Lamda data events for all lambda functions the account.
void	logAllS3DataEvents() (experimental) Log all S3 data events for all objects for all buckets in the account.
void	logAllS3DataEvents(AddEventSelectorOptions options) (experimental) Log all S3 data events for all objects for all buckets in the account.
static Rule	onEvent(software.constructs.Construct scope, String id) (experimental) Create an event rule for when an event is recorded by any Trail in the account.
static Rule	onEvent(software.constructs.Construct scope, String id, OnEventOptions options) (experimental) Create an event rule for when an event is recorded by any Trail in the account.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Trail

protected Trail(software.amazon.jsii.JsiiObjectRef objRef)

Trail

protected Trail(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Trail

@Stability(value=Experimental)
public Trail(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            TrailProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Trail

@Stability(value=Experimental)
public Trail(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

onEvent

@Stability(value=Experimental)
 @NotNull
public static Rule onEvent(@NotNull
                                                                    software.constructs.Construct scope,
                                                                    @NotNull
                                                                    String id,
                                                                    @Nullable
                                                                    OnEventOptions options)

(experimental) Create an event rule for when an event is recorded by any Trail in the account.

Note that the event doesn't necessarily have to come from this Trail, it can be captured from any one.

Be sure to filter the event further down using an event pattern.

Parameters:

scope - This parameter is required.

id - This parameter is required.

options -

onEvent

@Stability(value=Experimental)
 @NotNull
public static Rule onEvent(@NotNull
                                                                    software.constructs.Construct scope,
                                                                    @NotNull
                                                                    String id)

(experimental) Create an event rule for when an event is recorded by any Trail in the account.

Note that the event doesn't necessarily have to come from this Trail, it can be captured from any one.

Be sure to filter the event further down using an event pattern.

Parameters:

scope - This parameter is required.

id - This parameter is required.

addEventSelector

@Stability(value=Experimental)
public void addEventSelector(@NotNull
                                                            DataResourceType dataResourceType,
                                                            @NotNull
                                                            List<String> dataResourceValues,
                                                            @Nullable
                                                            AddEventSelectorOptions options)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an Event Selector for filtering events that match either S3 or Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

dataResourceType - This parameter is required.

dataResourceValues - the list of data resource ARNs to include in logging (maximum 250 entries). This parameter is required.

options - the options to configure logging of management and data events.

addEventSelector

@Stability(value=Experimental)
public void addEventSelector(@NotNull
                                                            DataResourceType dataResourceType,
                                                            @NotNull
                                                            List<String> dataResourceValues)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an Event Selector for filtering events that match either S3 or Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

dataResourceType - This parameter is required.

dataResourceValues - the list of data resource ARNs to include in logging (maximum 250 entries). This parameter is required.

addLambdaEventSelector

@Stability(value=Experimental)
public void addLambdaEventSelector(@NotNull
                                                                  List<IFunction> handlers,
                                                                  @Nullable
                                                                  AddEventSelectorOptions options)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds a Lambda Data Event Selector for filtering events that match Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

handlers - the list of lambda function handlers whose data events should be logged (maximum 250 entries). This parameter is required.

options - the options to configure logging of management and data events.

addLambdaEventSelector

@Stability(value=Experimental)
public void addLambdaEventSelector(@NotNull
                                                                  List<IFunction> handlers)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds a Lambda Data Event Selector for filtering events that match Lambda function operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

handlers - the list of lambda function handlers whose data events should be logged (maximum 250 entries). This parameter is required.

addS3EventSelector

@Stability(value=Experimental)
public void addS3EventSelector(@NotNull
                                                              List<S3EventSelector> s3Selector,
                                                              @Nullable
                                                              AddEventSelectorOptions options)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an S3 Data Event Selector for filtering events that match S3 operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

s3Selector - the list of S3 bucket with optional prefix to include in logging (maximum 250 entries). This parameter is required.

options - the options to configure logging of management and data events.

addS3EventSelector

@Stability(value=Experimental)
public void addS3EventSelector(@NotNull
                                                              List<S3EventSelector> s3Selector)

(experimental) When an event occurs in your account, CloudTrail evaluates whether the event matches the settings for your trails.

Only events that match your trail settings are delivered to your Amazon S3 bucket and Amazon CloudWatch Logs log group.

This method adds an S3 Data Event Selector for filtering events that match S3 operations.

Data events: These events provide insight into the resource operations performed on or within a resource. These are also known as data plane operations.

Parameters:

s3Selector - the list of S3 bucket with optional prefix to include in logging (maximum 250 entries). This parameter is required.

logAllLambdaDataEvents

@Stability(value=Experimental)
public void logAllLambdaDataEvents(@Nullable
                                                                  AddEventSelectorOptions options)

(experimental) Log all Lamda data events for all lambda functions the account.

Default: false

Parameters:

options -

See Also:

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html

logAllLambdaDataEvents

@Stability(value=Experimental)
public void logAllLambdaDataEvents()

(experimental) Log all Lamda data events for all lambda functions the account.

Default: false

See Also:

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html

logAllS3DataEvents

@Stability(value=Experimental)
public void logAllS3DataEvents(@Nullable
                                                              AddEventSelectorOptions options)

(experimental) Log all S3 data events for all objects for all buckets in the account.

Default: false

Parameters:

options -

See Also:

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html

logAllS3DataEvents

@Stability(value=Experimental)
public void logAllS3DataEvents()

(experimental) Log all S3 data events for all objects for all buckets in the account.

Default: false

See Also:

https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html

getTrailArn

@Stability(value=Experimental)
 @NotNull
public String getTrailArn()

(experimental) ARN of the CloudTrail trail i.e. arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail.

getTrailSnsTopicArn

@Stability(value=Experimental)
 @NotNull
public String getTrailSnsTopicArn()

(experimental) ARN of the Amazon SNS topic that's associated with the CloudTrail trail, i.e. arn:aws:sns:us-east-2:123456789012:mySNSTopic.

getLogGroup

@Stability(value=Experimental)
 @Nullable
public ILogGroup getLogGroup()

(experimental) The CloudWatch log group to which CloudTrail events are sent.

undefined if sendToCloudWatchLogs property is false.