TrailArgs class
The set of arguments for Trail. The set of arguments for Trail.
Constructors
-
TrailArgs({Input<
List< ? advancedEventSelectors, Input<TrailAdvancedEventSelector> ?>OptionalLogGroup?> ? cloudWatchLogsGroup, Input<bool?> ? enableLogFileValidation, Input<bool?> ? enableLogging, Input<List< ? eventSelectors, Input<TrailEventSelector> ?>bool?> ? includeGlobalServiceEvents, Input<List< ? insightSelectors, Input<TrailInsightSelector> ?>bool?> ? isMultiRegionTrail, Input<bool?> ? isOrganizationTrail, Input<String?> ? kmsKeyId, Input<String?> ? name, Input<String?> ? region, Input<RequiredBucket?> ? s3Bucket, Input<String?> ? s3KeyPrefix, Input<String?> ? snsTopicName, Input<Map< ? tags})String, String> ?> -
Creates a new TrailArgs.
advancedEventSelectorsSpecifies an advanced event selector for enabling data event logging. Fields documented below. Conflicts witheventSelector.cloudWatchLogsGroupLog group to which CloudTrail logs will be delivered.enableLogFileValidationWhether log file integrity validation is enabled. Defaults tofalse.enableLoggingEnables logging for the trail. When set totrue, logging is started by calling theStartLoggingAPI. When set tofalse, logging is stopped by calling theStopLoggingAPI. Defaults totrue.eventSelectorsSpecifies an event selector for enabling data event logging. Fields documented below. Please note the CloudTrail limits when configuring these. Conflicts withadvancedEventSelector.includeGlobalServiceEventsWhether the trail is publishing events from global services such as IAM to the log files. Defaults totrue.insightSelectorsConfiguration block for identifying unusual operational activity. See details below.isMultiRegionTrailWhether the trail is created in the current region or in all regions. Defaults tofalse.isOrganizationTrailWhether 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 tofalse.kmsKeyIdKMS key ARN to use to encrypt the logs delivered by CloudTrail.nameName of the trail.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.s3BucketS3 bucket designated for publishing log files.s3KeyPrefixS3 key prefix that follows the name of the bucket you have designated for log file delivery.snsTopicNameName of the Amazon SNS topic defined for notification of log file delivery. Specify the SNS topic ARN if it resides in another region.tagsMap of tags to assign to the trail. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.const -
TrailArgs.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 -
cloudWatchLogsGroup
→ Input<
OptionalLogGroup?> ? -
Log group to which CloudTrail logs will be delivered.
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 theStartLoggingAPI. When set tofalse, logging is stopped by calling theStopLoggingAPI. Defaults totrue.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
-
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
-
s3Bucket
→ Input<
RequiredBucket?> ? -
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
-
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
-
Map of tags to assign to the trail. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.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