software.amazon.awscdk.services.cloudtrail

Class TrailProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudtrail.TrailProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TrailProps>

Enclosing interface:

TrailProps

@Stability(value=Experimental)
public static final class TrailProps.Builder
extends Object
implements software.amazon.jsii.Builder<TrailProps>

A builder for TrailProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TrailProps.Builder	bucket(IBucket bucket) Sets the value of TrailProps.getBucket()
TrailProps	build() Builds the configured instance.
TrailProps.Builder	cloudWatchLogGroup(ILogGroup cloudWatchLogGroup) Sets the value of TrailProps.getCloudWatchLogGroup()
TrailProps.Builder	cloudWatchLogsRetention(RetentionDays cloudWatchLogsRetention) Sets the value of TrailProps.getCloudWatchLogsRetention()
TrailProps.Builder	enableFileValidation(Boolean enableFileValidation) Sets the value of TrailProps.getEnableFileValidation()
TrailProps.Builder	encryptionKey(IKey encryptionKey) Sets the value of TrailProps.getEncryptionKey()
TrailProps.Builder	includeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Sets the value of TrailProps.getIncludeGlobalServiceEvents()
TrailProps.Builder	isMultiRegionTrail(Boolean isMultiRegionTrail) Sets the value of TrailProps.getIsMultiRegionTrail()
TrailProps.Builder	managementEvents(ReadWriteType managementEvents) Sets the value of TrailProps.getManagementEvents()
TrailProps.Builder	s3KeyPrefix(String s3KeyPrefix) Sets the value of TrailProps.getS3KeyPrefix()
TrailProps.Builder	sendToCloudWatchLogs(Boolean sendToCloudWatchLogs) Sets the value of TrailProps.getSendToCloudWatchLogs()
TrailProps.Builder	snsTopic(ITopic snsTopic) Sets the value of TrailProps.getSnsTopic()
TrailProps.Builder	trailName(String trailName) Sets the value of TrailProps.getTrailName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

bucket

@Stability(value=Experimental)
public TrailProps.Builder bucket(IBucket bucket)

Sets the value of TrailProps.getBucket()

Parameters:

bucket - The Amazon S3 bucket.

Returns:

this

cloudWatchLogGroup

@Stability(value=Experimental)
public TrailProps.Builder cloudWatchLogGroup(ILogGroup cloudWatchLogGroup)

Sets the value of TrailProps.getCloudWatchLogGroup()

Parameters:

cloudWatchLogGroup - Log Group to which CloudTrail to push logs to. Ignored if sendToCloudWatchLogs is set to false.

Returns:

this

cloudWatchLogsRetention

@Stability(value=Experimental)
public TrailProps.Builder cloudWatchLogsRetention(RetentionDays cloudWatchLogsRetention)

Sets the value of TrailProps.getCloudWatchLogsRetention()

Parameters:

cloudWatchLogsRetention - How long to retain logs in CloudWatchLogs. Ignored if sendToCloudWatchLogs is false or if cloudWatchLogGroup is set.

Returns:

this

enableFileValidation

@Stability(value=Experimental)
public TrailProps.Builder enableFileValidation(Boolean enableFileValidation)

Sets the value of TrailProps.getEnableFileValidation()

Parameters:

enableFileValidation - To determine whether a log file was modified, deleted, or unchanged after CloudTrail delivered it, you can use CloudTrail log file integrity validation. This feature is built using industry standard algorithms: SHA-256 for hashing and SHA-256 with RSA for digital signing. This makes it computationally infeasible to modify, delete or forge CloudTrail log files without detection. You can use the AWS CLI to validate the files in the location where CloudTrail delivered them.

Returns:

this

encryptionKey

@Stability(value=Experimental)
public TrailProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of TrailProps.getEncryptionKey()

Parameters:

encryptionKey - The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.

Returns:

this

includeGlobalServiceEvents

@Stability(value=Experimental)
public TrailProps.Builder includeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Sets the value of TrailProps.getIncludeGlobalServiceEvents()

Parameters:

includeGlobalServiceEvents - For most services, events are recorded in the region where the action occurred. For global services such as AWS Identity and Access Management (IAM), AWS STS, Amazon CloudFront, and Route 53, events are delivered to any trail that includes global services, and are logged as occurring in US East (N. Virginia) Region.

Returns:

this

isMultiRegionTrail

@Stability(value=Experimental)
public TrailProps.Builder isMultiRegionTrail(Boolean isMultiRegionTrail)

Sets the value of TrailProps.getIsMultiRegionTrail()

Parameters:

isMultiRegionTrail - Whether or not this trail delivers log files from multiple regions to a single S3 bucket for a single account.

Returns:

this

managementEvents

@Stability(value=Experimental)
public TrailProps.Builder managementEvents(ReadWriteType managementEvents)

Sets the value of TrailProps.getManagementEvents()

Parameters:

managementEvents - 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 sets the management configuration for this trail.

Management events provide insight into management operations that are performed on resources in your AWS account. These are also known as control plane operations. Management events can also include non-API events that occur in your account. For example, when a user logs in to your account, CloudTrail logs the ConsoleLogin event.

Returns:

this

s3KeyPrefix

@Stability(value=Experimental)
public TrailProps.Builder s3KeyPrefix(String s3KeyPrefix)

Sets the value of TrailProps.getS3KeyPrefix()

Parameters:

s3KeyPrefix - An Amazon S3 object key prefix that precedes the name of all log files.

Returns:

this

sendToCloudWatchLogs

@Stability(value=Experimental)
public TrailProps.Builder sendToCloudWatchLogs(Boolean sendToCloudWatchLogs)

Sets the value of TrailProps.getSendToCloudWatchLogs()

Parameters:

sendToCloudWatchLogs - If CloudTrail pushes logs to CloudWatch Logs in addition to S3. Disabled for cost out of the box.

Returns:

this

snsTopic

@Stability(value=Experimental)
public TrailProps.Builder snsTopic(ITopic snsTopic)

Sets the value of TrailProps.getSnsTopic()

Parameters:

snsTopic - SNS topic that is notified when new log files are published.

Returns:

this

trailName

@Stability(value=Experimental)
public TrailProps.Builder trailName(String trailName)

Sets the value of TrailProps.getTrailName()

Parameters:

trailName - The name of the trail. We recoomend customers do not set an explicit name.

Returns:

this

build

@Stability(value=Experimental)
public TrailProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<TrailProps>

Returns:

a new instance of TrailProps

Throws:

NullPointerException - if any required attribute was not provided