1. orbss/aws-cloudformation@0.1.6

orbss/aws-cloudformation@0.1.6

Sections
"Control AWS CloudFormation stack. See details @GitHub https://github.com/circleci-orbs-tm/cloudformation"
Created: July 9, 2019Version Published: November 21, 2019Releases: 7
Org Usage:
< 25

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: aws-cloudformation: orbss/aws-cloudformation@0.1.6

Use aws-cloudformation elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Jobs

create-stack

Install and configure aws-cli and execute aws cloudformation commands

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
aws-access-key-id
AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY.
No
AWS_ACCESS_KEY_ID
env_var_name
aws-region
Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION)
No
AWS_DEFAULT_REGION
env_var_name
aws-secret-access-key
AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY.
No
AWS_SECRET_ACCESS_KEY
env_var_name
branch
Git branch of retrieving GitHub URL of CloudFormation template file
No
master
string
configure-default-region
Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config
No
true
boolean
extra-arguments
Optional additional arguments to pass to the `aws cloudformation create-stack` command
No
''
string
git-url
GitHub URL to retrieve CloudFormation template
No
''
string
profile-name
Profile name to be configured.
No
default
string
stack-name
CloudFormation stack name
Yes
-
string
template-file-path
CloudFormation template file path
Yes
-
string

delete-stack

Install and configure aws-cli and execute aws cloudformation delete-stack command

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
aws-access-key-id
AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY.
No
AWS_ACCESS_KEY_ID
env_var_name
aws-region
Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION)
No
AWS_DEFAULT_REGION
env_var_name
aws-secret-access-key
AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY.
No
AWS_SECRET_ACCESS_KEY
env_var_name
configure-default-region
Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config
No
true
boolean
profile-name
Profile name to be configured.
No
default
string
stack-name
CloudFormation stack name
Yes
-
string

deploy

Install and configure aws-cli and execute aws cloudformation deploy command

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
aws-access-key-id
AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY.
No
AWS_ACCESS_KEY_ID
env_var_name
aws-region
Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION)
No
AWS_DEFAULT_REGION
env_var_name
aws-secret-access-key
AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY.
No
AWS_SECRET_ACCESS_KEY
env_var_name
branch
Git branch of retrieving GitHub URL of CloudFormation template file
No
master
string
capabilities
Space separated list of capabilities required by the CloudFormation template. i.e. "CAPABILITY_AUTO_EXPAND CAPABILITY_IAM CAPABILITY_NAMED_IAM."
No
''
string
configure-default-region
Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config
No
true
boolean
extra-arguments
Optional additional arguments to pass to the `aws cloudformation deploy` command
No
''
string
git-url
GitHub URL to retrieve CloudFormation template
No
''
string
parameter-overrides
A list of parameter structures specifying input parameters to the stack. Parameters that are not specified will use the stack's existing value. Example: ParameterKey1=ParameterValue1 ParameterKey2=ParameterValue2
No
''
string
profile-name
Profile name to be configured.
No
default
string
stack-name
CloudFormation stack name
Yes
-
string
template-file-path
CloudFormation template file path
Yes
-
string

describe-stacks

Install and configure aws-cli and execute `aws cloudformation describe-stacks` command

Show job Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
aws-access-key-id
AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY.
No
AWS_ACCESS_KEY_ID
env_var_name
aws-region
Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION)
No
AWS_DEFAULT_REGION
env_var_name
aws-secret-access-key
AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY.
No
AWS_SECRET_ACCESS_KEY
env_var_name
configure-default-region
Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config
No
true
boolean
extra-arguments
Optional additional arguments to pass to the `aws cloudformation describe-stacks` command
No
''
string
profile-name
Profile name to be configured.
No
default
string
stack-name
CloudFormation stack name
No
''
string

Commands

create-stack

Creates a stack as specified in the template. Wait until stack status is CREATE_COMPLETE.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
branch
Git branch of retrieving GitHub URL of CloudFormation template file. This option becomes effictive only when parameter 'git-url' is specified.
No
master
string
extra-arguments
Optional additional arguments to pass to the `aws cloudformation create-stack` command
No
''
string
git-url
GitHub URL to retrieve CloudFormation template. If this parameter is not specified, checkout step is executed.
No
''
string
stack-name
CloudFormation stack name
Yes
-
string
template-file-path
CloudFormation template file path
Yes
-
string

delete-stack

Delete existing stack

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
stack-name
CloudFormation stack name
Yes
-
string

deploy

Deploys a stack as specified in the template, using a change set. Deploying a change set automatically waits for the stack to successfully reach UPDATE_COMPLETE.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
branch
Git branch of retrieving GitHub URL of CloudFormation template file. This option becomes effictive only when parameter 'git-url' is specified.
No
master
string
capabilities
Space separated list of capabilities required by the CloudFormation template, i.e. "CAPABILITY_IAM CAPABILITY_NAMED_IAM."
No
''
string
extra-arguments
Optional additional arguments to pass to the `aws cloudformation create-stack` command
No
''
string
git-url
GitHub URL to retrieve CloudFormation template. If this parameter is not specified, checkout step is executed.
No
''
string
parameter-overrides
A list of parameter structures specifying input parameters to the stack. Parameters that are not specified will use the stack's existing value. Example: ParameterKey1=ParameterValue1 ParameterKey2=ParameterValue2
No
''
string
stack-name
CloudFormation stack name
Yes
-
string
template-file-path
CloudFormation template file path
Yes
-
string

describe-stacks

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
extra-arguments
Optional additional arguments to pass to the `aws cloudformation create-stack` command
No
''
string
stack-name
CloudFormation stack name
No
''
string

Executors

default

The Debian-based Docker container to use when installing/configuring the AWS CLI

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
debian-release
-
No
stretch
string
python-version
-
No
'2.7'
string

Orb Source

1 2 3 4 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 31 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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing commands: create-stack: description: | Creates a stack as specified in the template. Wait until stack status is CREATE_COMPLETE. parameters: branch: default: master description: | Git branch of retrieving GitHub URL of CloudFormation template file. This option becomes effictive only when parameter 'git-url' is specified. type: string extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation create-stack` command type: string git-url: default: "" description: | GitHub URL to retrieve CloudFormation template. If this parameter is not specified, checkout step is executed. type: string stack-name: description: | CloudFormation stack name type: string template-file-path: description: | CloudFormation template file path type: string steps: - run: command: | if [ <<parameters.git-url>> != "" ]; then mkdir ~/cfn-tmp git clone <<parameters.git-url>> -b <<parameters.branch>> ~/cfn-tmp fi name: Custom checkout - run: command: | if [ <<parameters.git-url>> != "" ]; then aws cloudformation create-stack \ --stack-name <<parameters.stack-name>> \ --template-body file:///home/circleci/cfn-tmp/<<parameters.template-file-path>> \ <<parameters.extra-arguments>> else aws cloudformation create-stack \ --stack-name <<parameters.stack-name>> \ --template-body file://<<parameters.template-file-path>> \ <<parameters.extra-arguments>> fi name: Create stack - run: command: | aws cloudformation wait stack-create-complete \ --stack-name <<parameters.stack-name>> name: Wait until Stack is created delete-stack: description: | Delete existing stack parameters: stack-name: description: | CloudFormation stack name type: string steps: - run: command: | aws cloudformation delete-stack \ --stack-name <<parameters.stack-name>> name: Delete stack - run: command: | aws cloudformation wait stack-delete-complete \ --stack-name <<parameters.stack-name>> name: Wait until stack status is DELETE_COMPLETE deploy: description: | Deploys a stack as specified in the template, using a change set. Deploying a change set automatically waits for the stack to successfully reach UPDATE_COMPLETE. parameters: branch: default: master description: | Git branch of retrieving GitHub URL of CloudFormation template file. This option becomes effictive only when parameter 'git-url' is specified. type: string capabilities: default: "" description: | Space separated list of capabilities required by the CloudFormation template, i.e. "CAPABILITY_IAM CAPABILITY_NAMED_IAM." type: string extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation create-stack` command type: string git-url: default: "" description: | GitHub URL to retrieve CloudFormation template. If this parameter is not specified, checkout step is executed. type: string parameter-overrides: default: "" description: | A list of parameter structures specifying input parameters to the stack. Parameters that are not specified will use the stack's existing value. Example: ParameterKey1=ParameterValue1 ParameterKey2=ParameterValue2 type: string stack-name: description: | CloudFormation stack name type: string template-file-path: description: | CloudFormation template file path type: string steps: - run: command: | if [ <<parameters.git-url>> != "" ]; then mkdir ~/cfn-tmp git clone <<parameters.git-url>> -b <<parameters.branch>> ~/cfn-tmp fi name: Custom checkout - run: command: | if [ <<parameters.capabilities>> != "" ]; then capabilities="--capabilities <<parameters.capabilities>>" fi if [ <<parameters.parameter-overrides>> != "" ]; then parameter_overrides="--parameter-overrides <<parameters.parameter-overrides>>" fi if [ <<parameters.git-url>> != "" ]; then aws cloudformation deploy \ --stack-name <<parameters.stack-name>> \ --template-file /home/circleci/cfn-tmp/<<parameters.template-file-path>> \ ${capabilities} \ ${parameter_overrides} \ <<parameters.extra-arguments>> else aws cloudformation deploy \ --stack-name <<parameters.stack-name>> \ --template-file <<parameters.template-file-path>> \ ${capabilities} \ ${parameter_overrides} \ <<parameters.extra-arguments>> fi name: Deploy stack describe-stacks: description: | Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. parameters: extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation create-stack` command type: string stack-name: default: "" description: | CloudFormation stack name type: string steps: - run: command: | aws cloudformation describe-stacks \ --stack-name <<parameters.stack-name>> \ <<parameters.extra-arguments>> name: Describe stack description: | "Control AWS CloudFormation stack. See details @GitHub https://github.com/circleci-orbs-tm/cloudformation" executors: default: description: | The Debian-based Docker container to use when installing/configuring the AWS CLI docker: - image: circleci/python:<<parameters.python-version>>-<<parameters.debian-release>> parameters: debian-release: default: stretch type: string python-version: default: "2.7" type: string jobs: create-stack: description: | Install and configure aws-cli and execute aws cloudformation commands executor: name: default python-version: 3.7.4 parameters: aws-access-key-id: default: AWS_ACCESS_KEY_ID description: | AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY. type: env_var_name aws-region: default: AWS_DEFAULT_REGION description: | Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION) type: env_var_name aws-secret-access-key: default: AWS_SECRET_ACCESS_KEY description: | AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY. type: env_var_name branch: default: master description: | Git branch of retrieving GitHub URL of CloudFormation template file type: string configure-default-region: default: true description: | Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config type: boolean extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation create-stack` command type: string git-url: default: "" description: | GitHub URL to retrieve CloudFormation template type: string profile-name: default: default description: Profile name to be configured. type: string stack-name: description: | CloudFormation stack name type: string template-file-path: description: | CloudFormation template file path type: string steps: - aws-cli/install - aws-cli/configure: aws-access-key-id: <<parameters.aws-access-key-id>> aws-region: <<parameters.aws-region>> aws-secret-access-key: <<parameters.aws-secret-access-key>> configure-default-region: <<parameters.configure-default-region>> profile-name: <<parameters.profile-name>> - checkout - create-stack: branch: <<parameters.branch>> extra-arguments: <<parameters.extra-arguments>> git-url: <<parameters.git-url>> stack-name: <<parameters.stack-name>> template-file-path: <<parameters.template-file-path>> delete-stack: description: | Install and configure aws-cli and execute aws cloudformation delete-stack command executor: name: default python-version: 3.7.4 parameters: aws-access-key-id: default: AWS_ACCESS_KEY_ID description: | AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY. type: env_var_name aws-region: default: AWS_DEFAULT_REGION description: | Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION) type: env_var_name aws-secret-access-key: default: AWS_SECRET_ACCESS_KEY description: | AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY. type: env_var_name configure-default-region: default: true description: | Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config type: boolean profile-name: default: default description: Profile name to be configured. type: string stack-name: description: | CloudFormation stack name type: string steps: - aws-cli/install - aws-cli/configure: aws-access-key-id: <<parameters.aws-access-key-id>> aws-region: <<parameters.aws-region>> aws-secret-access-key: <<parameters.aws-secret-access-key>> configure-default-region: <<parameters.configure-default-region>> profile-name: <<parameters.profile-name>> - delete-stack: stack-name: <<parameters.stack-name>> deploy: description: | Install and configure aws-cli and execute aws cloudformation deploy command executor: name: default python-version: 3.7.4 parameters: aws-access-key-id: default: AWS_ACCESS_KEY_ID description: | AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY. type: env_var_name aws-region: default: AWS_DEFAULT_REGION description: | Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION) type: env_var_name aws-secret-access-key: default: AWS_SECRET_ACCESS_KEY description: | AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY. type: env_var_name branch: default: master description: | Git branch of retrieving GitHub URL of CloudFormation template file type: string capabilities: default: "" description: | Space separated list of capabilities required by the CloudFormation template. i.e. "CAPABILITY_AUTO_EXPAND CAPABILITY_IAM CAPABILITY_NAMED_IAM." type: string configure-default-region: default: true description: | Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config type: boolean extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation deploy` command type: string git-url: default: "" description: | GitHub URL to retrieve CloudFormation template type: string parameter-overrides: default: "" description: | A list of parameter structures specifying input parameters to the stack. Parameters that are not specified will use the stack's existing value. Example: ParameterKey1=ParameterValue1 ParameterKey2=ParameterValue2 type: string profile-name: default: default description: Profile name to be configured. type: string stack-name: description: | CloudFormation stack name type: string template-file-path: description: | CloudFormation template file path type: string steps: - aws-cli/install - aws-cli/configure: aws-access-key-id: <<parameters.aws-access-key-id>> aws-region: <<parameters.aws-region>> aws-secret-access-key: <<parameters.aws-secret-access-key>> configure-default-region: <<parameters.configure-default-region>> profile-name: <<parameters.profile-name>> - checkout - deploy: branch: <<parameters.branch>> capabilities: <<parameters.capabilities>> extra-arguments: <<parameters.extra-arguments>> git-url: <<parameters.git-url>> parameter-overrides: <<parameters.parameter-overrides>> stack-name: <<parameters.stack-name>> template-file-path: <<parameters.template-file-path>> describe-stacks: description: | Install and configure aws-cli and execute `aws cloudformation describe-stacks` command executor: name: default python-version: 3.7.4 parameters: aws-access-key-id: default: AWS_ACCESS_KEY_ID description: | AWS access key id for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. AWS_ACCESS_KEY. type: env_var_name aws-region: default: AWS_DEFAULT_REGION description: | Env var of AWS region to operate in (defaults to AWS_DEFAULT_REGION) type: env_var_name aws-secret-access-key: default: AWS_SECRET_ACCESS_KEY description: | AWS secret key for IAM role. Set this to the name of the environment variable you will use to hold this value, i.e. $AWS_SECRET_ACCESS_KEY. type: env_var_name configure-default-region: default: true description: | Some AWS actions don't require a region; set this to false if you do not want to store a default region in ~/.aws/config type: boolean extra-arguments: default: "" description: | Optional additional arguments to pass to the `aws cloudformation describe-stacks` command type: string profile-name: default: default description: Profile name to be configured. type: string stack-name: default: "" description: | CloudFormation stack name type: string steps: - aws-cli/install - aws-cli/configure: aws-access-key-id: <<parameters.aws-access-key-id>> aws-region: <<parameters.aws-region>> aws-secret-access-key: <<parameters.aws-secret-access-key>> configure-default-region: <<parameters.configure-default-region>> profile-name: <<parameters.profile-name>> - describe-stacks: extra-arguments: <<parameters.extra-arguments>> stack-name: <<parameters.stack-name>> orbs: aws-cli: circleci/aws-cli@0.1.14 version: 2.1
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.