public class UpdateTrailRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Specifies settings to update for the trail.
NOOP
Constructor and Description |
---|
UpdateTrailRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateTrailRequest |
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 validation is enabled.
|
Boolean |
getIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services
such as IAM to the log files.
|
Boolean |
getIsMultiRegionTrail()
Specifies whether the trail applies only to the current region or to all
regions.
|
String |
getKmsKeyId()
Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail.
|
String |
getName()
Specifies the name of the trail or trail ARN.
|
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 validation is enabled.
|
Boolean |
isIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services
such as IAM to the log files.
|
Boolean |
isMultiRegionTrail()
Specifies whether the trail applies only to the current region or to all
regions.
|
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 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 |
setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail applies only to the current region or to all
regions.
|
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 or trail ARN.
|
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.
|
UpdateTrailRequest |
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.
|
UpdateTrailRequest |
withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
Specifies the role for the CloudWatch Logs endpoint to assume to write to
a user's log group.
|
UpdateTrailRequest |
withEnableLogFileValidation(Boolean enableLogFileValidation)
Specifies whether log file validation is enabled.
|
UpdateTrailRequest |
withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services
such as IAM to the log files.
|
UpdateTrailRequest |
withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail applies only to the current region or to all
regions.
|
UpdateTrailRequest |
withKmsKeyId(String kmsKeyId)
Specifies the KMS key ID to use to encrypt the logs delivered by
CloudTrail.
|
UpdateTrailRequest |
withName(String name)
Specifies the name of the trail or trail ARN.
|
UpdateTrailRequest |
withS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log
files.
|
UpdateTrailRequest |
withS3KeyPrefix(String s3KeyPrefix)
Specifies the Amazon S3 key prefix that comes after the name of the
bucket you have designated for log file delivery.
|
UpdateTrailRequest |
withSnsTopicName(String snsTopicName)
Specifies the name of the Amazon SNS topic defined for notification of
log file delivery.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setName(String name)
Specifies the name of the trail or trail ARN. If Name
is a
trail name, the string must meet the following requirements:
my-_namespace
and my--namespace
are invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
name
- Specifies the name of the trail or trail ARN. If Name
is a trail name, the string must meet the following
requirements:
my-_namespace
and my--namespace
are
invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
public String getName()
Specifies the name of the trail or trail ARN. If Name
is a
trail name, the string must meet the following requirements:
my-_namespace
and my--namespace
are invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
Name
is a trail name, the string must meet the
following requirements:
my-_namespace
and my--namespace
are
invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
public UpdateTrailRequest withName(String name)
Specifies the name of the trail or trail ARN. If Name
is a
trail name, the string must meet the following requirements:
my-_namespace
and my--namespace
are invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
name
- Specifies the name of the trail or trail ARN. If Name
is a trail name, the string must meet the following
requirements:
my-_namespace
and my--namespace
are
invalid.
If Name
is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
.
public void setS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3BucketName
- Specifies the name of the Amazon S3 bucket designated for
publishing log files. See Amazon S3 Bucket Naming Requirements.public String getS3BucketName()
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
public UpdateTrailRequest withS3BucketName(String s3BucketName)
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
s3BucketName
- Specifies the name of the Amazon S3 bucket designated for
publishing log files. See Amazon S3 Bucket Naming Requirements.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 UpdateTrailRequest 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.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.
snsTopicName
- Specifies the name of the Amazon SNS topic defined for
notification of log file delivery. The maximum length is 256
characters.public String getSnsTopicName()
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
public UpdateTrailRequest withSnsTopicName(String snsTopicName)
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
snsTopicName
- Specifies the name of the Amazon SNS topic defined for
notification of log file delivery. The maximum length is 256
characters.public void setIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global
services such as IAM to the log files.public Boolean getIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.
public UpdateTrailRequest withIncludeGlobalServiceEvents(Boolean includeGlobalServiceEvents)
Specifies whether the trail is publishing events from global services such as IAM to the log files.
includeGlobalServiceEvents
- Specifies whether the trail is publishing events from global
services such as IAM to the log files.public Boolean isIncludeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.
public void setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.
isMultiRegionTrail
- Specifies whether the trail applies only to the current region or
to all regions. The default is false. If the trail exists only in
the current region and this value is set to true, shadow trails
(replications of the trail) will be created in the other regions.
If the trail exists in all regions and this value is set to false,
the trail will remain in the region where it was created, and its
shadow trails in other regions will be deleted.public Boolean getIsMultiRegionTrail()
Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.
public UpdateTrailRequest withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.
isMultiRegionTrail
- Specifies whether the trail applies only to the current region or
to all regions. The default is false. If the trail exists only in
the current region and this value is set to true, shadow trails
(replications of the trail) will be created in the other regions.
If the trail exists in all regions and this value is set to false,
the trail will remain in the region where it was created, and its
shadow trails in other regions will be deleted.public Boolean isMultiRegionTrail()
Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.
public void setEnableLogFileValidation(Boolean enableLogFileValidation)
Specifies whether log file validation is enabled. The default is false.
enableLogFileValidation
- Specifies whether log file validation is enabled. The default is
false. public Boolean getEnableLogFileValidation()
Specifies whether log file validation is enabled. The default is false.
public UpdateTrailRequest withEnableLogFileValidation(Boolean enableLogFileValidation)
Specifies whether log file validation is enabled. The default is false.
enableLogFileValidation
- Specifies whether log file validation is enabled. The default is
false. public Boolean isEnableLogFileValidation()
Specifies whether log file validation is enabled. The default is false.
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.
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.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.
public UpdateTrailRequest 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.
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.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 UpdateTrailRequest 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 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:
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:
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:
Examples:
public UpdateTrailRequest 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:
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:
public String toString()
toString
in class Object
Object.toString()
public UpdateTrailRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.