Class: LonoCfn::CLI::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/lono-cfn/cli/help.rb

Class Method Summary collapse

Class Method Details

.create ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/lono-cfn/cli/help.rb', line 5

def create
<<-EOL
Examples:

Provided that you are in a lono project and have a `my-stack` lono template definition.  To create a stack you can simply run:

$ lono-cfn create my-stack

The above command will generate and use the template in output/my-stack.json and parameters in params/my-stack.txt.  The template by convention defaults to the name of the stack.  In turn, the params by convention defaults to the name of the template.

Here are examples of overriding the template and params name conventions.

$ lono-cfn create my-stack --template different-name1

The template that will be use is output/different-name1.json and the parameters will use params/different-name1.json.

$ lono-cfn create my-stack --params different-name2

The template that will be use is output/different-name2.json and the parameters will use params/different-name2.json.

$ lono-cfn create my-stack --template different-name3 --params different-name4

The template that will be use is output/different-name3.json and the parameters will use params/different-name4.json.

EOL
end

.delete ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/lono-cfn/cli/help.rb', line 59

def delete
<<-EOL
Examples:

$ lono-cfn delete my-stack

The above command will delete my-stack.
EOL
end

.diff ⇒ Object 



85
86
87
88
89
90
91
92
93
 
# File 'lib/lono-cfn/cli/help.rb', line 85

def diff
<<-EOL
Displays code diff of the generated CloudFormation template locally vs the existing template on AWS. You can set a desired diff viewer by setting the LONO_CFN_DIFF environment variable.

Examples:

$ lono-cfn diff my-stack
EOL
end

.preview ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/lono-cfn/cli/help.rb', line 69

def preview
<<-EOL
Generates a CloudFormation preview.  This is similar to a `terraform plan` or puppet's dry-run mode.

Example output:

CloudFormation preview for 'example' stack update. Changes:

Remove AWS::Route53::RecordSet: DnsRecord testsubdomain.sub.tongueroo.com

Examples:

$ lono-cfn preview my-stack
EOL
end

.update ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/lono-cfn/cli/help.rb', line 32

def update
<<-EOL
Examples:

Provided that you are in a lono project and have a `my-stack` lono template definition.  To update a stack you can simply run:

$ lono-cfn update my-stack

The above command will generate and use the template in output/my-stack.json and parameters in params/my-stack.txt.  The template by convention defaults to the name of the stack.  In turn, the params by convention defaults to the name of the template.

Here are examples of overriding the template and params name conventions.

$ lono-cfn update my-stack --template different-name1

The template that will be use is output/different-name1.json and the parameters will use params/different-name1.json.

$ lono-cfn update my-stack --params different-name2

The template that will be use is output/different-name2.json and the parameters will use params/different-name2.json.

$ lono-cfn update my-stack --template different-name3 --params different-name4

The template that will be use is output/different-name3.json and the parameters will use params/different-name4.json.

EOL
end