An open API service indexing awesome lists of open source software.

https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transfer

The CloudFormation Resource Provider Package For AWS Transfer Family
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-transfer

aws-resources aws-transfer resources

Last synced: 10 months ago
JSON representation

The CloudFormation Resource Provider Package For AWS Transfer Family

Awesome Lists containing this project

README

          

## AWS CloudFormation Resource Provider Package For AWS Transfer Family

This repository contains AWS-owned resource providers for the `AWS::Transfer::*` namespace.

Usage
-----

The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.

Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.

Development
-----------

First, you will need to install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli), as it is a required dependency:

```shell
pip3 install -U -r requirements.txt
```

Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit. The continuous integration also runs these checks.

```shell
pre-commit install
```

Manual options are available so you don't have to commit:

```shell
# run all hooks on all files, mirrors what the CI runs
pre-commit run --all-files
# run unit tests and coverage checks
mvn verify
```

## Security

See [CONTRIBUTING](.github/SECURITY.md) for more information.

## License

This project is licensed under the Apache-2.0 License.