terraform-provider-s3extra

README

Terraform Provider S3 Extra

S3 Extra provides extra resources for interacting with S3-compatible object storage.

Maintenance status

Experimental: This project is new. We're not sure what our ongoing maintenance plan for this project will be. Bug reports, feature requests and pull requests are welcome. If you like this project, let us know!

Usage

See detailed resource documentation at the provider's Terraform Registry page.

Requirements

• Terraform >= 1.0
• Go >= 1.17

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

See the examples directory for resource-specific examples.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of acceptance tests, run make testacc. You will need AWS credentials in your shell environment to run the acceptance tests. We recommend aws-vault to populate AWS credentials while storing them securely in your OS keychain.

Note: Acceptance tests create real resources and cost money to run.

## With credentials already in environment
make testacc

## With `aws-vault`
aws-vault exec profile-name -- make testacc

If you are a Formidable contributor, reach out to the #operations channel and tag a maintainer for assistance. We can provide you credentials to our least-privilege AWS account dedicated to running this provider's acceptance tests in automation.