Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2.9 KB

README.md

File metadata and controls

77 lines (51 loc) · 2.9 KB
Raw

cdk-constructs

Join the chat at https://gitter.im/pdmlab/cdk-constructs

Shared constructs for AWS CDK.

Installation

npm install @pdmlab/cdk-constructs

Usage

CDK-Constructs

AllowHostedZoneChangeResourceRecordSetsPolicy

Create a policy which allows changing DNS records for a domain in a hosted zone in AWS Route53

Example
import cdk = require('@aws-cdk/core');
import {AllowHostedZoneChangeResourceRecordSetsPolicy} from '@pdmlab/cdk-constructs'

export class CdkConstructsTestStack extends cdk.Stack {
  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    new AllowHostedZoneChangeResourceRecordSetsPolicy(this, 'MyPolicy', {
      domainName: 'mydomain.com',
      policyName: 'allow-dns-policy'
    })
  }
}

Make sure to set CDK_DEFAULT_ACCOUNT and CDK_DEFAULT_REGION environment variables.

Want to help?

This project is just getting off the ground and could use some help with cleaning things up and refactoring.

If you want to contribute - we'd love it! Just open an issue to work against so you get full credit for your fork. You can open the issue first so we can discuss and you can work your fork as we go along.

If you see a bug, please be so kind as to show how it's failing, and we'll do our best to get it fixed quickly.

Before sending a PR, please create an issue to introduce your idea and have a reference for your PR.

We're using conventional commits, so please use it for your commits as well.

Also please add tests and make sure to run npm run lint-ts.

License

MIT License

Copyright (c) 2019 PDMLab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.