Class AuditHelper

Helper class for generating CloudTrail audit resources for use with S3 data events.

Index

Constructors

Methods

createCloudTrail createGlueAuditTable

Constructors

constructor

new AuditHelper(): AuditHelper
Returns AuditHelper

Methods

`Static`createCloudTrail

createCloudTrail(
    scope: Construct,
    destinationBucket: IBucket,
    encryptionKey: IKey,
    naming: IMdaaResourceNaming,
    trailName: string,
    includeManagementEvents?: boolean,
    eventSelectors?: { bucket: IBucket; objectPrefix?: string }[],
): Trail
Helper method which creates an S3 Data Events CloudTrail.
Parameters
- scope: Construct
  The CDK scope in which the Trail resource will be created.
- destinationBucket: IBucket
  The destination bucket where the Trail will be written
- encryptionKey: IKey
  The KMS CMK with which the trail data will be encrypted when written to S3
- naming: IMdaaResourceNaming
  The MDAA Naming implementation which will be used to name the CloudTrail resources
- trailName: string
  The name the CloudTrail. The full name will be generated by the MDAA Naming implementation
- OptionalincludeManagementEvents: boolean
- OptionaleventSelectors: { bucket: IBucket; objectPrefix?: string }[]
  The set of bucket names and prefixes for which S3 data events will be captured. If not specified, the Trail will capture all S3 Data Events in the account.
Returns Trail
A CloudTrail which captures S3 Data Events.
- Defined in index.ts:27

`Static`createGlueAuditTable

createGlueAuditTable(
    scope: Construct,
    bucket: IBucket,
    database: IDatabase,
    accounts: string[],
    regions: string[],
): S3Table
A helper method for generating a Glue table for querying CloudTrail audit events from an S3 bucket.
Parameters
- scope: Construct
  The scope in which the table will be created.
- bucket: IBucket
  The bucket where the CloudTrail data is stored
- database: IDatabase
  The database where the table will be created
- accounts: string[]
  The accounts for which CloudTrail data has been produced in the bucket.
- regions: string[]
  The regions for which CloudTrail data has been produced in the bucket.
Returns S3Table
A Glue Table which can be used to query CloudTrail data.
- Defined in index.ts:83