hanseltime/yarn-cfn-resource-template

Template for constructing resources when you are using yarn plug'n'play for cloudformation extension

Your::Resource::Here

Important Currently, this supports Unix. Shell scripts would need have a windows .bat file equivalent.

This project serves as a productionaized template to the cfn cli typescript repo plugin.

Necessary Changes on cloning (Delete after changing)

1. Change your repository urls in package.json and sourceUrl for your-resource-here.json
   • Also change your package name
2. Update your resource name and the file name to reflect it
   • Replace in all files: Your::Resource::Here -> Your resource name
   • Replace in all files: Your-Resource-Here -> Your resource name
   • rename your-resource-here.json to match your resource names with - replacing ::
3. Update your schema properties
   • After updating your properties, you will want to also update inputs in inputs, invoke_inputs. example_cfn
4. Run yarn generate-models to update your models.ts and resource-role.yaml

Example repo:

If you would like an example of a functioning extension repository that uses this pattern please see here

Developing

See Development

START: Pre-supplied instructions on init

Congratulations on starting development! Next steps:

1. Write the JSON schema describing your resource, .json
2. Implement your resource handlers in handlers.ts

Don't modify models.ts by hand, any modifications will be overwritten when the generate or package commands are run.

Implement CloudFormation resource here. Each function must always return a ProgressEvent.

const progress = ProgressEvent.builder<ProgressEvent<ResourceModel>>()

    // Required
    // Must be one of OperationStatus.InProgress, OperationStatus.Failed, OperationStatus.Success
    .status(OperationStatus.InProgress)
    // Required on SUCCESS (except for LIST where resourceModels is required)
    // The current resource model after the operation; instance of ResourceModel class
    .resourceModel(model)
    .resourceModels(null)
    // Required on FAILED
    // Customer-facing message, displayed in e.g. CloudFormation stack events
    .message('')
    // Required on FAILED a HandlerErrorCode
    .errorCode(HandlerErrorCode.InternalFailure)
    // Optional
    // Use to store any state between re-invocation via IN_PROGRESS
    .callbackContext({})
    // Required on IN_PROGRESS
    // The number of seconds to delay before re-invocation
    .callbackDelaySeconds(0)

    .build()

While importing the @amazon-web-services-cloudformation/cloudformation-cli-typescript-lib library, failures can be passed back to CloudFormation by either raising an exception from exceptions, or setting the ProgressEvent's status to OperationStatus.Failed and errorCode to one of HandlerErrorCode. There is a static helper function, ProgressEvent.failed, for this common case.

Keep in mind, during runtime all logs will be delivered to CloudWatch if you use the log() method from LoggerProxy class.