1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudtrail
  5. Trail

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.cloudtrail.Trail

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

Create Trail Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Trail(name: string, args: TrailArgs, opts?: CustomResourceOptions);
@overload
def Trail(resource_name: str,
          args: TrailArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Trail(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          is_logging: Optional[bool] = None,
          s3_bucket_name: Optional[str] = None,
          is_multi_region_trail: Optional[bool] = None,
          is_organization_trail: Optional[bool] = None,
          event_selectors: Optional[Sequence[TrailEventSelectorArgs]] = None,
          include_global_service_events: Optional[bool] = None,
          insight_selectors: Optional[Sequence[TrailInsightSelectorArgs]] = None,
          cloud_watch_logs_role_arn: Optional[str] = None,
          advanced_event_selectors: Optional[Sequence[TrailAdvancedEventSelectorArgs]] = None,
          enable_log_file_validation: Optional[bool] = None,
          kms_key_id: Optional[str] = None,
          cloud_watch_logs_log_group_arn: Optional[str] = None,
          s3_key_prefix: Optional[str] = None,
          sns_topic_name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          trail_name: Optional[str] = None)
func NewTrail(ctx *Context, name string, args TrailArgs, opts ...ResourceOption) (*Trail, error)
public Trail(string name, TrailArgs args, CustomResourceOptions? opts = null)
public Trail(String name, TrailArgs args)
public Trail(String name, TrailArgs args, CustomResourceOptions options)
type: aws-native:cloudtrail:Trail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TrailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TrailArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TrailArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TrailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TrailArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Trail Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Trail resource accepts the following input properties:

IsLogging This property is required. bool
Whether the CloudTrail is currently logging AWS API calls.
S3BucketName This property is required. string
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
AdvancedEventSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.TrailAdvancedEventSelector>
The advanced event selectors that were used to select events for the data store.
CloudWatchLogsLogGroupArn string
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.
CloudWatchLogsRoleArn string
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
EnableLogFileValidation bool
Specifies whether log file validation is enabled. The default is false.
EventSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.TrailEventSelector>
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
IncludeGlobalServiceEvents bool
Specifies whether the trail is publishing events from global services such as IAM to the log files.
InsightSelectors List<Pulumi.AwsNative.CloudTrail.Inputs.TrailInsightSelector>
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
IsMultiRegionTrail bool
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.
IsOrganizationTrail bool
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.
KmsKeyId string
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.
S3KeyPrefix string
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.
SnsTopicName string
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
Tags List<Pulumi.AwsNative.Inputs.Tag>
A custom set of tags (key-value pairs) for this trail.
TrailName string
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)
IsLogging This property is required. bool
Whether the CloudTrail is currently logging AWS API calls.
S3BucketName This property is required. string
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
AdvancedEventSelectors []TrailAdvancedEventSelectorArgs
The advanced event selectors that were used to select events for the data store.
CloudWatchLogsLogGroupArn string
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.
CloudWatchLogsRoleArn string
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
EnableLogFileValidation bool
Specifies whether log file validation is enabled. The default is false.
EventSelectors []TrailEventSelectorArgs
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
IncludeGlobalServiceEvents bool
Specifies whether the trail is publishing events from global services such as IAM to the log files.
InsightSelectors []TrailInsightSelectorArgs
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
IsMultiRegionTrail bool
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.
IsOrganizationTrail bool
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.
KmsKeyId string
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.
S3KeyPrefix string
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.
SnsTopicName string
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
Tags TagArgs
A custom set of tags (key-value pairs) for this trail.
TrailName string
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)
isLogging This property is required. Boolean
Whether the CloudTrail is currently logging AWS API calls.
s3BucketName This property is required. String
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
advancedEventSelectors List<TrailAdvancedEventSelector>
The advanced event selectors that were used to select events for the data store.
cloudWatchLogsLogGroupArn String
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.
cloudWatchLogsRoleArn String
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enableLogFileValidation Boolean
Specifies whether log file validation is enabled. The default is false.
eventSelectors List<TrailEventSelector>
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
includeGlobalServiceEvents Boolean
Specifies whether the trail is publishing events from global services such as IAM to the log files.
insightSelectors List<TrailInsightSelector>
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
isMultiRegionTrail Boolean
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.
isOrganizationTrail Boolean
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.
kmsKeyId String
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.
s3KeyPrefix String
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.
snsTopicName String
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags List<Tag>
A custom set of tags (key-value pairs) for this trail.
trailName String
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)
isLogging This property is required. boolean
Whether the CloudTrail is currently logging AWS API calls.
s3BucketName This property is required. string
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
advancedEventSelectors TrailAdvancedEventSelector[]
The advanced event selectors that were used to select events for the data store.
cloudWatchLogsLogGroupArn string
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.
cloudWatchLogsRoleArn string
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enableLogFileValidation boolean
Specifies whether log file validation is enabled. The default is false.
eventSelectors TrailEventSelector[]
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
includeGlobalServiceEvents boolean
Specifies whether the trail is publishing events from global services such as IAM to the log files.
insightSelectors TrailInsightSelector[]
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
isMultiRegionTrail boolean
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.
isOrganizationTrail boolean
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.
kmsKeyId string
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.
s3KeyPrefix string
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.
snsTopicName string
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags Tag[]
A custom set of tags (key-value pairs) for this trail.
trailName string
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)
is_logging This property is required. bool
Whether the CloudTrail is currently logging AWS API calls.
s3_bucket_name This property is required. str
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
advanced_event_selectors Sequence[TrailAdvancedEventSelectorArgs]
The advanced event selectors that were used to select events for the data store.
cloud_watch_logs_log_group_arn str
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.
cloud_watch_logs_role_arn str
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enable_log_file_validation bool
Specifies whether log file validation is enabled. The default is false.
event_selectors Sequence[TrailEventSelectorArgs]
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
include_global_service_events bool
Specifies whether the trail is publishing events from global services such as IAM to the log files.
insight_selectors Sequence[TrailInsightSelectorArgs]
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
is_multi_region_trail bool
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.
is_organization_trail bool
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.
kms_key_id str
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.
s3_key_prefix str
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.
sns_topic_name str
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags Sequence[TagArgs]
A custom set of tags (key-value pairs) for this trail.
trail_name str
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)
isLogging This property is required. Boolean
Whether the CloudTrail is currently logging AWS API calls.
s3BucketName This property is required. String
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
advancedEventSelectors List<Property Map>
The advanced event selectors that were used to select events for the data store.
cloudWatchLogsLogGroupArn String
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.
cloudWatchLogsRoleArn String
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
enableLogFileValidation Boolean
Specifies whether log file validation is enabled. The default is false.
eventSelectors List<Property Map>
Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
includeGlobalServiceEvents Boolean
Specifies whether the trail is publishing events from global services such as IAM to the log files.
insightSelectors List<Property Map>
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
isMultiRegionTrail Boolean
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.
isOrganizationTrail Boolean
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.
kmsKeyId String
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.
s3KeyPrefix String
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.
snsTopicName String
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
tags List<Property Map>
A custom set of tags (key-value pairs) for this trail.
trailName String
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)

