1. Packages
  2. AWS Native
  3. API Docs
  4. cloudtrail
  5. getTrail

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.106.0 published on Monday, May 20, 2024 by Pulumi

aws-native.cloudtrail.getTrail

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.106.0 published on Monday, May 20, 2024 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.

    Using getTrail

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTrail(args: GetTrailArgs, opts?: InvokeOptions): Promise<GetTrailResult>
    function getTrailOutput(args: GetTrailOutputArgs, opts?: InvokeOptions): Output<GetTrailResult>
    def get_trail(trail_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetTrailResult
    def get_trail_output(trail_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetTrailResult]
    func LookupTrail(ctx *Context, args *LookupTrailArgs, opts ...InvokeOption) (*LookupTrailResult, error)
    func LookupTrailOutput(ctx *Context, args *LookupTrailOutputArgs, opts ...InvokeOption) LookupTrailResultOutput

    > Note: This function is named LookupTrail in the Go SDK.

    public static class GetTrail 
    {
        public static Task<GetTrailResult> InvokeAsync(GetTrailArgs args, InvokeOptions? opts = null)
        public static Output<GetTrailResult> Invoke(GetTrailInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTrailResult> getTrail(GetTrailArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudtrail:getTrail
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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)
    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)
    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)
    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)
    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)
    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)

    getTrail Result

    The following output properties are available:

    AdvancedEventSelectors List<Pulumi.AwsNative.CloudTrail.Outputs.TrailAdvancedEventSelector>
    The advanced event selectors that were used to select events for the data store.
    Arn string
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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.Outputs.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.Outputs.TrailInsightSelector>
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
    IsLogging bool
    Whether the CloudTrail is currently logging AWS API calls.
    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.
    S3BucketName string
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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.
    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 .
    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.Outputs.Tag>
    A custom set of tags (key-value pairs) for this trail.
    AdvancedEventSelectors []TrailAdvancedEventSelector
    The advanced event selectors that were used to select events for the data store.
    Arn string
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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 []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 []TrailInsightSelector
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
    IsLogging bool
    Whether the CloudTrail is currently logging AWS API calls.
    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.
    S3BucketName string
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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.
    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 .
    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.
    advancedEventSelectors List<TrailAdvancedEventSelector>
    The advanced event selectors that were used to select events for the data store.
    arn String
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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.
    isLogging Boolean
    Whether the CloudTrail is currently logging AWS API calls.
    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.
    s3BucketName String
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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.
    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 .
    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.
    advancedEventSelectors TrailAdvancedEventSelector[]
    The advanced event selectors that were used to select events for the data store.
    arn string
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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.
    isLogging boolean
    Whether the CloudTrail is currently logging AWS API calls.
    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.
    s3BucketName string
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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.
    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 .
    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.
    advanced_event_selectors Sequence[TrailAdvancedEventSelector]
    The advanced event selectors that were used to select events for the data store.
    arn str
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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[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.
    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[TrailInsightSelector]
    Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
    is_logging bool
    Whether the CloudTrail is currently logging AWS API calls.
    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_bucket_name str
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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_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 .
    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[root_Tag]
    A custom set of tags (key-value pairs) for this trail.
    advancedEventSelectors List<Property Map>
    The advanced event selectors that were used to select events for the data store.
    arn String
    Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
    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.
    isLogging Boolean
    Whether the CloudTrail is currently logging AWS API calls.
    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.
    s3BucketName String
    Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    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.
    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 .
    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.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TrailAdvancedEventSelector

    FieldSelectors 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 []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 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 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 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 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

    Field 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 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 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 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 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 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

    Type 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 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 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 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 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 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

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

    CloudTrail supports data event logging for Amazon S3 objects, 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 .

    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, 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 .

    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, 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 .

    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, 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 .

    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, 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 .

    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, 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 .

    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

    TrailInsightSelector

    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.106.0 published on Monday, May 20, 2024 by Pulumi