#[non_exhaustive]pub struct LogConfigurationBuilder { /* private fields */ }
Expand description
A builder for LogConfiguration
.
Implementations§
Source§impl LogConfigurationBuilder
impl LogConfigurationBuilder
Sourcepub fn log_driver(self, input: LogDriver) -> Self
pub fn log_driver(self, input: LogDriver) -> Self
The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs
, fluentd
, gelf
, json-file
, journald
, logentries
, syslog
, and splunk
.
Jobs that are running on Fargate resources are restricted to the awslogs
and splunk
log drivers.
- awsfirelens
-
Specifies the firelens logging driver. For more information on configuring Firelens, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the Amazon Elastic Container Service Developer Guide.
- awslogs
-
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
- fluentd
-
Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
-
Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
- journald
-
Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.
- json-file
-
Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
-
Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
-
Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn set_log_driver(self, input: Option<LogDriver>) -> Self
pub fn set_log_driver(self, input: Option<LogDriver>) -> Self
The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs
, fluentd
, gelf
, json-file
, journald
, logentries
, syslog
, and splunk
.
Jobs that are running on Fargate resources are restricted to the awslogs
and splunk
log drivers.
- awsfirelens
-
Specifies the firelens logging driver. For more information on configuring Firelens, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the Amazon Elastic Container Service Developer Guide.
- awslogs
-
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
- fluentd
-
Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
-
Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
- journald
-
Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.
- json-file
-
Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
-
Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
-
Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn get_log_driver(&self) -> &Option<LogDriver>
pub fn get_log_driver(&self) -> &Option<LogDriver>
The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs
, fluentd
, gelf
, json-file
, journald
, logentries
, syslog
, and splunk
.
Jobs that are running on Fargate resources are restricted to the awslogs
and splunk
log drivers.
- awsfirelens
-
Specifies the firelens logging driver. For more information on configuring Firelens, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the Amazon Elastic Container Service Developer Guide.
- awslogs
-
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
- fluentd
-
Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
-
Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
- journald
-
Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.
- json-file
-
Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
-
Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
-
Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn options(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn options(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to options
.
To override the contents of this collection use set_options
.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn set_options(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_options(self, input: Option<HashMap<String, String>>) -> Self
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn get_options(&self) -> &Option<HashMap<String, String>>
pub fn get_options(&self) -> &Option<HashMap<String, String>>
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn secret_options(self, input: Secret) -> Self
pub fn secret_options(self, input: Secret) -> Self
Appends an item to secret_options
.
To override the contents of this collection use set_secret_options
.
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
Sourcepub fn set_secret_options(self, input: Option<Vec<Secret>>) -> Self
pub fn set_secret_options(self, input: Option<Vec<Secret>>) -> Self
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
Sourcepub fn get_secret_options(&self) -> &Option<Vec<Secret>>
pub fn get_secret_options(&self) -> &Option<Vec<Secret>>
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
Sourcepub fn build(self) -> LogConfiguration
pub fn build(self) -> LogConfiguration
Consumes the builder and constructs a LogConfiguration
.
Trait Implementations§
Source§impl Clone for LogConfigurationBuilder
impl Clone for LogConfigurationBuilder
Source§fn clone(&self) -> LogConfigurationBuilder
fn clone(&self) -> LogConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LogConfigurationBuilder
impl Debug for LogConfigurationBuilder
Source§impl Default for LogConfigurationBuilder
impl Default for LogConfigurationBuilder
Source§fn default() -> LogConfigurationBuilder
fn default() -> LogConfigurationBuilder
Source§impl PartialEq for LogConfigurationBuilder
impl PartialEq for LogConfigurationBuilder
impl StructuralPartialEq for LogConfigurationBuilder
Auto Trait Implementations§
impl Freeze for LogConfigurationBuilder
impl RefUnwindSafe for LogConfigurationBuilder
impl Send for LogConfigurationBuilder
impl Sync for LogConfigurationBuilder
impl Unpin for LogConfigurationBuilder
impl UnwindSafe for LogConfigurationBuilder
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);