Struct aws_config::profile::profile_file::Builder

pub struct Builder { /* private fields */ }

Builder for ProfileFiles.

Implementations

impl Builder

pub fn new() -> Self

Creates a new builder instance.

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

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 ProfileFiles file set.

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

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

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

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

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

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

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 ProfileFileKind::Config. Otherwise, use ProfileFileKind::Credentials.

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

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 ProfileFileKind::Config. Otherwise, use ProfileFileKind::Credentials.

pub fn build(self) -> ProfileFiles

Build the ProfileFiles 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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.