TrailState class

Input properties used for looking up and filtering Trail resources.

Constructors

TrailState({Input<List<TrailAdvancedEventSelector>?>? advancedEventSelectors, Input<String?>? arn, Input<String?>? cloudWatchLogsGroupArn, Input<String?>? cloudWatchLogsRoleArn, Input<bool?>? enableLogFileValidation, Input<bool?>? enableLogging, Input<List<TrailEventSelector>?>? eventSelectors, Input<String?>? homeRegion, Input<bool?>? includeGlobalServiceEvents, Input<List<TrailInsightSelector>?>? insightSelectors, Input<bool?>? isMultiRegionTrail, Input<bool?>? isOrganizationTrail, Input<String?>? kmsKeyId, Input<String?>? name, Input<String?>? region, Input<String?>? s3BucketName, Input<String?>? s3KeyPrefix, Input<String?>? snsTopicArn, Input<String?>? snsTopicName, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new TrailState. advancedEventSelectors Specifies an advanced event selector for enabling data event logging. Fields documented below. Conflicts with eventSelector. arn ARN of the trail. cloudWatchLogsGroupArn Log group name using an ARN that represents the log group to which CloudTrail logs will be delivered. Note that CloudTrail requires the Log Stream wildcard. cloudWatchLogsRoleArn Role for the CloudWatch Logs endpoint to assume to write to a user’s log group. enableLogFileValidation Whether log file integrity validation is enabled. Defaults to false. enableLogging Enables logging for the trail. When set to true, logging is started by calling the StartLogging API. When set to false, logging is stopped by calling the StopLogging API. Defaults to true. eventSelectors Specifies an event selector for enabling data event logging. Fields documented below. Please note the CloudTrail limits when configuring these. Conflicts with advancedEventSelector. homeRegion Region in which the trail was created. includeGlobalServiceEvents Whether the trail is publishing events from global services such as IAM to the log files. Defaults to true. insightSelectors Configuration block for identifying unusual operational activity. See details below. isMultiRegionTrail Whether the trail is created in the current region or in all regions. Defaults to false. isOrganizationTrail Whether the trail is an AWS Organizations trail. Organization trails log events for the master account and all member accounts. Can only be created in the organization master account. Defaults to false. kmsKeyId KMS key ARN to use to encrypt the logs delivered by CloudTrail. name Name of the trail. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. s3BucketName Name of the S3 bucket designated for publishing log files. s3KeyPrefix S3 key prefix that follows the name of the bucket you have designated for log file delivery. snsTopicArn ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. snsTopicName Name of the Amazon SNS topic defined for notification of log file delivery. Specify the SNS topic ARN if it resides in another region. tags Map of tags to assign to the trail. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
const
TrailState.fromMap(Map<String, dynamic> map)
factory

Properties

advancedEventSelectors → Input<List<TrailAdvancedEventSelector>?>?
Specifies an advanced event selector for enabling data event logging. Fields documented below. Conflicts with eventSelector.
final
arn → Input<String?>?
ARN of the trail.
final
cloudWatchLogsGroupArn → Input<String?>?
Log group name using an ARN that represents the log group to which CloudTrail logs will be delivered. Note that CloudTrail requires the Log Stream wildcard.
final
cloudWatchLogsRoleArn → Input<String?>?
Role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
final
enableLogFileValidation → Input<bool?>?
Whether log file integrity validation is enabled. Defaults to false.
final
enableLogging → Input<bool?>?
Enables logging for the trail. When set to true, logging is started by calling the StartLogging API. When set to false, logging is stopped by calling the StopLogging API. Defaults to true.
final
eventSelectors → Input<List<TrailEventSelector>?>?
Specifies an event selector for enabling data event logging. Fields documented below. Please note the CloudTrail limits when configuring these. Conflicts with advancedEventSelector.
final
hashCode → int
The hash code for this object.
no setterinherited
homeRegion → Input<String?>?
Region in which the trail was created.
final
includeGlobalServiceEvents → Input<bool?>?
Whether the trail is publishing events from global services such as IAM to the log files. Defaults to true.
final
insightSelectors → Input<List<TrailInsightSelector>?>?
Configuration block for identifying unusual operational activity. See details below.
final
isMultiRegionTrail → Input<bool?>?
Whether the trail is created in the current region or in all regions. Defaults to false.
final
isOrganizationTrail → Input<bool?>?
Whether the trail is an AWS Organizations trail. Organization trails log events for the master account and all member accounts. Can only be created in the organization master account. Defaults to false.
final
kmsKeyId → Input<String?>?
KMS key ARN to use to encrypt the logs delivered by CloudTrail.
final
name → Input<String?>?
Name of the trail.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3BucketName → Input<String?>?
Name of the S3 bucket designated for publishing log files.
final
s3KeyPrefix → Input<String?>?
S3 key prefix that follows the name of the bucket you have designated for log file delivery.
final
snsTopicArn → Input<String?>?
ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
final
snsTopicName → Input<String?>?
Name of the Amazon SNS topic defined for notification of log file delivery. Specify the SNS topic ARN if it resides in another region.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the trail. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited