#[non_exhaustive]pub struct TrailBuilder { /* private fields */ }Expand description
A builder for Trail.
Implementations§
Source§impl TrailBuilder
impl TrailBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
Sourcepub fn s3_bucket_name(self, input: impl Into<String>) -> Self
pub fn s3_bucket_name(self, input: impl Into<String>) -> Self
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
Sourcepub fn set_s3_bucket_name(self, input: Option<String>) -> Self
pub fn set_s3_bucket_name(self, input: Option<String>) -> Self
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket naming rules.
Sourcepub fn get_s3_bucket_name(&self) -> &Option<String>
pub fn get_s3_bucket_name(&self) -> &Option<String>
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, input: impl Into<String>) -> Self
pub fn s3_key_prefix(self, input: impl Into<String>) -> Self
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 set_s3_key_prefix(self, input: Option<String>) -> Self
pub fn set_s3_key_prefix(self, input: Option<String>) -> Self
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 get_s3_key_prefix(&self) -> &Option<String>
pub fn get_s3_key_prefix(&self) -> &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.
Sourcepub fn sns_topic_name(self, input: impl Into<String>) -> Self
👎Deprecated
pub fn sns_topic_name(self, input: impl Into<String>) -> Self
This field is no longer in use. Use SnsTopicARN.
Sourcepub fn set_sns_topic_name(self, input: Option<String>) -> Self
👎Deprecated
pub fn set_sns_topic_name(self, input: Option<String>) -> Self
This field is no longer in use. Use SnsTopicARN.
Sourcepub fn get_sns_topic_name(&self) -> &Option<String>
👎Deprecated
pub fn get_sns_topic_name(&self) -> &Option<String>
This field is no longer in use. Use SnsTopicARN.
Sourcepub fn sns_topic_arn(self, input: impl Into<String>) -> Self
pub fn sns_topic_arn(self, input: impl Into<String>) -> Self
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 set_sns_topic_arn(self, input: Option<String>) -> Self
pub fn set_sns_topic_arn(self, input: Option<String>) -> Self
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 get_sns_topic_arn(&self) -> &Option<String>
pub fn get_sns_topic_arn(&self) -> &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
Sourcepub fn include_global_service_events(self, input: bool) -> Self
pub fn include_global_service_events(self, input: bool) -> Self
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
Sourcepub fn set_include_global_service_events(self, input: Option<bool>) -> Self
pub fn set_include_global_service_events(self, input: Option<bool>) -> Self
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
Sourcepub fn get_include_global_service_events(&self) -> &Option<bool>
pub fn get_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, input: bool) -> Self
pub fn is_multi_region_trail(self, input: bool) -> Self
Specifies whether the trail exists only in one Region or exists in all Regions.
Sourcepub fn set_is_multi_region_trail(self, input: Option<bool>) -> Self
pub fn set_is_multi_region_trail(self, input: Option<bool>) -> Self
Specifies whether the trail exists only in one Region or exists in all Regions.
Sourcepub fn get_is_multi_region_trail(&self) -> &Option<bool>
pub fn get_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, input: impl Into<String>) -> Self
pub fn home_region(self, input: impl Into<String>) -> Self
The Region in which the trail was created.
Sourcepub fn set_home_region(self, input: Option<String>) -> Self
pub fn set_home_region(self, input: Option<String>) -> Self
The Region in which the trail was created.
Sourcepub fn get_home_region(&self) -> &Option<String>
pub fn get_home_region(&self) -> &Option<String>
The Region in which the trail was created.
Sourcepub fn trail_arn(self, input: impl Into<String>) -> Self
pub fn trail_arn(self, input: impl Into<String>) -> Self
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 set_trail_arn(self, input: Option<String>) -> Self
pub fn set_trail_arn(self, input: Option<String>) -> Self
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 get_trail_arn(&self) -> &Option<String>
pub fn get_trail_arn(&self) -> &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
Sourcepub fn log_file_validation_enabled(self, input: bool) -> Self
pub fn log_file_validation_enabled(self, input: bool) -> Self
Specifies whether log file validation is enabled.
Sourcepub fn set_log_file_validation_enabled(self, input: Option<bool>) -> Self
pub fn set_log_file_validation_enabled(self, input: Option<bool>) -> Self
Specifies whether log file validation is enabled.
Sourcepub fn get_log_file_validation_enabled(&self) -> &Option<bool>
pub fn get_log_file_validation_enabled(&self) -> &Option<bool>
Specifies whether log file validation is enabled.
Sourcepub fn cloud_watch_logs_log_group_arn(self, input: impl Into<String>) -> Self
pub fn cloud_watch_logs_log_group_arn(self, input: impl Into<String>) -> Self
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
Sourcepub fn set_cloud_watch_logs_log_group_arn(self, input: Option<String>) -> Self
pub fn set_cloud_watch_logs_log_group_arn(self, input: Option<String>) -> Self
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
Sourcepub fn get_cloud_watch_logs_log_group_arn(&self) -> &Option<String>
pub fn get_cloud_watch_logs_log_group_arn(&self) -> &Option<String>
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, input: impl Into<String>) -> Self
pub fn cloud_watch_logs_role_arn(self, input: impl Into<String>) -> Self
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Sourcepub fn set_cloud_watch_logs_role_arn(self, input: Option<String>) -> Self
pub fn set_cloud_watch_logs_role_arn(self, input: Option<String>) -> Self
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Sourcepub fn get_cloud_watch_logs_role_arn(&self) -> &Option<String>
pub fn get_cloud_watch_logs_role_arn(&self) -> &Option<String>
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
Specifies the KMS key ID that encrypts the logs and digest files 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 set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
Specifies the KMS key ID that encrypts the logs and digest files 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 get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
Specifies the KMS key ID that encrypts the logs and digest files 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, input: bool) -> Self
pub fn has_custom_event_selectors(self, input: bool) -> Self
Specifies if the trail has custom event selectors.
Sourcepub fn set_has_custom_event_selectors(self, input: Option<bool>) -> Self
pub fn set_has_custom_event_selectors(self, input: Option<bool>) -> Self
Specifies if the trail has custom event selectors.
Sourcepub fn get_has_custom_event_selectors(&self) -> &Option<bool>
pub fn get_has_custom_event_selectors(&self) -> &Option<bool>
Specifies if the trail has custom event selectors.
Sourcepub fn has_insight_selectors(self, input: bool) -> Self
pub fn has_insight_selectors(self, input: bool) -> Self
Specifies whether a trail has insight types specified in an InsightSelector list.
Sourcepub fn set_has_insight_selectors(self, input: Option<bool>) -> Self
pub fn set_has_insight_selectors(self, input: Option<bool>) -> Self
Specifies whether a trail has insight types specified in an InsightSelector list.
Sourcepub fn get_has_insight_selectors(&self) -> &Option<bool>
pub fn get_has_insight_selectors(&self) -> &Option<bool>
Specifies whether a trail has insight types specified in an InsightSelector list.
Sourcepub fn is_organization_trail(self, input: bool) -> Self
pub fn is_organization_trail(self, input: bool) -> Self
Specifies whether the trail is an organization trail.
Sourcepub fn set_is_organization_trail(self, input: Option<bool>) -> Self
pub fn set_is_organization_trail(self, input: Option<bool>) -> Self
Specifies whether the trail is an organization trail.
Sourcepub fn get_is_organization_trail(&self) -> &Option<bool>
pub fn get_is_organization_trail(&self) -> &Option<bool>
Specifies whether the trail is an organization trail.
Trait Implementations§
Source§impl Clone for TrailBuilder
impl Clone for TrailBuilder
Source§fn clone(&self) -> TrailBuilder
fn clone(&self) -> TrailBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TrailBuilder
impl Debug for TrailBuilder
Source§impl Default for TrailBuilder
impl Default for TrailBuilder
Source§fn default() -> TrailBuilder
fn default() -> TrailBuilder
Source§impl PartialEq for TrailBuilder
impl PartialEq for TrailBuilder
impl StructuralPartialEq for TrailBuilder
Auto Trait Implementations§
impl Freeze for TrailBuilder
impl RefUnwindSafe for TrailBuilder
impl Send for TrailBuilder
impl Sync for TrailBuilder
impl Unpin for TrailBuilder
impl UnwindSafe for TrailBuilder
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);