board_params_set_s3: Create formatted parameters that specify an s3 bucket board

In amashadihossein/dpi: Data Product Programming Interface

Create formatted parameters that specify an s3 bucket board

Description

Build a data frame that contains all of the parameters needed to specify an s3 bucket pin board.

Usage

board_params_set_s3(bucket_name, region, board_alias = deprecated())

Arguments

bucket_name	The name of the s3 bucket where the data product will be stored.
region	The AWS region where the s3 bucket was created, e.g. "us-east-1" or "us-west-1".
board_alias	A short name for the board. this argument is deprecated with pins ≥ 1.0.

Value

A data.frame with class "s3_board" and a column for each param.

Examples

## Not run: 
board_params_set_s3(
  bucket_name = "bucket_name",
  region = "us-east-1"
)

## End(Not run)

amashadihossein/dpi documentation built on Aug. 14, 2024, 11:13 a.m.