@Generated(value="software.amazon.awssdk:codegen") public final class CreateTrailRequest extends CloudTrailRequest implements ToCopyableBuilder<CreateTrailRequest.Builder,CreateTrailRequest>
Specifies the settings for each trail.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateTrailRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateTrailRequest.Builder |
builder() |
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.
|
String |
cloudWatchLogsRoleArn()
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
|
Boolean |
enableLogFileValidation()
Specifies whether log file integrity validation is enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTagsList()
Returns true if the TagsList property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
Boolean |
includeGlobalServiceEvents()
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.
|
String |
kmsKeyId()
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
|
String |
name()
Specifies the name of the trail.
|
String |
s3BucketName()
Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
String |
s3KeyPrefix()
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
delivery.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateTrailRequest.Builder> |
serializableBuilderClass() |
String |
snsTopicName()
Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
|
List<Tag> |
tagsList()
Returns the value of the TagsList property for this object.
|
CreateTrailRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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)
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 s3BucketName()
Specifies the name of the Amazon S3 bucket designated for publishing log 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()
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
public Boolean includeGlobalServiceEvents()
Specifies whether the trail is publishing events from global services such as IAM to the log files.
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 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.
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 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.
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 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 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 boolean hasTagsList()
public List<Tag> tagsList()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTagsList() to see if a value was sent in this field.
public CreateTrailRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateTrailRequest.Builder,CreateTrailRequest>toBuilder in class CloudTrailRequestpublic static CreateTrailRequest.Builder builder()
public static Class<? extends CreateTrailRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode in class AwsRequestpublic boolean equals(Object obj)
equals in class AwsRequestpublic boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2020. All rights reserved.