@Generated(value="software.amazon.awssdk:codegen") public final class Trail extends Object implements StructuredPojo, ToCopyableBuilder<Trail.Builder,Trail>
The settings for a trail.
Modifier and Type | Class and Description |
---|---|
static interface |
Trail.Builder |
Modifier and Type | Method and Description |
---|---|
static Trail.Builder |
builder() |
String |
cloudWatchLogsLogGroupArn()
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail
logs will be delivered.
|
String |
cloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Boolean |
hasCustomEventSelectors()
Specifies if the trail has custom event selectors.
|
int |
hashCode() |
String |
homeRegion()
The region in which the trail was created.
|
Boolean |
includeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such as IAM.
|
Boolean |
isMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all regions.
|
String |
kmsKeyId()
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
Boolean |
logFileValidationEnabled()
Specifies whether log file validation is enabled.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
name()
Name of the trail set by calling CreateTrail.
|
String |
s3BucketName()
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
|
String |
s3KeyPrefix()
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
delivery.
|
static Class<? extends Trail.Builder> |
serializableBuilderClass() |
String |
snsTopicARN()
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are
delivered.
|
String |
snsTopicName()
This field is deprecated.
|
Trail.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
trailARN()
Specifies the ARN of the trail.
|
copy
public String name()
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
public String s3BucketName()
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
public 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.
public String snsTopicName()
This field is deprecated. Use SnsTopicARN.
public 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
arn:aws:sns:us-east-1:123456789012:MyTopic
public Boolean includeGlobalServiceEvents()
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
public Boolean isMultiRegionTrail()
Specifies whether the trail belongs only to one region or exists in all regions.
public String homeRegion()
The region in which the trail was created.
public String trailARN()
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 Boolean logFileValidationEnabled()
Specifies whether log file validation is enabled.
public String cloudWatchLogsLogGroupArn()
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
public String cloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
public 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
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
public Boolean hasCustomEventSelectors()
Specifies if the trail has custom event selectors.
public Trail.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Trail.Builder,Trail>
public static Trail.Builder builder()
public static Class<? extends Trail.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.