@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTrailRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Specifies the settings for each trail.
NOOP
Constructor and Description |
---|
CreateTrailRequest() |
Modifier and Type | Method and Description |
---|---|
CreateTrailRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
Boolean |
getIsMultiRegionTrail()
Specifies whether the trail is created in the current region or in all regions.
|
Boolean |
getIsOrganizationTrail()
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the
current AWS account.
|
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.
|
List<Tag> |
getTagsList() |
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.
|
Boolean |
isMultiRegionTrail()
Specifies whether the trail is created in the current region or in all regions.
|
Boolean |
isOrganizationTrail()
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the
current AWS account.
|
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 |
setIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail is created in the current region or in all regions.
|
void |
setIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the
current AWS account.
|
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.
|
void |
setTagsList(Collection<Tag> tagsList) |
String |
toString()
Returns a string representation of this object.
|
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 |
withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail is created in the current region or in all regions.
|
CreateTrailRequest |
withIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the
current AWS account.
|
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.
|
CreateTrailRequest |
withTagsList(Collection<Tag> tagsList) |
CreateTrailRequest |
withTagsList(Tag... tagsList)
NOTE: This method appends the values to the existing list (if any).
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
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)
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)
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)
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)
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)
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)
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 CreateTrailRequest 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 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.
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 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.
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 CreateTrailRequest 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 is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.
isMultiRegionTrail
- Specifies whether the trail is created in the current region or in all regions. The default is false,
which creates a trail only in the region where you are signed in. As a best practice, consider creating
trails that log events in all regions.public Boolean getIsMultiRegionTrail()
Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.
public CreateTrailRequest withIsMultiRegionTrail(Boolean isMultiRegionTrail)
Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.
isMultiRegionTrail
- Specifies whether the trail is created in the current region or in all regions. The default is false,
which creates a trail only in the region where you are signed in. As a best practice, consider creating
trails that log events in all regions.public Boolean isMultiRegionTrail()
Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.
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.
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.
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.
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.
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.
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.
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.
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.
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 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.
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 CreateTrailRequest 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 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-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
kmsKeyId
- Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
public String getKmsKeyId()
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
Examples:
alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
public CreateTrailRequest withKmsKeyId(String kmsKeyId)
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
kmsKeyId
- Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
12345678-1234-1234-1234-123456789012
public void setIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
isOrganizationTrail
- Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only
for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of
an AWS account that is the master account for an organization in AWS Organizations.public Boolean getIsOrganizationTrail()
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
public CreateTrailRequest withIsOrganizationTrail(Boolean isOrganizationTrail)
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
isOrganizationTrail
- Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only
for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of
an AWS account that is the master account for an organization in AWS Organizations.public Boolean isOrganizationTrail()
Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
public void setTagsList(Collection<Tag> tagsList)
tagsList
- public CreateTrailRequest withTagsList(Tag... tagsList)
NOTE: This method appends the values to the existing list (if any). Use
setTagsList(java.util.Collection)
or withTagsList(java.util.Collection)
if you want to override
the existing values.
tagsList
- public CreateTrailRequest withTagsList(Collection<Tag> tagsList)
tagsList
- public String toString()
toString
in class Object
Object.toString()
public CreateTrailRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.