@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Trail extends Object implements Serializable, Cloneable, StructuredPojo
The settings for a trail.
Constructor and Description |
---|
Trail() |
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 |
getHasCustomEventSelectors()
Specifies if the trail has custom event selectors.
|
Boolean |
getHasInsightSelectors()
Specifies whether a trail has insight types specified in an
InsightSelector list. |
String |
getHomeRegion()
The Region in which the trail was created.
|
Boolean |
getIncludeGlobalServiceEvents()
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
|
Boolean |
getIsMultiRegionTrail()
Specifies whether the trail exists only in one Region or exists in all Regions.
|
Boolean |
getIsOrganizationTrail()
Specifies whether the trail is an organization trail.
|
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 |
getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered.
|
String |
getSnsTopicName()
Deprecated.
|
String |
getTrailARN()
Specifies the ARN of the trail.
|
int |
hashCode() |
Boolean |
isHasCustomEventSelectors()
Specifies if the trail has custom event selectors.
|
Boolean |
isHasInsightSelectors()
Specifies whether a trail has insight types specified in an
InsightSelector list. |
Boolean |
isIncludeGlobalServiceEvents()
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
|
Boolean |
isLogFileValidationEnabled()
Specifies whether log file validation is enabled.
|
Boolean |
isMultiRegionTrail()
Specifies whether the trail exists only in one Region or exists in all Regions.
|
Boolean |
isOrganizationTrail()
Specifies whether the trail is an organization trail.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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 |
setHasCustomEventSelectors(Boolean hasCustomEventSelectors)
Specifies if the trail has custom event selectors.
|
void |
setHasInsightSelectors(Boolean hasInsightSelectors)
Specifies whether a trail has insight types specified in an
InsightSelector list. |
void |
setHomeRegion(String homeRegion)
The Region in which the trail was created.
|
void |
setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
|
void |
setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists only in one Region or exists in all Regions.
|
void |
setIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is an organization trail.
|
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 |
setSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered.
|
void |
setSnsTopicName(String snsTopicName)
Deprecated.
|
void |
setTrailARN(String trailARN)
Specifies the ARN of the trail.
|
String |
toString()
Returns a string representation of this object.
|
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 |
withHasCustomEventSelectors(Boolean hasCustomEventSelectors)
Specifies if the trail has custom event selectors.
|
Trail |
withHasInsightSelectors(Boolean hasInsightSelectors)
Specifies whether a trail has insight types specified in an
InsightSelector list. |
Trail |
withHomeRegion(String homeRegion)
The Region in which the trail was created.
|
Trail |
withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
|
Trail |
withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists only in one Region or exists in all Regions.
|
Trail |
withIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is an organization trail.
|
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 |
withSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered.
|
Trail |
withSnsTopicName(String snsTopicName)
Deprecated.
|
Trail |
withTrailARN(String trailARN)
Specifies the ARN of the trail.
|
public void setName(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 String getName()
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
public Trail withName(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(String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket
naming rules.public String getS3BucketName()
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
public Trail withS3BucketName(String s3BucketName)
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket
naming rules.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.
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 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(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(String snsTopicName)
This field is no longer in use. Use SnsTopicARN
.
snsTopicName
- This field is no longer in use. Use SnsTopicARN
.@Deprecated public String getSnsTopicName()
This field is no longer in use. Use SnsTopicARN
.
SnsTopicARN
.@Deprecated public Trail withSnsTopicName(String snsTopicName)
This field is no longer in use. Use SnsTopicARN
.
snsTopicName
- This field is no longer in use. Use SnsTopicARN
.public void setSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
public String getSnsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
arn:aws:sns:us-east-2:123456789012:MyTopic
public Trail withSnsTopicARN(String snsTopicARN)
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
includeGlobalServiceEvents
- Set to True to include Amazon Web Services API calls from Amazon Web Services global services such
as IAM. Otherwise, False.public Boolean getIncludeGlobalServiceEvents()
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
public Trail withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
includeGlobalServiceEvents
- Set to True to include Amazon Web Services API calls from Amazon Web Services global services such
as IAM. Otherwise, False.public Boolean isIncludeGlobalServiceEvents()
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
public void setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists only in one Region or exists in all Regions.
isMultiRegionTrail
- Specifies whether the trail exists only in one Region or exists in all Regions.public Boolean getIsMultiRegionTrail()
Specifies whether the trail exists only in one Region or exists in all Regions.
public Trail withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail exists only in one Region or exists in all Regions.
isMultiRegionTrail
- Specifies whether the trail exists only in one Region or exists in all Regions.public Boolean isMultiRegionTrail()
Specifies whether the trail exists only in one Region or exists in all Regions.
public void setHomeRegion(String homeRegion)
The Region in which the trail was created.
homeRegion
- The Region in which the trail was created.public String getHomeRegion()
The Region in which the trail was created.
public Trail withHomeRegion(String homeRegion)
The Region in which the trail was created.
homeRegion
- The Region in which the trail was created.public void setTrailARN(String trailARN)
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
trailARN
- Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
public String getTrailARN()
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
public Trail withTrailARN(String trailARN)
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
trailARN
- Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
public void setLogFileValidationEnabled(Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
logFileValidationEnabled
- Specifies whether log file validation is enabled.public Boolean getLogFileValidationEnabled()
Specifies whether log file validation is enabled.
public Trail withLogFileValidationEnabled(Boolean logFileValidationEnabled)
Specifies whether log file validation is enabled.
logFileValidationEnabled
- Specifies whether log file validation is enabled.public Boolean isLogFileValidationEnabled()
Specifies whether log file validation is enabled.
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.
cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which
CloudTrail logs will be delivered.public 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(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(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 String getCloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
public Trail withCloudWatchLogsRoleArn(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(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 following format.
arn:aws:kms:us-east-2: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 following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
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 following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
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 following format.
arn:aws:kms:us-east-2: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 following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
public void setHasCustomEventSelectors(Boolean hasCustomEventSelectors)
Specifies if the trail has custom event selectors.
hasCustomEventSelectors
- Specifies if the trail has custom event selectors.public Boolean getHasCustomEventSelectors()
Specifies if the trail has custom event selectors.
public Trail withHasCustomEventSelectors(Boolean hasCustomEventSelectors)
Specifies if the trail has custom event selectors.
hasCustomEventSelectors
- Specifies if the trail has custom event selectors.public Boolean isHasCustomEventSelectors()
Specifies if the trail has custom event selectors.
public void setHasInsightSelectors(Boolean hasInsightSelectors)
Specifies whether a trail has insight types specified in an InsightSelector
list.
hasInsightSelectors
- Specifies whether a trail has insight types specified in an InsightSelector
list.public Boolean getHasInsightSelectors()
Specifies whether a trail has insight types specified in an InsightSelector
list.
InsightSelector
list.public Trail withHasInsightSelectors(Boolean hasInsightSelectors)
Specifies whether a trail has insight types specified in an InsightSelector
list.
hasInsightSelectors
- Specifies whether a trail has insight types specified in an InsightSelector
list.public Boolean isHasInsightSelectors()
Specifies whether a trail has insight types specified in an InsightSelector
list.
InsightSelector
list.public void setIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is an organization trail.
isOrganizationTrail
- Specifies whether the trail is an organization trail.public Boolean getIsOrganizationTrail()
Specifies whether the trail is an organization trail.
public Trail withIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is an organization trail.
isOrganizationTrail
- Specifies whether the trail is an organization trail.public Boolean isOrganizationTrail()
Specifies whether the trail is an organization trail.
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.