smdocker (version 0.1.4)

smdocker_config: Set paws config across smdocker package

Description

This function sets up paws client config list for all AWS calls. This function only needs to be used when changing default settings when connecting to AWS.

Usage

smdocker_config(
  aws_access_key_id = NULL,
  aws_secret_access_key = NULL,
  aws_session_token = NULL,
  region_name = NULL,
  profile_name = NULL,
  disable_ssl = FALSE,
  anonymous = FALSE,
  refresh = FALSE,
  ...
)

Value

Invisible list, containing credentials for paws clients.

Arguments

aws_access_key_id

(character): AWS access key ID

aws_secret_access_key

(character): AWS secret access key

aws_session_token

(character): AWS temporary session token

region_name

(character): Default region when creating new connections

profile_name

(character): The name of a profile to use. If not given, then the default profile is used.

disable_ssl

(logical): Whether or not to use SSL. By default, SSL is used.

anonymous

(logical): Set up anonymous credentials when connecting to AWS.

refresh

(logical): Refresh cached smdocker config

...

Other parameters within paws client.

See Also

ecr codebuild sagemaker cloudwatchlogs iam sts s3

Examples

# Set up connection using profile
smdocker_config(profile_name = "smdocker_example")

# Reset connection to connect to a different region
smdocker_config(
  profile_name = "smdocker_example",
  region_name = "us-east-1",
  refresh = TRUE
)