Unverified Commit 0e9a986b authored by Doug's avatar Doug Committed by GitHub
Browse files

Added CloudFormation code examples (#517) 



* Added CloudFormation code examples

* Updated CloudFormation create-stack example based on feedback

* Updated CloudFormation describe-stack example based on feedback

* Removed extra line breaks in Cargo.toml file and orphaned comments in CloudFormation create-stack example

* Clarified how we get stack status in CloudFormation describe-stack example

* Updated CloudFormation code examples to follow latest code guidelines and proper service naming

Co-authored-by: default avatarRussell Cohen <rcoh@amazon.com>
parent 8aabc0fb

aws/sdk/examples/cloudformation/Cargo.toml

+6 −4
Original line number Diff line number Diff line 
[package]

name = "cloudformation"

name = "cloudformation-code-examples"

version = "0.1.0"

authors = ["Alistair McLean <mclean@amazon.com>"]

authors = ["Alistair McLean <mclean@amazon.com>", "Doug Schwartz <dougsch@amazon.com>"]

edition = "2018"



# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



[dependencies]

env_logger = "0.8.2"

cloudformation = {package = "aws-sdk-cloudformation", path = "../../build/aws-sdk/cloudformation"}

aws-sdk-cloudformation = { package = "aws-sdk-cloudformation", path = "../../build/aws-sdk/cloudformation" }

aws-types = { path = "../../build/aws-sdk/aws-types" }

tokio = { version = "1", features = ["full"] }

structopt = { version = "0.3", default-features = false }

tracing-subscriber = "0.2.18"

aws/sdk/examples/cloudformation/src/bin/create-stack.rs

0 → 100644
+86 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



use aws_sdk_cloudformation::{Client, Config, Error, Region, PKG_VERSION};

use aws_types::region;

use aws_types::region::ProvideRegion;

use std::fs;

use structopt::StructOpt;



#[derive(Debug, StructOpt)]

struct Opt {

    /// The AWS Region.

    #[structopt(short, long)]

    region: Option<String>,



    /// The name of the AWS CloudFormation stack.

    #[structopt(short, long)]

    stack_name: String,



    /// The name of the file containing the stack template.

    #[structopt(short, long)]

    template_file: String,



    /// Whether to display additional runtime information.

    #[structopt(short, long)]

    verbose: bool,

}



/// Creates a CloudFormation stack in the region.

/// # Arguments

///

/// * `-s STACK-NAME` - The name of the stack.

/// * `-t TEMPLATE-NAME` - The name of the file containing the stack template.

/// * `[-r REGION]` - The Region in which the client is created.

///    If not supplied, uses the value of the **AWS_REGION** environment variable.

///    If the environment variable is not set, defaults to **us-west-2**.

/// * `[-v]` - Whether to display additional information.

#[tokio::main]

async fn main() -> Result<(), Error> {

    tracing_subscriber::fmt::init();



    let Opt {

        region,

        stack_name,

        template_file,

        verbose,

    } = Opt::from_args();



    let region = region::ChainProvider::first_try(region.map(Region::new))

        .or_default_provider()

        .or_else(Region::new("us-west-2"));



    if verbose {

        println!("CloudFormation client version: {}", PKG_VERSION);

        println!(

            "Region:                        {}",

            region.region().unwrap().as_ref()

        );

        println!("Stack:                         {}", &stack_name);

        println!("Template:                      {}", &template_file);

        println!();

    }



    // Get content of template file as a string.

    let contents =

        fs::read_to_string(template_file).expect("Something went wrong reading the file");



    let conf = Config::builder().region(region).build();

    let client = Client::from_conf(conf);



    client

        .create_stack()

        .stack_name(stack_name)

        .template_body(contents)

        .send()

        .await?;



    println!("Stack created.");

    println!("Use describe-stacks with your stack name to see the status of your stack.");

    println!("You cannot use/deploy the stack until the status is 'CreateComplete'.");

    println!();



    Ok(())

}

aws/sdk/examples/cloudformation/src/bin/delete-stack.rs

0 → 100644
+67 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



use aws_sdk_cloudformation::{Client, Config, Error, Region, PKG_VERSION};

use aws_types::region;

use aws_types::region::ProvideRegion;

use structopt::StructOpt;



#[derive(Debug, StructOpt)]

struct Opt {

    /// The AWS Region.

    #[structopt(short, long)]

    region: Option<String>,



    /// The name of the AWS CloudFormation stack.

    #[structopt(short, long)]

    stack_name: String,



    /// Whether to display additional runtime information.

    #[structopt(short, long)]

    verbose: bool,

}



/// Deletes a CloudFormation stack.

/// # Arguments

///

/// * `-s STACK-NAME` - The name of the stack.

/// * `[-r REGION]` - The Region in which the client is created.

///    If not supplied, uses the value of the **AWS_REGION** environment variable.

///    If the environment variable is not set, defaults to **us-west-2**.

/// * `[-v]` - Whether to display additional information.

#[tokio::main]

async fn main() -> Result<(), Error> {

    tracing_subscriber::fmt::init();



    let Opt {

        region,

        stack_name,

        verbose,

    } = Opt::from_args();



    let region = region::ChainProvider::first_try(region.map(Region::new))

        .or_default_provider()

        .or_else(Region::new("us-west-2"));



    if verbose {

        println!("CloudFormation client version: {}", PKG_VERSION);

        println!(

            "Region:                        {}",

            region.region().unwrap().as_ref()

        );

        println!("Stack:                         {}", &stack_name);

        println!();

    }



    let conf = Config::builder().region(region).build();

    let client = Client::from_conf(conf);



    client.delete_stack().stack_name(stack_name).send().await?;



    println!("Stack deleted");

    println!();



    Ok(())

}

aws/sdk/examples/cloudformation/src/bin/describe-stack.rs

0 → 100644
+79 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



use aws_sdk_cloudformation::{Client, Config, Error, Region, PKG_VERSION};

use aws_types::region;

use aws_types::region::ProvideRegion;

use structopt::StructOpt;



#[derive(Debug, StructOpt)]

struct Opt {

    /// The AWS Region.

    #[structopt(short, long)]

    region: Option<String>,



    /// The name of the AWS CloudFormation stack.

    #[structopt(short, long)]

    stack_name: String,



    /// Whether to display additional information.

    #[structopt(short, long)]

    verbose: bool,

}



/// Retrieves the status of a CloudFormation stack in the Region.

/// # Arguments

///

/// * `-s STACK-NAME` - The name of the stack.

/// * `[-r REGION]` - The Region in which the client is created.

///    If not supplied, uses the value of the **AWS_REGION** environment variable.

///    If the environment variable is not set, defaults to **us-west-2**.

/// * `[-v]` - Whether to display additional information.

#[tokio::main]

async fn main() -> Result<(), Error> {

    tracing_subscriber::fmt::init();



    let Opt {

        region,

        stack_name,

        verbose,

    } = Opt::from_args();



    let region = region::ChainProvider::first_try(region.map(Region::new))

        .or_default_provider()

        .or_else(Region::new("us-west-2"));



    println!();



    if verbose {

        println!("CloudFormation version: {}", PKG_VERSION);

        println!(

            "Region:                 {}",

            region.region().unwrap().as_ref()

        );

        println!("Stack:                  {}", &stack_name);

        println!();

    }



    let conf = Config::builder().region(region).build();

    let client = Client::from_conf(conf);



    // Return an error if stack_name does not exist

    let resp = client

        .describe_stacks()

        .stack_name(stack_name)

        .send()

        .await?;



    // Otherwise we get a list of stacks that match the stack_name.

    // The list should only have one item, so just access is via pop().

    let status = resp.stacks.unwrap_or_default().pop().unwrap().stack_status;



    println!("Stack status: {:?}", status);



    println!();



    Ok(())

}

aws/sdk/examples/cloudformation/src/bin/list-stacks.rs

0 → 100644
+62 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



use aws_sdk_cloudformation::{Client, Config, Error, Region, PKG_VERSION};

use aws_types::region;

use aws_types::region::ProvideRegion;

use structopt::StructOpt;



#[derive(Debug, StructOpt)]

struct Opt {

    /// The AWS Region.

    #[structopt(short, long)]

    region: Option<String>,



    /// Whether to display additional runtime information

    #[structopt(short, long)]

    verbose: bool,

}



/// Lists the name and status of your AWS CloudFormation stacks in the Region.

/// # Arguments

///

/// * `[-r REGION]` - The Region in which the client is created.

///    If not supplied, uses the value of the **AWS_REGION** environment variable.

///    If the environment variable is not set, defaults to **us-west-2**.

/// * `[-v]` - Whether to display additional information.

#[tokio::main]

async fn main() -> Result<(), Error> {

    tracing_subscriber::fmt::init();



    let Opt { region, verbose } = Opt::from_args();



    let region = region::ChainProvider::first_try(region.map(Region::new))

        .or_default_provider()

        .or_else(Region::new("us-west-2"));



    println!();



    if verbose {

        println!("CloudFormation client version: {}", PKG_VERSION);

        println!(

            "Region:                        {}",

            region.region().unwrap().as_ref()

        );

        println!();

    }



    let conf = Config::builder().region(region).build();

    let client = Client::from_conf(conf);



    let stacks = client.list_stacks().send().await?;



    for s in stacks.stack_summaries.unwrap_or_default() {

        println!("{}", s.stack_name.as_deref().unwrap_or_default());

        println!("  Status: {:?}", s.stack_status.unwrap());

        println!();

    }



    Ok(())

}