README.md

The AWS Provider for Gyro enables users to easily work with Amazon Web Services. The AWS provider extends Gyro allowing you to manage your AWS infrastructure.

To learn more about Gyro see getgyro.io and gyro.

• Resource Documentation
• Submit an Issue
• Getting Help

Using the AWS Provider

AWS Account

Before you can use AWS provider, you will need an AWS account. Please see Sign Up for AWS to create an AWS Account.

Once your account is set up and ready to be used, you need to set up AWS Credentials to a credentials file or in the environment.

Define your credentials in $HOME/.aws/credentials under a profile name of your choosing:

[my-project]
aws_secret_access_key = <access_key>
aws_access_key_id = <access_key_id>

See Setting up AWS credentials for Gyro.

Using The Provider

Import

Load the AWS provider in your project by consuming it as a plugin directive in your init file. It uses the format @plugin: gyro:gyro-aws-provider:<version>.

@repository: 'https://artifactory.psdops.com/gyro-releases'
@plugin: 'gyro:gyro-aws-provider:1.6.0'

Authentication

Provide the AWS provider with credentials by defining the following in your .gyro/init.gyro file:

@credentials 'aws::credentials'
    profile-name: 'my-project'
    region: 'us-east-1'
@end

See AWS authentication for Gyro for more details.

Supported Services

• ACM
• ACM PCA
• API Gateway
• Autoscaling Groups
• Backup
• Cloudfront
• Cloudtrail
• Cloudwatch
• Codebuild
• Cognito
• Data Lifecycle Manager
• Document Db
• Dynamo DB
• Dax
• EC2
• ECR
• EFS
• EKS
• ElastiCache
• Elasticsearch
• EventBridge
• GlobalAccelerator
• Identity Access Management
• Kendra
• KMS
• Lambda
• Load Balancer
• Load Balancer - Classic
• Neptune
• Relational Database Service (RDS)
• Route53
• S3
• Simple Notification Service
• SQS
• WAF - Global
• WAF - Regional
• WAF - V2

Developing the AWS Provider

The provider is written in Java using Gradle as the build tool.

We recommend installing AdoptOpenJDK 11 or higher if you're going to contribute to this provider.

Gyro uses the Gradle build tool. Once you have a JDK installed building is easy, just run ./gradlew at the root of the Gyro project. This wrapper script will automatically download and install Gradle for you, then build the provider:

$ ./gradlew
Downloading https://services.gradle.org/distributions/gradle-5.2.1-all.zip
..............................................................................................................................

Welcome to Gradle 5.2.1!

Here are the highlights of this release:
 - Define sets of dependencies that work together with Java Platform plugin
 - New C++ plugins with dependency management built-in
 - New C++ project types for gradle init
 - Service injection into plugins and project extensions

For more details see https://docs.gradle.org/5.2.1/release-notes.html

Starting a Gradle Daemon, 1 stopped Daemon could not be reused, use --status for details

.
.
.

BUILD SUCCESSFUL in 17s
38 actionable tasks: 28 executed, 10 from cache
$

Getting Help

• Join the Gyro community chat on Gitter.
• Take a look at the documentation for tutorial and examples.

License

This software is open source under the Apache License 2.0.