aws_config::profile::profile_file

Type Alias Builder

Source
pub type Builder = Builder;
👎Deprecated since 1.1.11: Use aws_runtime::env_config::file::Builder.
Expand description

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

Aliased Type§

struct Builder { /* private fields */ }

Implementations

Source§

impl Builder

Source

pub fn new() -> Builder

Creates a new builder instance.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn build(self) -> EnvConfigFiles

Build the EnvConfigFiles file set.

Trait Implementations

Source§

impl Clone for Builder

Source§

fn clone(&self) -> Builder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Builder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Builder

Source§

fn default() -> Builder

Returns the “default value” for a type. Read more