public class Trail
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
The settings for a trail.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
cloudWatchLogsLogGroupArn
Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be delivered.
|
private java.lang.String |
cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to
a user's log group.
|
private java.lang.String |
homeRegion
The region in which the trail was created.
|
private java.lang.Boolean |
includeGlobalServiceEvents
Set to True to include AWS API calls from AWS global services such
as IAM.
|
private java.lang.Boolean |
isMultiRegionTrail
Specifies whether the trail belongs only to one region or exists in all
regions.
|
private java.lang.String |
kmsKeyId
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
private java.lang.Boolean |
logFileValidationEnabled
Specifies whether log file validation is enabled.
|
private java.lang.String |
name
Name of the trail set by calling CreateTrail.
|
private java.lang.String |
s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files.
|
private java.lang.String |
s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
|
private java.lang.String |
snsTopicARN
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered.
|
private java.lang.String |
snsTopicName
Deprecated.
|
private java.lang.String |
trailARN
Specifies the ARN of the trail.
|
Constructor and Description |
---|
Trail() |
Modifier and Type | Method and Description |
---|---|
Trail |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCloudWatchLogsLogGroupArn()
Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be delivered.
|
java.lang.String |
getCloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to
a user's log group.
|
java.lang.String |
getHomeRegion()
The region in which the trail was created.
|
java.lang.Boolean |
getIncludeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such
as IAM.
|
java.lang.Boolean |
getIsMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all
regions.
|
java.lang.String |
getKmsKeyId()
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
java.lang.Boolean |
getLogFileValidationEnabled()
Specifies whether log file validation is enabled.
|
java.lang.String |
getName()
Name of the trail set by calling CreateTrail.
|
java.lang.String |
getS3BucketName()
Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files.
|
java.lang.String |
getS3KeyPrefix()
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
|
java.lang.String |
getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered.
|
java.lang.String |
getSnsTopicName()
Deprecated.
|
java.lang.String |
getTrailARN()
Specifies the ARN of the trail.
|
int |
hashCode() |
java.lang.Boolean |
isIncludeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such
as IAM.
|
java.lang.Boolean |
isLogFileValidationEnabled()
Specifies whether log file validation is enabled.
|
java.lang.Boolean |
isMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all
regions.
|
void |
setCloudWatchLogsLogGroupArn(java.lang.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(java.lang.String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to
a user's log group.
|
void |
setHomeRegion(java.lang.String homeRegion)
The region in which the trail was created.
|
void |
setIncludeGlobalServiceEvents(java.lang.Boolean includeGlobalServiceEvents)
Set to True to include AWS API calls from AWS global services such
as IAM.
|
void |
setIsMultiRegionTrail(java.lang.Boolean isMultiRegionTrail)
Specifies whether the trail belongs only to one region or exists in all
regions.
|
void |
setKmsKeyId(java.lang.String kmsKeyId)
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
void |
setLogFileValidationEnabled(java.lang.Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
|
void |
setName(java.lang.String name)
Name of the trail set by calling CreateTrail.
|
void |
setS3BucketName(java.lang.String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files.
|
void |
setS3KeyPrefix(java.lang.String s3KeyPrefix)
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
|
void |
setSnsTopicARN(java.lang.String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered.
|
void |
setSnsTopicName(java.lang.String snsTopicName)
Deprecated.
|
void |
setTrailARN(java.lang.String trailARN)
Specifies the ARN of the trail.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Trail |
withCloudWatchLogsLogGroupArn(java.lang.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(java.lang.String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to
a user's log group.
|
Trail |
withHomeRegion(java.lang.String homeRegion)
The region in which the trail was created.
|
Trail |
withIncludeGlobalServiceEvents(java.lang.Boolean includeGlobalServiceEvents)
Set to True to include AWS API calls from AWS global services such
as IAM.
|
Trail |
withIsMultiRegionTrail(java.lang.Boolean isMultiRegionTrail)
Specifies whether the trail belongs only to one region or exists in all
regions.
|
Trail |
withKmsKeyId(java.lang.String kmsKeyId)
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
Trail |
withLogFileValidationEnabled(java.lang.Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
|
Trail |
withName(java.lang.String name)
Name of the trail set by calling CreateTrail.
|
Trail |
withS3BucketName(java.lang.String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files.
|
Trail |
withS3KeyPrefix(java.lang.String s3KeyPrefix)
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
|
Trail |
withSnsTopicARN(java.lang.String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered.
|
Trail |
withSnsTopicName(java.lang.String snsTopicName)
Deprecated.
|
Trail |
withTrailARN(java.lang.String trailARN)
Specifies the ARN of the trail.
|
private java.lang.String name
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
private java.lang.String s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
private java.lang.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.
@Deprecated private java.lang.String snsTopicName
Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
private java.lang.String snsTopicARN
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
private java.lang.Boolean includeGlobalServiceEvents
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
private java.lang.Boolean isMultiRegionTrail
Specifies whether the trail belongs only to one region or exists in all regions.
private java.lang.String homeRegion
The region in which the trail was created.
private java.lang.String trailARN
Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
private java.lang.Boolean logFileValidationEnabled
Specifies whether log file validation is enabled.
private java.lang.String cloudWatchLogsLogGroupArn
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
private java.lang.String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
private java.lang.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
public void setName(java.lang.String name)
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
name
- Name of the trail set by calling CreateTrail. The maximum
length is 128 characters.public java.lang.String getName()
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
public Trail withName(java.lang.String name)
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
name
- Name of the trail set by calling CreateTrail. The maximum
length is 128 characters.public void setS3BucketName(java.lang.String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your
trail files. See Amazon S3 Bucket Naming Requirements.public java.lang.String getS3BucketName()
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
public Trail withS3BucketName(java.lang.String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your
trail files. See Amazon S3 Bucket Naming Requirements.public void setS3KeyPrefix(java.lang.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.
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.public java.lang.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.
public Trail withS3KeyPrefix(java.lang.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.
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.@Deprecated public void setSnsTopicName(java.lang.String snsTopicName)
Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
snsTopicName
- Specifies the name of the Amazon SNS topic that CloudTrail uses to
send notifications when log files are delivered.@Deprecated public java.lang.String getSnsTopicName()
Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
@Deprecated public Trail withSnsTopicName(java.lang.String snsTopicName)
Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
snsTopicName
- Specifies the name of the Amazon SNS topic that CloudTrail uses to
send notifications when log files are delivered.public void setSnsTopicARN(java.lang.String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to
send notifications when log files are delivered. The format of a
topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
public java.lang.String getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
arn:aws:sns:us-east-1:123456789012:MyTopic
public Trail withSnsTopicARN(java.lang.String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to
send notifications when log files are delivered. The format of a
topic ARN is:
arn:aws:sns:us-east-1:123456789012:MyTopic
public void setIncludeGlobalServiceEvents(java.lang.Boolean includeGlobalServiceEvents)
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
includeGlobalServiceEvents
- Set to True to include AWS API calls from AWS global
services such as IAM. Otherwise, False.public java.lang.Boolean getIncludeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
public Trail withIncludeGlobalServiceEvents(java.lang.Boolean includeGlobalServiceEvents)
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
includeGlobalServiceEvents
- Set to True to include AWS API calls from AWS global
services such as IAM. Otherwise, False.public java.lang.Boolean isIncludeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
public void setIsMultiRegionTrail(java.lang.Boolean isMultiRegionTrail)
Specifies whether the trail belongs only to one region or exists in all regions.
isMultiRegionTrail
- Specifies whether the trail belongs only to one region or exists
in all regions.public java.lang.Boolean getIsMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all regions.
public Trail withIsMultiRegionTrail(java.lang.Boolean isMultiRegionTrail)
Specifies whether the trail belongs only to one region or exists in all regions.
isMultiRegionTrail
- Specifies whether the trail belongs only to one region or exists
in all regions.public java.lang.Boolean isMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all regions.
public void setHomeRegion(java.lang.String homeRegion)
The region in which the trail was created.
homeRegion
- The region in which the trail was created.public java.lang.String getHomeRegion()
The region in which the trail was created.
public Trail withHomeRegion(java.lang.String homeRegion)
The region in which the trail was created.
homeRegion
- The region in which the trail was created.public void setTrailARN(java.lang.String trailARN)
Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
trailARN
- Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
public java.lang.String getTrailARN()
Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
public Trail withTrailARN(java.lang.String trailARN)
Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
trailARN
- Specifies the ARN of the trail. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
public void setLogFileValidationEnabled(java.lang.Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
logFileValidationEnabled
- Specifies whether log file validation is enabled.public java.lang.Boolean getLogFileValidationEnabled()
Specifies whether log file validation is enabled.
public Trail withLogFileValidationEnabled(java.lang.Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
logFileValidationEnabled
- Specifies whether log file validation is enabled.public java.lang.Boolean isLogFileValidationEnabled()
Specifies whether log file validation is enabled.
public void setCloudWatchLogsLogGroupArn(java.lang.String cloudWatchLogsLogGroupArn)
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be
delivered.public java.lang.String getCloudWatchLogsLogGroupArn()
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
public Trail withCloudWatchLogsLogGroupArn(java.lang.String cloudWatchLogsLogGroupArn)
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be
delivered.public void setCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to
write to a user's log group.public java.lang.String getCloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
public Trail withCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to
write to a user's log group.public void setKmsKeyId(java.lang.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
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
public java.lang.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
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
public Trail withKmsKeyId(java.lang.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
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
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Trail clone()
clone
in class java.lang.Object