Class Trail

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

Inheritance
System.Object
Construct
Resource
Trail
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.CloudTrail
Assembly: Amazon.CDK.AWS.CloudTrail.dll
Syntax (csharp)
public class Trail : Resource, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class Trail
    Inherits Resource
    Implements IResource, IConstruct, IConstruct, IDependable
Remarks

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

Stability: Experimental

Synopsis

Constructors

Trail(Construct, String, ITrailProps)
Trail(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
Trail(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

TrailArn
TrailSnsTopicArn

Methods

AddS3EventSelector(String[], IAddS3EventSelectorOptions)

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

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

Constructors

Trail(Construct, String, ITrailProps)

public Trail(Construct scope, string id, ITrailProps props = null)
Parameters
scope Construct
id System.String
props ITrailProps
Remarks

Stability: Experimental

Trail(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Trail(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Trail(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Trail(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

TrailArn

public virtual string TrailArn { get; }
Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

TrailSnsTopicArn

public virtual string TrailSnsTopicArn { get; }
Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

Methods

AddS3EventSelector(String[], IAddS3EventSelectorOptions)

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

public virtual void AddS3EventSelector(string[] prefixes, IAddS3EventSelectorOptions options = null)
Parameters
prefixes System.String[]

the list of object ARN prefixes to include in logging (maximum 250 entries).

options IAddS3EventSelectorOptions

the options to configure logging of management and data events.

Remarks

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.

Stability: Experimental

OnCloudTrailEvent(String, IOnEventOptions)

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

public virtual Rule OnCloudTrailEvent(string id, IOnEventOptions options = null)
Parameters
id System.String
options IOnEventOptions
Returns

Rule

Remarks

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.

Stability: Experimental

Implements

Constructs.IConstruct