String resourceId
Specifies the ARN of the trail, event data store, or channel to which one or more tags will be added.
The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The format of an event data store ARN is:
arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The format of a channel ARN is: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
SdkInternalList<T> tagsList
Contains a list of tags, up to a limit of 50
String name
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
SdkInternalList<T> fieldSelectors
Contains all selector statements in an advanced event selector.
String field
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for selecting events as filtering is not supported.
For CloudTrail event records, supported fields include readOnly, eventCategory,
eventSource (for management events), eventName, resources.type, and
resources.ARN.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
the only supported field is eventCategory.
readOnly - Optional. Can be set to Equals a value of true or
false. If you do not add this field, CloudTrail logs both read and write
events. A value of true logs only read events. A value of false logs only
write events.
eventSource - For filtering management events only. This can be set only to
NotEquals kms.amazonaws.com.
eventName - Can use any operator. You can use it to filter in or filter out any data event
logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple
values for this field, separated by commas.
eventCategory - This is required and must be set to Equals.
For CloudTrail event records, the value must be Management or Data.
For Config configuration items, the value must be ConfigurationItem.
For Audit Manager evidence, the value must be Evidence.
For non-Amazon Web Services events, the value must be ActivityAuditLog.
resources.type - This field is required for CloudTrail data events.
resources.type can only use the Equals operator, and the value can be one of the
following:
AWS::CloudTrail::Channel
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
AWS::FinSpace::Environment
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
You can have only one resources.type field per selector. To log data events on more than one resource
type, add another selector.
resources.ARN - You can use any operator with resources.ARN, but if you use
Equals or NotEquals, the value must exactly match the ARN of a valid resource of the
type you've specified in the template as the value of resources.type. For example, if resources.type equals
AWS::S3::Object, the ARN must be in one of the following formats. To log all data events for all
objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the
matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::S3::AccessPoint, and the operator is set to
Equals or NotEquals, the ARN must be in one of the following formats. To log events on
all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object
path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or
NotEquals, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or
NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::CloudTrail::Channel, and the operator is set to Equals
or NotEquals, the ARN must be in the following format:
arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals AWS::S3Outposts::Object, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::ManagedBlockchain::Node, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::S3ObjectLambda::AccessPoint, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::EC2::Snapshot, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::DynamoDB::Stream, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type equals AWS::Glue::Table, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When resources.type equals AWS::FinSpace::Environment, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator
is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to
Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
SdkInternalList<T> equals
An operator that includes events that match the exact value of the event record field specified as the value of
Field. This is the only valid operator that you can use with the readOnly,
eventCategory, and resources.type fields.
SdkInternalList<T> startsWith
An operator that includes events that match the first few characters of the event record field specified as the
value of Field.
SdkInternalList<T> endsWith
An operator that includes events that match the last few characters of the event record field specified as the
value of Field.
SdkInternalList<T> notEquals
An operator that excludes events that match the exact value of the event record field specified as the value of
Field.
SdkInternalList<T> notStartsWith
An operator that excludes events that match the first few characters of the event record field specified as the
value of Field.
SdkInternalList<T> notEndsWith
An operator that excludes events that match the last few characters of the event record field specified as the
value of Field.
String channelArn
The Amazon Resource Name (ARN) of a channel.
String name
The name of the CloudTrail channel. For service-linked channels, the name is
aws-service-channel/service-name/custom-suffix where service-name represents the name
of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
created by the Amazon Web Services service.
String name
The name of the channel.
String source
The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.
A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner
event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.
SdkInternalList<T> destinations
One or more event data stores to which events arriving through a channel will be logged.
SdkInternalList<T> tags
String channelArn
The Amazon Resource Name (ARN) of the new channel.
String name
The name of the new channel.
String source
The partner or external event source name.
SdkInternalList<T> destinations
The event data stores that log the events arriving through the channel.
SdkInternalList<T> tags
String name
The name of the event data store.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.
For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.
Boolean multiRegionEnabled
Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.
Boolean organizationEnabled
Specifies whether an event data store collects events logged for an organization in Organizations.
Integer retentionPeriod
The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years.
Boolean terminationProtectionEnabled
Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
SdkInternalList<T> tagsList
String kmsKeyId
Specifies the KMS key ID to use to encrypt the events 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.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
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
String eventDataStoreArn
The ARN of the event data store.
String name
The name of the event data store.
String status
The status of event data store creation.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that were used to select the events for the data store.
Boolean multiRegionEnabled
Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
Boolean organizationEnabled
Indicates whether an event data store is collecting logged events for an organization in Organizations.
Integer retentionPeriod
The retention period of an event data store, in days.
Boolean terminationProtectionEnabled
Indicates whether termination protection is enabled for the event data store.
SdkInternalList<T> tagsList
Date createdTimestamp
The timestamp that shows when the event data store was created.
Date updatedTimestamp
The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is
always either the same or newer than the time shown in CreatedTimestamp.
String kmsKeyId
Specifies the KMS key ID that encrypts the events 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
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 not valid.
Not be in IP address format (for example, 192.168.5.4)
String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
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.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
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. 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.
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 does 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.
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. You must use a log group that exists in your account.
Not required unless you specify CloudWatchLogsRoleArn.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.
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.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
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
Boolean isOrganizationTrail
Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.
SdkInternalList<T> tagsList
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. For more information, see Finding Your CloudTrail Log Files.
String snsTopicName
This field is no longer in use. Use SnsTopicARN.
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-2:123456789012:MyTopic
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 exists in one region or in all regions.
String trailARN
Specifies the ARN of the trail that was created. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Boolean logFileValidationEnabled
Specifies whether log file integrity validation is enabled.
String cloudWatchLogsLogGroupArn
Specifies the Amazon Resource Name (ARN) of 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.
String kmsKeyId
Specifies the KMS key ID that encrypts the events 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
Boolean isOrganizationTrail
Specifies whether the trail is an organization trail.
String type
The resource type in which you want to log data events. You can specify the following basic event selector resource types:
AWS::S3::Object
AWS::Lambda::Function
AWS::DynamoDB::Table
The following resource types are also available through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field.
AWS::CloudTrail::Channel
AWS::S3Outposts::Object
AWS::ManagedBlockchain::Node
AWS::S3ObjectLambda::AccessPoint
AWS::EC2::Snapshot
AWS::S3::AccessPoint
AWS::DynamoDB::Stream
AWS::Glue::Table
AWS::FinSpace::Environment
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
SdkInternalList<T> values
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as
arn:aws:s3.
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such as
arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that
match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as
arn:aws:lambda.
This also enables logging of Invoke activity performed by any user or role in your Amazon Web
Services account, even if that activity is performed on a function that belongs to another Amazon Web Services
account.
To log data events for a specific Lambda function, specify the function ARN.
Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as
arn:aws:dynamodb.
String channel
The ARN or the UUID value of the channel that you want to delete.
String eventDataStore
The ARN (or the ID suffix of the ARN) of the event data store to delete.
String resourceArn
The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. The
following is the format of a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.
String name
Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String delegatedAdminAccountId
A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.
String queryId
The ID of the query.
String queryString
The SQL code of a query.
String queryStatus
The status of a query. Values for QueryStatus include QUEUED, RUNNING,
FINISHED, FAILED, TIMED_OUT, or CANCELLED
QueryStatisticsForDescribeQuery queryStatistics
Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
String errorMessage
The error message returned if a query failed.
String deliveryS3Uri
The URI for the S3 bucket where CloudTrail delivered query results, if applicable.
String deliveryStatus
The delivery status.
SdkInternalList<T> trailNameList
Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
If an empty list is specified, information for the trail in the current region is returned.
If an empty list is specified and IncludeShadowTrails is false, then information for all trails in
the current region is returned.
If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.
If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region and current account. To return information about a trail in another region, you must specify its trail ARN.
Boolean includeShadowTrails
Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.
SdkInternalList<T> trailList
The list of trail objects. Trail objects with string values are only returned if values for the objects exist in
a trail's configuration. For example, SNSTopicName and SNSTopicARN are only returned in
results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in
results if a trail's log files are encrypted with KMS customer managed keys.
String type
The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration,
the value is EventDataStore. For service-linked channels, the value is AWS_SERVICE.
String location
For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.
String eventId
The CloudTrail ID of the event returned.
String eventName
The name of the event returned.
String readOnly
Information about whether the event is a write event or a read event.
String accessKeyId
The Amazon Web Services access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.
Date eventTime
The date and time of the event returned.
String eventSource
The Amazon Web Services service to which the request was made.
String username
A user name or role name of the requester that called the API in the event returned.
SdkInternalList<T> resources
A list of resources referenced by the event returned.
String cloudTrailEvent
A JSON string that contains a representation of the event returned.
String eventDataStoreArn
The ARN of the event data store.
String name
The name of the event data store.
Boolean terminationProtectionEnabled
Indicates whether the event data store is protected from termination.
String status
The status of an event data store. Values are ENABLED and PENDING_DELETION.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that were used to select events for the data store.
Boolean multiRegionEnabled
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
Boolean organizationEnabled
Indicates that an event data store is collecting logged events for an organization.
Integer retentionPeriod
The retention period, in days.
Date createdTimestamp
The timestamp of the event data store's creation.
Date updatedTimestamp
The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is
always either the same or newer than the time shown in CreatedTimestamp.
String readWriteType
Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2
GetConsoleOutput is a read-only API operation and RunInstances is a write-only API
operation.
By default, the value is All.
Boolean includeManagementEvents
Specify if you want your event selector to include management events for your trail.
For more information, see Management Events in the CloudTrail User Guide.
By default, the value is true.
The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing.
SdkInternalList<T> dataResources
CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.
SdkInternalList<T> excludeManagementEventSources
An optional list of service event sources from which you do not want management events to be logged on your
trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service
or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com.
By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are
logged to your trail. You can exclude management event sources only in regions that support the event source.
String channel
The ARN or UUID of a channel.
String channelArn
The ARN of an channel returned by a GetChannel request.
String name
The name of the CloudTrail channel. For service-linked channels, the name is
aws-service-channel/service-name/custom-suffix where service-name represents the name
of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
generated by the Amazon Web Services service.
String source
The source for the CloudTrail channel.
SourceConfig sourceConfig
Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all regions or a single region.
SdkInternalList<T> destinations
The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.
IngestionStatus ingestionStatus
A table showing information about the most recent successful and failed attempts to ingest events.
String eventDataStore
The ARN (or ID suffix of the ARN) of the event data store about which you want information.
String eventDataStoreArn
The event data store Amazon Resource Number (ARN).
String name
The name of the event data store.
String status
The status of an event data store. Values can be ENABLED and PENDING_DELETION.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors used to select events for the data store.
Boolean multiRegionEnabled
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
Boolean organizationEnabled
Indicates whether an event data store is collecting logged events for an organization in Organizations.
Integer retentionPeriod
The retention period of the event data store, in days.
Boolean terminationProtectionEnabled
Indicates that termination protection is enabled.
Date createdTimestamp
The timestamp of the event data store's creation.
Date updatedTimestamp
Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always
either the same or newer than the time shown in CreatedTimestamp.
String kmsKeyId
Specifies the KMS key ID that encrypts the events 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
String trailName
Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String trailARN
The specified trail ARN that has the event selectors.
SdkInternalList<T> eventSelectors
The event selectors that are configured for the trail.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that are configured for the trail.
String importId
The ID for the import.
String importId
The ID of the import.
SdkInternalList<T> destinations
The ARN of the destination event data store.
ImportSource importSource
The source S3 bucket.
Date startEventTime
Used with EndEventTime to bound a StartImport request, and limit imported trail events
to only those events logged within a specified time period.
Date endEventTime
Used with StartEventTime to bound a StartImport request, and limit imported trail
events to only those events logged within a specified time period.
String importStatus
The status of the import.
Date createdTimestamp
The timestamp of the import's creation.
Date updatedTimestamp
The timestamp of when the import was updated.
ImportStatistics importStatistics
Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values
for parameters such as EventsCompleted may be lower than the actual value, because CloudTrail
updates statistics incrementally over the course of the import.
String trailName
Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String trailARN
The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.
SdkInternalList<T> insightSelectors
A JSON string that contains the insight types you want to log on a trail. In this release,
ApiErrorRateInsight and ApiCallRateInsight are supported as insight types.
String eventDataStore
The ARN (or ID suffix of the ARN) of the event data store against which the query was run.
String queryId
The ID of the query for which you want to get results.
String nextToken
A token you can use to get the next page of query results.
Integer maxQueryResults
The maximum number of query results to display on a single page.
String queryStatus
The status of the query. Values include QUEUED, RUNNING, FINISHED,
FAILED, TIMED_OUT, or CANCELLED.
QueryStatistics queryStatistics
Shows the count of query results.
SdkInternalList<T> queryResultRows
Contains the individual event results of the query.
String nextToken
A token you can use to get the next page of query results.
String errorMessage
The error message returned if a query failed.
String resourceArn
The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is
the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.
String name
The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.
Trail trail
String name
Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Boolean isLogging
Whether the CloudTrail trail is currently logging Amazon Web Services API calls.
String latestDeliveryError
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests
that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the
new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.
String latestNotificationError
Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.
Date latestDeliveryTime
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
Date latestNotificationTime
Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.
Date startLoggingTime
Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.
Date stopLoggingTime
Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.
String latestCloudWatchLogsDeliveryError
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
Date latestCloudWatchLogsDeliveryTime
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
Date latestDigestDeliveryTime
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
String latestDigestDeliveryError
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests
that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the
new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.
String latestDeliveryAttemptTime
This field is no longer in use.
String latestNotificationAttemptTime
This field is no longer in use.
String latestNotificationAttemptSucceeded
This field is no longer in use.
String latestDeliveryAttemptSucceeded
This field is no longer in use.
String timeLoggingStarted
This field is no longer in use.
String timeLoggingStopped
This field is no longer in use.
String location
The location of the failure in the S3 bucket.
String status
The status of the import.
String errorType
The type of import error.
String errorMessage
Provides the reason the import failed.
Date lastUpdatedTime
When the import was last updated.
String importId
The ID of the import.
String importStatus
The status of the import.
SdkInternalList<T> destinations
The ARN of the destination event data store.
Date createdTimestamp
The timestamp of the import's creation.
Date updatedTimestamp
The timestamp of the import's last update.
S3ImportSource s3
The source S3 bucket.
Long prefixesFound
The number of S3 prefixes found for the import.
Long prefixesCompleted
The number of S3 prefixes that completed import.
Long filesCompleted
The number of log files that completed import.
Long eventsCompleted
The number of trail events imported into the event data store.
Long failedEntries
The number of failed entries.
Date latestIngestionSuccessTime
The time stamp of the most recent successful ingestion of events for the channel.
String latestIngestionSuccessEventID
The event ID of the most recent successful ingestion of events.
String latestIngestionErrorCode
The error code for the most recent failure to ingest events.
Date latestIngestionAttemptTime
The time stamp of the most recent attempt to ingest events on the channel.
String latestIngestionAttemptEventID
The event ID of the most recent attempt to ingest events.
String insightType
The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are
valid insight types.
Integer maxResults
The maximum number of CloudTrail channels to display on a single page.
String nextToken
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
SdkInternalList<T> channels
The list of channels in the account.
String nextToken
The token to use to get the next page of results after a previous API call.
SdkInternalList<T> eventDataStores
Contains information about event data stores in the account, in the current region.
String nextToken
A token you can use to get the next page of results.
SdkInternalList<T> failures
Contains information about the import failures.
String nextToken
A token you can use to get the next page of results.
Integer maxResults
The maximum number of imports to display on a single page.
String destination
The ARN of the destination event data store.
String importStatus
The status of the import.
String nextToken
A token you can use to get the next page of import results.
SdkInternalList<T> imports
The list of returned imports.
String nextToken
A token you can use to get the next page of import results.
Date startTime
Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
Date endTime
Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
String nextToken
Reserved for future use.
SdkInternalList<T> publicKeyList
Contains an array of PublicKey objects.
The returned public keys may have validity time ranges that overlap.
String nextToken
Reserved for future use.
String eventDataStore
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
String nextToken
A token you can use to get the next page of results.
Integer maxResults
The maximum number of queries to show on a page.
Date startTime
Use with EndTime to bound a ListQueries request, and limit its results to only those
queries run within a specified time period.
Date endTime
Use with StartTime to bound a ListQueries request, and limit its results to only those
queries run within a specified time period.
String queryStatus
The status of queries that you want to return in results. Valid values for QueryStatus include
QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or
CANCELLED.
SdkInternalList<T> queries
Lists matching query results, and shows query ID, status, and creation time of each query.
String nextToken
A token you can use to get the next page of results.
SdkInternalList<T> resourceIdList
Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.
String nextToken
Reserved for future use.
SdkInternalList<T> resourceTagList
A list of resource tags.
String nextToken
Reserved for future use.
String nextToken
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
SdkInternalList<T> trails
Returns the name, ARN, and home region of trails in the current account.
String nextToken
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
SdkInternalList<T> lookupAttributes
Contains a list of lookup attributes. Currently the list can contain only one item.
Date startTime
Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
Date endTime
Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
String eventCategory
Specifies the event category. If you do not specify an event category, events of the category are not returned in
the response. For example, if you do not specify insight as the value of EventCategory,
no Insights events are returned.
Integer maxResults
The number of events to return. Possible values are 1 through 50. The default is 50.
String nextToken
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
SdkInternalList<T> events
A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.
String nextToken
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
ByteBuffer value
The DER encoded public key value in PKCS#1 format.
Date validityStartTime
The starting time of validity of the public key.
Date validityEndTime
The ending time of validity of the public key.
String fingerprint
The fingerprint of the public key.
String trailName
Specifies the name of the trail or trail ARN. If you specify a trail name, the string 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the following format.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
SdkInternalList<T> eventSelectors
Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You
can use either EventSelectors or AdvancedEventSelectors in a
PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any
existing AdvancedEventSelectors are overwritten.
SdkInternalList<T> advancedEventSelectors
Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for
your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can
use either AdvancedEventSelectors or EventSelectors, but not both. If you apply
AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For
more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.
String trailARN
Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
SdkInternalList<T> eventSelectors
Specifies the event selectors configured for your trail.
SdkInternalList<T> advancedEventSelectors
Specifies the advanced event selectors configured for your trail.
String trailName
The name of the CloudTrail trail for which you want to change or add Insights selectors.
SdkInternalList<T> insightSelectors
A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and
ApiErrorRateInsight are valid insight types.
String trailARN
The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.
SdkInternalList<T> insightSelectors
A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights types in
this release are ApiErrorRateInsight and ApiCallRateInsight.
String resourceArn
The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is
the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.
String resourcePolicy
A JSON-formatted string for an Amazon Web Services resource-based policy.
The following are requirements for the resource policy:
Contains only one action: cloudtrail-data:PutAuditEvents
Contains at least one statement. The policy can have a maximum of 20 statements.
Each statement contains at least one principal. A statement can have a maximum of 50 principals.
Integer resultsCount
The number of results returned.
Integer totalResultsCount
The total number of results returned by a query.
Long bytesScanned
The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.
Long eventsMatched
The number of events that matched a query.
Long eventsScanned
The number of events that the query scanned in the event data store.
Long bytesScanned
The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.
Integer executionTimeInMillis
The query's run time, in milliseconds.
Date creationTime
The creation time of the query.
String memberAccountId
An organization member account ID that you want to designate as a delegated administrator.
String resourceId
Specifies the ARN of the trail, event data store, or channel from which tags should be removed.
Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
SdkInternalList<T> tagsList
Specifies a list of tags to be removed.
String resourceType
The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.
String resourceName
The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.
String resourceId
Specifies the ARN of the resource.
SdkInternalList<T> tagsList
A list of tags.
String eventDataStore
The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.
String eventDataStoreArn
The event data store ARN.
String name
The name of the event data store.
String status
The status of the event data store.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that were used to select events.
Boolean multiRegionEnabled
Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data store was created.
Boolean organizationEnabled
Indicates whether an event data store is collecting logged events for an organization in Organizations.
Integer retentionPeriod
The retention period, in days.
Boolean terminationProtectionEnabled
Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
Date createdTimestamp
The timestamp of an event data store's creation.
Date updatedTimestamp
The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is
always either the same or newer than the time shown in CreatedTimestamp.
String kmsKeyId
Specifies the KMS key ID that encrypts the events 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
Boolean applyToAllRegions
Specifies whether the channel applies to a single region or to all regions.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that are configured for the channel.
SdkInternalList<T> destinations
The ARN of the destination event data store. Use this parameter for a new import.
ImportSource importSource
The source S3 bucket for the import. Use this parameter for a new import.
Date startEventTime
Use with EndEventTime to bound a StartImport request, and limit imported trail events
to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the
prefix and log file names to verify the names contain a date between the specified StartEventTime
and EndEventTime before attempting to import events.
Date endEventTime
Use with StartEventTime to bound a StartImport request, and limit imported trail events
to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the
prefix and log file names to verify the names contain a date between the specified StartEventTime
and EndEventTime before attempting to import events.
String importId
The ID of the import. Use this parameter when you are retrying an import.
String importId
The ID of the import.
SdkInternalList<T> destinations
The ARN of the destination event data store.
ImportSource importSource
The source S3 bucket for the import.
Date startEventTime
Used with EndEventTime to bound a StartImport request, and limit imported trail events
to only those events logged within a specified time period.
Date endEventTime
Used with StartEventTime to bound a StartImport request, and limit imported trail
events to only those events logged within a specified time period.
String importStatus
Shows the status of the import after a StartImport request. An import finishes with a status of
COMPLETED if there were no failures, or FAILED if there were failures.
Date createdTimestamp
The timestamp for the import's creation.
Date updatedTimestamp
The timestamp of the import's last update, if applicable.
String name
Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String queryId
The ID of the started query.
String importId
The ID of the import.
String importId
The ID for the import.
ImportSource importSource
The source S3 bucket for the import.
SdkInternalList<T> destinations
The ARN of the destination event data store.
String importStatus
The status of the import.
Date createdTimestamp
The timestamp of the import's creation.
Date updatedTimestamp
The timestamp of the import's last update.
Date startEventTime
Used with EndEventTime to bound a StartImport request, and limit imported trail events
to only those events logged within a specified time period.
Date endEventTime
Used with StartEventTime to bound a StartImport request, and limit imported trail
events to only those events logged within a specified time period.
ImportStatistics importStatistics
Returns information on the stopped import.
String name
Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String name
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
String s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
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.
String snsTopicName
This field is no longer in use. Use SnsTopicARN.
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
Boolean includeGlobalServiceEvents
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
Boolean isMultiRegionTrail
Specifies whether the trail exists only in one region or exists in all regions.
String homeRegion
The region in which the trail was created.
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
Boolean logFileValidationEnabled
Specifies whether log file validation is enabled.
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.
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
Boolean hasCustomEventSelectors
Specifies if the trail has custom event selectors.
Boolean hasInsightSelectors
Specifies whether a trail has insight types specified in an InsightSelector list.
Boolean isOrganizationTrail
Specifies whether the trail is an organization trail.
String channel
The ARN or ID (the ARN suffix) of the channel that you want to update.
SdkInternalList<T> destinations
The ARNs of event data stores that you want to log events arriving through the channel.
String name
Changes the name of the channel.
String channelArn
The ARN of the channel that was updated.
String name
The name of the channel that was updated.
String source
The event source of the channel that was updated.
SdkInternalList<T> destinations
The event data stores that log events arriving through the channel.
String eventDataStore
The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
String name
The event data store name.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.
Boolean multiRegionEnabled
Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
Boolean organizationEnabled
Specifies whether an event data store collects events logged for an organization in Organizations.
Integer retentionPeriod
The retention period, in days.
Boolean terminationProtectionEnabled
Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
String kmsKeyId
Specifies the KMS key ID to use to encrypt the events 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.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
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
String eventDataStoreArn
The ARN of the event data store.
String name
The name of the event data store.
String status
The status of an event data store. Values can be ENABLED and PENDING_DELETION.
SdkInternalList<T> advancedEventSelectors
The advanced event selectors that are applied to the event data store.
Boolean multiRegionEnabled
Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
Boolean organizationEnabled
Indicates whether an event data store is collecting logged events for an organization in Organizations.
Integer retentionPeriod
The retention period, in days.
Boolean terminationProtectionEnabled
Indicates whether termination protection is enabled for the event data store.
Date createdTimestamp
The timestamp that shows when an event data store was first created.
Date updatedTimestamp
The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always
either the same or newer than the time shown in CreatedTimestamp.
String kmsKeyId
Specifies the KMS key ID that encrypts the events 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
String name
Specifies the name of the trail or trail ARN. If Name is a trail name, the string 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
If Name is a trail ARN, it must be in the following format.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
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.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
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 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. As a best practice, consider using trails that log events in all regions.
Boolean enableLogFileValidation
Specifies whether log file 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 does 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.
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 are delivered. You must use a log group that exists in your account.
Not required unless you specify CloudWatchLogsRoleArn.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.
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.
CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
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
Boolean isOrganizationTrail
Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the
current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf
of an Amazon Web Services account that is the management account or delegated administrator account for an
organization in Organizations. If the trail is not an organization trail and this is set to true,
the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an
organization trail and this is set to false, the trail will remain in the current Amazon Web
Services account but be deleted from all member accounts in the organization.
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. For more information, see Finding Your IAM Log Files.
String snsTopicName
This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.
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
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 exists in one region or in all regions.
String trailARN
Specifies the ARN of the trail that was updated. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Boolean logFileValidationEnabled
Specifies whether log file integrity validation is enabled.
String cloudWatchLogsLogGroupArn
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs are delivered.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
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
Boolean isOrganizationTrail
Specifies whether the trail is an organization trail.
Copyright © 2023. All rights reserved.