Outputs

All input properties are implicitly available as output properties. Additionally, the Trail resource produces the following output properties:

Arn string
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
Id string
The provider-assigned unique ID for this managed resource.
SnsTopicArn string
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
Arn string
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
Id string
The provider-assigned unique ID for this managed resource.
SnsTopicArn string
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
arn String
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
id String
The provider-assigned unique ID for this managed resource.
snsTopicArn String
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
arn string
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
id string
The provider-assigned unique ID for this managed resource.
snsTopicArn string
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
arn str
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
id str
The provider-assigned unique ID for this managed resource.
sns_topic_arn str
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
arn String
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
id String
The provider-assigned unique ID for this managed resource.
snsTopicArn String
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

TrailAdvancedEventSelector
, TrailAdvancedEventSelectorArgs

FieldSelectors This property is required. List<Pulumi.AwsNative.CloudTrail.Inputs.TrailAdvancedFieldSelector>
Contains all selector statements in an advanced event selector.
Name string
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
FieldSelectors This property is required. []TrailAdvancedFieldSelector
Contains all selector statements in an advanced event selector.
Name string
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
fieldSelectors This property is required. List<TrailAdvancedFieldSelector>
Contains all selector statements in an advanced event selector.
name String
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
fieldSelectors This property is required. TrailAdvancedFieldSelector[]
Contains all selector statements in an advanced event selector.
name string
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
field_selectors This property is required. Sequence[TrailAdvancedFieldSelector]
Contains all selector statements in an advanced event selector.
name str
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
fieldSelectors This property is required. List<Property Map>
Contains all selector statements in an advanced event selector.
name String
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".

TrailAdvancedFieldSelector
, TrailAdvancedFieldSelectorArgs

