com.amazonaws.services.cloudtrail.model

Class Trail

java.lang.Object

com.amazonaws.services.cloudtrail.model.Trail

All Implemented Interfaces:

Serializable, Cloneable

public class Trail
extends Object
implements Serializable, Cloneable

The settings for a trail.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Trail()

Method Summary

Methods

Modifier and Type	Method and Description
Trail	clone()
boolean	equals(Object obj)
String	getCloudWatchLogsLogGroupArn() Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
String	getCloudWatchLogsRoleArn() Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Boolean	getIncludeGlobalServiceEvents() Set to True to include AWS API calls from AWS global services such as IAM.
String	getKmsKeyId() Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
Boolean	getLogFileValidationEnabled() Specifies whether log file validation is enabled.
String	getName() Name of the trail set by calling CreateTrail.
String	getS3BucketName() Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
String	getS3KeyPrefix() Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
String	getSnsTopicName() Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
String	getTrailARN() The Amazon Resource Name of the trail.
int	hashCode()
Boolean	isIncludeGlobalServiceEvents() Set to True to include AWS API calls from AWS global services such as IAM.
Boolean	isLogFileValidationEnabled() Specifies whether log file validation is enabled.
void	setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
void	setCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
void	setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Set to True to include AWS API calls from AWS global services such as IAM.
void	setKmsKeyId(String kmsKeyId) Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
void	setLogFileValidationEnabled(Boolean logFileValidationEnabled) Specifies whether log file validation is enabled.
void	setName(String name) Name of the trail set by calling CreateTrail.
void	setS3BucketName(String s3BucketName) Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
void	setS3KeyPrefix(String s3KeyPrefix) Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
void	setSnsTopicName(String snsTopicName) Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
void	setTrailARN(String trailARN) The Amazon Resource Name of the trail.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Trail	withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
Trail	withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Trail	withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Set to True to include AWS API calls from AWS global services such as IAM.
Trail	withKmsKeyId(String kmsKeyId) Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
Trail	withLogFileValidationEnabled(Boolean logFileValidationEnabled) Specifies whether log file validation is enabled.
Trail	withName(String name) Name of the trail set by calling CreateTrail.
Trail	withS3BucketName(String s3BucketName) Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
Trail	withS3KeyPrefix(String s3KeyPrefix) Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
Trail	withSnsTopicName(String snsTopicName) Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
Trail	withTrailARN(String trailARN) The Amazon Resource Name of the trail.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Trail

public Trail()

Method Detail

getName

public String getName()

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

Returns:

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

setName

public void setName(String name)

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

Parameters:

name - Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

withName

public Trail withName(String name)

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

name - Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3BucketName

public String getS3BucketName()

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

Returns:

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

setS3BucketName

public void setS3BucketName(String s3BucketName)

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

Parameters:

s3BucketName - Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

withS3BucketName

public Trail withS3BucketName(String s3BucketName)

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

Returns a reference to this object so that method calls can be chained together.

Parameters:

s3BucketName - Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3KeyPrefix

public String getS3KeyPrefix()

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

Returns:

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

setS3KeyPrefix

public void setS3KeyPrefix(String s3KeyPrefix)

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

Parameters:

s3KeyPrefix - Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

withS3KeyPrefix

public Trail withS3KeyPrefix(String s3KeyPrefix)

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

s3KeyPrefix - Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnsTopicName

public String getSnsTopicName()

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

Returns:

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

setSnsTopicName

public void setSnsTopicName(String snsTopicName)

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

Parameters:

snsTopicName - Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

withSnsTopicName

public Trail withSnsTopicName(String snsTopicName)

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snsTopicName - Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

isIncludeGlobalServiceEvents

public Boolean isIncludeGlobalServiceEvents()

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Returns:

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

setIncludeGlobalServiceEvents

public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Parameters:

includeGlobalServiceEvents - Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

withIncludeGlobalServiceEvents

public Trail withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Returns a reference to this object so that method calls can be chained together.

Parameters:

includeGlobalServiceEvents - Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Returns:

A reference to this updated object so that method calls can be chained together.

getIncludeGlobalServiceEvents

public Boolean getIncludeGlobalServiceEvents()

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

Returns:

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

getTrailARN

public String getTrailARN()

The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

Returns:

The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

setTrailARN

public void setTrailARN(String trailARN)

The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

Parameters:

trailARN - The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

withTrailARN

public Trail withTrailARN(String trailARN)

The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

Returns a reference to this object so that method calls can be chained together.

Parameters:

trailARN - The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.

Returns:

A reference to this updated object so that method calls can be chained together.

isLogFileValidationEnabled

public Boolean isLogFileValidationEnabled()

Specifies whether log file validation is enabled.

Returns:

Specifies whether log file validation is enabled.

setLogFileValidationEnabled

public void setLogFileValidationEnabled(Boolean logFileValidationEnabled)

Specifies whether log file validation is enabled.

Parameters:

logFileValidationEnabled - Specifies whether log file validation is enabled.

withLogFileValidationEnabled

public Trail withLogFileValidationEnabled(Boolean logFileValidationEnabled)

Specifies whether log file validation is enabled.

Returns a reference to this object so that method calls can be chained together.

Parameters:

logFileValidationEnabled - Specifies whether log file validation is enabled.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogFileValidationEnabled

public Boolean getLogFileValidationEnabled()

Specifies whether log file validation is enabled.

Returns:

Specifies whether log file validation is enabled.

getCloudWatchLogsLogGroupArn

public String getCloudWatchLogsLogGroupArn()

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

Returns:

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

setCloudWatchLogsLogGroupArn

public void setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

Parameters:

cloudWatchLogsLogGroupArn - Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

withCloudWatchLogsLogGroupArn

public Trail withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cloudWatchLogsLogGroupArn - Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloudWatchLogsRoleArn

public String getCloudWatchLogsRoleArn()

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Returns:

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

setCloudWatchLogsRoleArn

public void setCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Parameters:

cloudWatchLogsRoleArn - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

withCloudWatchLogsRoleArn

public Trail withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cloudWatchLogsRoleArn - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getKmsKeyId

public String getKmsKeyId()

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

Returns:

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

Parameters:

kmsKeyId - Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

withKmsKeyId

public Trail withKmsKeyId(String kmsKeyId)

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

Returns a reference to this object so that method calls can be chained together.

Parameters:

kmsKeyId - Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Trail clone()

Overrides:

clone in class Object