AWS Mod for Flowpipe
AWS pipeline library for Flowpipe, enabling seamless integration of AWS services into your workflows.
Documentation
Getting Started
Requirements
Docker daemon must be installed and running. Please see Install Docker Engine for more information.
Installation
Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:
brew tap turbot/tapbrew install flowpipe
Connections
By default, the following environment variables will be used for authentication:
AWS_PROFILE
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
You can also create connection
resources in configuration files:
vi ~/.flowpipe/config/aws.fpc
connection "aws" "aws_profile" { profile = "my-profile"}
connection "aws" "aws_access_key_pair" { access_key = "AKIA..." secret_key = "dP+C+J..."}
connection "aws" "aws_session_token" { access_key = "AKIA..." secret_key = "dP+C+J..." session_token = "AQoDX..."}
For more information on connections in Flowpipe, please see Managing Connections.
Usage
mkdir my_modcd my_modflowpipe mod init
Install the AWS mod as a dependency:
flowpipe mod install github.com/turbot/flowpipe-mod-aws
Use the dependency in a pipeline step:
vi my_pipeline.fp
pipeline "my_pipeline" {
step "pipeline" "describe_ec2_instances" { pipeline = aws.pipeline.describe_ec2_instances args = { instance_type = "t2.micro" region = "us-east-1" } }}
flowpipe pipeline run my_pipeline
Developing
Clone:
git clone https://github.com/turbot/flowpipe-mod-aws.gitcd flowpipe-mod-aws
List pipelines:
flowpipe pipeline list
Run a pipeline:
flowpipe pipeline run describe_ec2_instances --arg 'instance_ids=["i-1234567890abcdef0", "i-abcdef12345"]' --arg instance_type=t2.micro --arg region=ap-south-1
To use a specific connection
, specify the conn
pipeline argument:
flowpipe pipeline run describe_ec2_instances --arg conn=connection.aws.aws_profile --arg instance_type=t2.micro --arg region=us-east-1
Open Source & Contributing
This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!
Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.
Get Involved
Want to help but not sure where to start? Pick up one of the help wanted
issues: