com.amazonaws.services.cloudtrail.model

Class CreateTrailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.CreateTrailRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateTrailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateTrail operation.

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

See Also:

AWSCloudTrail.createTrail(CreateTrailRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTrailRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateTrailRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCloudWatchLogsLogGroupArn() Specifies a log group name using 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	getEnableLogFileValidation() Specifies whether log file integrity validation is enabled.
Boolean	getIncludeGlobalServiceEvents() Specifies whether the trail is publishing events from global services such as IAM to the log files.
String	getKmsKeyId() Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
String	getName() Specifies the name of the trail.
String	getS3BucketName() Specifies the name of the Amazon S3 bucket designated for publishing log 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() Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
int	hashCode()
Boolean	isEnableLogFileValidation() Specifies whether log file integrity validation is enabled.
Boolean	isIncludeGlobalServiceEvents() Specifies whether the trail is publishing events from global services such as IAM to the log files.
void	setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using 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	setEnableLogFileValidation(Boolean enableLogFileValidation) Specifies whether log file integrity validation is enabled.
void	setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.
void	setKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
void	setName(String name) Specifies the name of the trail.
void	setS3BucketName(String s3BucketName) Specifies the name of the Amazon S3 bucket designated for publishing log 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) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateTrailRequest	withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn) Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
CreateTrailRequest	withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn) Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
CreateTrailRequest	withEnableLogFileValidation(Boolean enableLogFileValidation) Specifies whether log file integrity validation is enabled.
CreateTrailRequest	withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents) Specifies whether the trail is publishing events from global services such as IAM to the log files.
CreateTrailRequest	withKmsKeyId(String kmsKeyId) Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
CreateTrailRequest	withName(String name) Specifies the name of the trail.
CreateTrailRequest	withS3BucketName(String s3BucketName) Specifies the name of the Amazon S3 bucket designated for publishing log files.
CreateTrailRequest	withS3KeyPrefix(String s3KeyPrefix) Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
CreateTrailRequest	withSnsTopicName(String snsTopicName) Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateTrailRequest

public CreateTrailRequest()

Method Detail

getName

public String getName()

Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

Returns:

Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

setName

public void setName(String name)

Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

Parameters:

name - Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

withName

public CreateTrailRequest withName(String name)

Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

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

Parameters:

name - Specifies the name of the trail. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
• Start with a letter or number, and end with a letter or number
• Be between 3 and 128 characters
• Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
• Not be in IP address format (for example, 192.168.5.4)

Returns:

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

getS3BucketName

public String getS3BucketName()

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

Returns:

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

setS3BucketName

public void setS3BucketName(String s3BucketName)

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

Parameters:

s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

withS3BucketName

public CreateTrailRequest withS3BucketName(String s3BucketName)

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

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

Parameters:

s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log 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 CreateTrailRequest 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()

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Returns:

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

setSnsTopicName

public void setSnsTopicName(String snsTopicName)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

Parameters:

snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

withSnsTopicName

public CreateTrailRequest withSnsTopicName(String snsTopicName)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

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

Parameters:

snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. 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()

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

Specifies whether the trail is publishing events from global services such as IAM to the log files.

setIncludeGlobalServiceEvents

public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Parameters:

includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.

withIncludeGlobalServiceEvents

public CreateTrailRequest withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

Specifies whether the trail is publishing events from global services such as IAM to the log files.

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

Parameters:

includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

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

getIncludeGlobalServiceEvents

public Boolean getIncludeGlobalServiceEvents()

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

Specifies whether the trail is publishing events from global services such as IAM to the log files.

isEnableLogFileValidation

public Boolean isEnableLogFileValidation()

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

Returns:

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

setEnableLogFileValidation

public void setEnableLogFileValidation(Boolean enableLogFileValidation)

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

Parameters:

enableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

withEnableLogFileValidation

public CreateTrailRequest withEnableLogFileValidation(Boolean enableLogFileValidation)

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

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

Parameters:

enableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

Returns:

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

getEnableLogFileValidation

public Boolean getEnableLogFileValidation()

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

Returns:

Specifies whether log file integrity validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

getCloudWatchLogsLogGroupArn

public String getCloudWatchLogsLogGroupArn()

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Returns:

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

setCloudWatchLogsLogGroupArn

public void setCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

Parameters:

cloudWatchLogsLogGroupArn - Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

withCloudWatchLogsLogGroupArn

public CreateTrailRequest withCloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

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

Parameters:

cloudWatchLogsLogGroupArn - Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

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 CreateTrailRequest 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 to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

Returns:

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

Parameters:

kmsKeyId - Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

withKmsKeyId

public CreateTrailRequest withKmsKeyId(String kmsKeyId)

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 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 to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• 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 CreateTrailRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()