/cloudformation-resource

Concourse CI resource for AWS CloudFormation

Primary LanguageShell

Cloudformation Resource

An output only resource (at the moment) that will configure your stack in AWS using Cloudformation.

Source Configuration

  • aws_access_key: Required. The user access key that will be required to make changes to the Cloudformation stack.

  • aws_secret_key: Required. The user secret key that is required to make changes to the Cloudformation stack.

  • aws_region: Optional. The region associated with the Clouformation stack that we are making changes to. The region is defaulted to us-east-1.

Example

resources:
- name: aws-setup
  type: cloudformation
  source:
    aws_access_key: some_access_key
    aws_secret_key: some_secret_key
    aws_region: us-east-1
jobs:
...
- put: aws-setup
  params:
    cloudformation_file: path/to/cloudformation/configuration/file
    stack_name: name_of_aws_stack_to_configure

Behavior

out: Submit changes to your Cloudformation stack.

Given a Cloudformation configuration file and a AWS stack name, this will apply your Cloudformation configuration to the specified stack in AWS.

Parameters

  • cloudformation_file: Required. A path to a file containing the Cloudformation configuration.

  • stack_name: Required. The name of the stack in AWS that this will apply the Cloudformation configuration to.

  • capabilities: Optional. Additional CloudFormation capabilities required (example "CAPABILITY_IAM") "Currently, the only valid value is CAPABILITY_IAM"

Requirements

You must add the following to your Concourse BOSH manifest to pull the Cloudformation container. You will need to redeploy your Concourse server once you've updated the manifest.

properties:
  groundcrew:
    resource_types:
    - image: docker:///pcfseceng/cloudformation-resource
      type: cloudformation