Type Alias Builder

pub type Builder = Builder;

👎Deprecated since 1.1.11: Use aws_runtime::env_config::file::Builder.

Use aws_runtime::env_config::file::Builder instead.

Aliased Type

struct Builder { /* private fields */ }

Implementations

impl Builder

pub fn new() -> Builder

Creates a new builder instance.

pub fn include_default_config_file( self, include_default_config_file: bool, ) -> Builder

Include the default SDK config file in the list of profile files to be loaded.

The default SDK config typically resides in ~/.aws/config. When this flag is enabled, this config file will be included in the profile files that get loaded in the built EnvConfigFiles file set.

This flag defaults to false when using the builder to construct EnvConfigFiles.

pub fn include_default_credentials_file( self, include_default_credentials_file: bool, ) -> Builder

Include the default SDK credentials file in the list of profile files to be loaded.

The default SDK credentials typically reside in ~/.aws/credentials. When this flag is enabled, this credentials file will be included in the profile files that get loaded in the built EnvConfigFiles file set.

This flag defaults to false when using the builder to construct EnvConfigFiles.

pub fn with_file( self, kind: EnvConfigFileKind, file: impl Into<PathBuf>, ) -> Builder

Include a custom file in the list of profile files to be loaded.

The kind informs the parser how to treat the file. If it’s intended to be like the SDK credentials file typically in ~/.aws/config, then use EnvConfigFileKind::Config. Otherwise, use EnvConfigFileKind::Credentials.

pub fn with_contents( self, kind: EnvConfigFileKind, contents: impl Into<String>, ) -> Builder

Include custom file contents in the list of profile files to be loaded.

The kind informs the parser how to treat the file. If it’s intended to be like the SDK credentials file typically in ~/.aws/config, then use EnvConfigFileKind::Config. Otherwise, use EnvConfigFileKind::Credentials.

pub fn build(self) -> EnvConfigFiles

Build the EnvConfigFiles file set.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.