#[non_exhaustive]pub struct Trail {Show 16 fields
pub name: Option<String>,
pub s3_bucket_name: Option<String>,
pub s3_key_prefix: Option<String>,
pub sns_topic_name: Option<String>,
pub sns_topic_arn: Option<String>,
pub include_global_service_events: Option<bool>,
pub is_multi_region_trail: Option<bool>,
pub home_region: Option<String>,
pub trail_arn: Option<String>,
pub log_file_validation_enabled: Option<bool>,
pub cloud_watch_logs_log_group_arn: Option<String>,
pub cloud_watch_logs_role_arn: Option<String>,
pub kms_key_id: Option<String>,
pub has_custom_event_selectors: Option<bool>,
pub has_insight_selectors: Option<bool>,
pub is_organization_trail: Option<bool>,
}Expand description
The settings for a trail.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: Option<String>Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
s3_bucket_name: Option<String>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
s3_key_prefix: Option<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.
sns_topic_name: Option<String>This field is no longer in use. Use SnsTopicARN.
sns_topic_arn: Option<String>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
include_global_service_events: Option<bool>Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
is_multi_region_trail: Option<bool>Specifies whether the trail exists only in one Region or exists in all Regions.
home_region: Option<String>The Region in which the trail was created.
trail_arn: Option<String>Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
log_file_validation_enabled: Option<bool>Specifies whether log file validation is enabled.
cloud_watch_logs_log_group_arn: Option<String>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
cloud_watch_logs_role_arn: Option<String>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
kms_key_id: Option<String>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
has_custom_event_selectors: Option<bool>Specifies if the trail has custom event selectors.
has_insight_selectors: Option<bool>Specifies whether a trail has insight types specified in an InsightSelector list.
is_organization_trail: Option<bool>Specifies whether the trail is an organization trail.
Implementations§
Source§impl Trail
impl Trail
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
Sourcepub fn s3_bucket_name(&self) -> Option<&str>
pub fn s3_bucket_name(&self) -> Option<&str>
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
Sourcepub fn s3_key_prefix(&self) -> Option<&str>
pub fn s3_key_prefix(&self) -> Option<&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.
Sourcepub fn sns_topic_name(&self) -> Option<&str>
👎Deprecated
pub fn sns_topic_name(&self) -> Option<&str>
This field is no longer in use. Use SnsTopicARN.
Sourcepub fn sns_topic_arn(&self) -> Option<&str>
pub fn sns_topic_arn(&self) -> Option<&str>
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
Sourcepub fn include_global_service_events(&self) -> Option<bool>
pub fn include_global_service_events(&self) -> Option<bool>
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
Sourcepub fn is_multi_region_trail(&self) -> Option<bool>
pub fn is_multi_region_trail(&self) -> Option<bool>
Specifies whether the trail exists only in one Region or exists in all Regions.
Sourcepub fn home_region(&self) -> Option<&str>
pub fn home_region(&self) -> Option<&str>
The Region in which the trail was created.
Sourcepub fn trail_arn(&self) -> Option<&str>
pub fn trail_arn(&self) -> Option<&str>
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Sourcepub fn log_file_validation_enabled(&self) -> Option<bool>
pub fn log_file_validation_enabled(&self) -> Option<bool>
Specifies whether log file validation is enabled.
Sourcepub fn cloud_watch_logs_log_group_arn(&self) -> Option<&str>
pub fn cloud_watch_logs_log_group_arn(&self) -> Option<&str>
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
Sourcepub fn cloud_watch_logs_role_arn(&self) -> Option<&str>
pub fn cloud_watch_logs_role_arn(&self) -> Option<&str>
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
Sourcepub fn has_custom_event_selectors(&self) -> Option<bool>
pub fn has_custom_event_selectors(&self) -> Option<bool>
Specifies if the trail has custom event selectors.
Sourcepub fn has_insight_selectors(&self) -> Option<bool>
pub fn has_insight_selectors(&self) -> Option<bool>
Specifies whether a trail has insight types specified in an InsightSelector list.
Sourcepub fn is_organization_trail(&self) -> Option<bool>
pub fn is_organization_trail(&self) -> Option<bool>
Specifies whether the trail is an organization trail.
Trait Implementations§
impl StructuralPartialEq for Trail
Auto Trait Implementations§
impl Freeze for Trail
impl RefUnwindSafe for Trail
impl Send for Trail
impl Sync for Trail
impl Unpin for Trail
impl UnwindSafe for Trail
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);