Field This property is required. string
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
EndsWith List<string>
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
Equals List<string>
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.
NotEndsWith List<string>
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
NotEquals List<string>
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
NotStartsWith List<string>
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
StartsWith List<string>
An operator that includes events that match the first few characters of the event record field specified as the value of Field.
Field This property is required. string
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
EndsWith []string
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
Equals []string
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.
NotEndsWith []string
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
NotEquals []string
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
NotStartsWith []string
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
StartsWith []string
An operator that includes events that match the first few characters of the event record field specified as the value of Field.
field This property is required. String
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
endsWith List<String>
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
equals_ List<String>
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.
notEndsWith List<String>
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
notEquals List<String>
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
notStartsWith List<String>
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
startsWith List<String>
An operator that includes events that match the first few characters of the event record field specified as the value of Field.
field This property is required. string
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
endsWith string[]
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
equals string[]
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.
notEndsWith string[]
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
notEquals string[]
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
notStartsWith string[]
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
startsWith string[]
An operator that includes events that match the first few characters of the event record field specified as the value of Field.
field This property is required. str
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
ends_with Sequence[str]
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
equals Sequence[str]
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.
not_ends_with Sequence[str]
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
not_equals Sequence[str]
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
not_starts_with Sequence[str]
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
starts_with Sequence[str]
An operator that includes events that match the first few characters of the event record field specified as the value of Field.
field This property is required. String
A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
endsWith List<String>
An operator that includes events that match the last few characters of the event record field specified as the value of Field.
equals List<String>
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.
notEndsWith List<String>
An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
notEquals List<String>
An operator that excludes events that match the exact value of the event record field specified as the value of Field.
notStartsWith List<String>
An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
startsWith List<String>
An operator that includes events that match the first few characters of the event record field specified as the value of Field.

TrailDataResource
, TrailDataResourceArgs

Type This property is required. string
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
Values List<string>
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
Type This property is required. string
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
Values []string
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
type This property is required. String
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
values List<String>
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
type This property is required. string
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
values string[]
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
type This property is required. str
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
values Sequence[str]
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
type This property is required. String
The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.
values List<String>
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

TrailEventSelector
, TrailEventSelectorArgs

DataResources List<Pulumi.AwsNative.CloudTrail.Inputs.TrailDataResource>

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

ExcludeManagementEventSources List<string>
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
IncludeManagementEvents bool
Specify if you want your event selector to include management events for your trail.
ReadWriteType Pulumi.AwsNative.CloudTrail.TrailEventSelectorReadWriteType
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.
DataResources []TrailDataResource

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

ExcludeManagementEventSources []string
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
IncludeManagementEvents bool
Specify if you want your event selector to include management events for your trail.
ReadWriteType TrailEventSelectorReadWriteType
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.
dataResources List<TrailDataResource>

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

excludeManagementEventSources List<String>
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
includeManagementEvents Boolean
Specify if you want your event selector to include management events for your trail.
readWriteType TrailEventSelectorReadWriteType
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.
dataResources TrailDataResource[]

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

excludeManagementEventSources string[]
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
includeManagementEvents boolean
Specify if you want your event selector to include management events for your trail.
readWriteType TrailEventSelectorReadWriteType
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.
data_resources Sequence[TrailDataResource]

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

exclude_management_event_sources Sequence[str]
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
include_management_events bool
Specify if you want your event selector to include management events for your trail.
read_write_type TrailEventSelectorReadWriteType
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.
dataResources List<Property Map>

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS 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 AWS CloudTrail in the AWS CloudTrail User Guide .

To log data events for all other resource types including objects stored in directory buckets , you must use AdvancedEventSelectors . You must also use AdvancedEventSelectors if you want to filter on the eventName field.

excludeManagementEventSources List<String>
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 AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.
includeManagementEvents Boolean
Specify if you want your event selector to include management events for your trail.
readWriteType "All" | "ReadOnly" | "WriteOnly"
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.

TrailEventSelectorReadWriteType
, TrailEventSelectorReadWriteTypeArgs

All
All
ReadOnly
ReadOnly
WriteOnly
WriteOnly
TrailEventSelectorReadWriteTypeAll
All
TrailEventSelectorReadWriteTypeReadOnly
ReadOnly
TrailEventSelectorReadWriteTypeWriteOnly
WriteOnly
All
All
ReadOnly
ReadOnly
WriteOnly
WriteOnly
All
All
ReadOnly
ReadOnly
WriteOnly
WriteOnly
ALL
All
READ_ONLY
ReadOnly
WRITE_ONLY
WriteOnly
"All"
All
"ReadOnly"
ReadOnly
"WriteOnly"
WriteOnly

TrailInsightSelector
, TrailInsightSelectorArgs

InsightType string
The type of insight to log on a trail.
InsightType string
The type of insight to log on a trail.
insightType String
The type of insight to log on a trail.
insightType string
The type of insight to log on a trail.
insight_type str
The type of insight to log on a trail.
insightType String
The type of insight to log on a trail.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi