[][src]Crate cfn_resource_provider

cfn-resource-provider

This library is a relatively thin wrapper enabling the use of Rust in AWS Lambda to provide an AWS CloudFormation custom resource. It is intended to be used in conjunction with rust-aws-lambda, a library that enables to run Rust applications serverless on AWS Lambda using the Go 1.x runtime.

Quick start example

extern crate aws_lambda as lambda;
extern crate cfn_resource_provider as cfn;

use cfn::*;

fn main() {
    lambda::start(cfn::process(|event: CfnRequest<MyResourceProperties>| {
        // Perform the necessary steps to create the custom resource. Afterwards you can return
        // some data that should be serialized into the response. If you don't want to serialize
        // any data, you can return `None` (were you unfortunately have to specify the unknown
        // serializable type using the turbofish).
        Ok(None::<()>)
    }));
}

License

This library is licensed under either of

  • Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in cfn-resource-provider by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Structs

Ignored

This is a special struct that can be used in conjunction with Serde to represent a field whose contents should be discarded during deserialization if it is present, and doesn't fail if the field doesn't exist.

Enums

CfnRequest

On stack modification, AWS CloudFormation sends out a request for custom resources. This enum can represent such a request, encapsulating the three request variants:

CfnResponse

This enum represents the response expected by AWS CloudFormation to a custom resource modification request (see CfnRequest). It is serializable into the required JSON form, such that it can be sent to the pre-signed S3 response-URL provided by AWS CloudFormation without further modification.

Traits

PhysicalResourceIdSuffixProvider

Every AWS CloudFormation resource, including custom resources, needs a unique physical resource ID. To aid in supplying this resource ID, your resource property type has to implement this trait with its single member, physical_resource_id_suffix.

Functions

process

Process an AWS CloudFormation custom resource request.