Fork me on GitHub

carrotaws:cloud-formation-find-stack

Full name:

com.carrotgarden.maven:carrot-maven-aws-plugin:1.2.2:cloud-formation-find-stack

Description:

cloud formation: find stack by name

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: prepare-package.

Required Parameters

Name Type Since Description
amazonRegion String - AWS region name, such as us-east-1, which controls amazon region selection; alternatively, see amazonRegionProperty
Default value is: us-east-1.
stackName String - AWS CloudFormation stack name; must be unique under your aws account / region; alternatively, see stackNameProperty
Default value is: amazon-builder.
stackResultProperty String - name of project.property which will contain Stack instance after execution of this maven goal, which can be used by groovy script as follows: 
def stack = project.properties["amazonStack"]
println "name = " + stack.stackName
println "status = " + stack.stackStatus

Default value is: amazonStack.
stackServerId String - AWS CloudFormation amazon security credentials stored in maven settings.xml under server id entry; username="Access Key ID", password="Secret Access Key";
Default value is: com.example.aws.stack.

Optional Parameters

Name Type Since Description
amazonRegionProperty String - name of project.property which, if set dynamically, will be used instead of plugin property amazonRegion
amazonTagName String - default amazon tag for resource names
Default value is: Name.
stackEndpintFormat String - AWS CloudFormation end point format
Default value is: https://cloudformation.%s.amazonaws.com.
stackEndpoint String - AWS CloudFormation optional api end point url which controls amazon region selection; when omitted, will be constructed from stackEndpintFormat and amazonRegion
stackNameProperty String - name of project.property which, if set dynamically, will be used instead of plug-in property stackName
stackTimeout String - AWS CloudFormation operation timeout; seconds
Default value is: 600.

Parameter Details

amazonRegion:

AWS region name, such as us-east-1, which controls amazon region selection; alternatively, see amazonRegionProperty
  • Type: java.lang.String
  • Required: Yes
  • Default: us-east-1

amazonRegionProperty:

name of project.property which, if set dynamically, will be used instead of plugin property amazonRegion
  • Type: java.lang.String
  • Required: No

amazonTagName:

default amazon tag for resource names
  • Type: java.lang.String
  • Required: No
  • Default: Name

stackEndpintFormat:

AWS CloudFormation end point format
  • Type: java.lang.String
  • Required: No
  • Default: https://cloudformation.%s.amazonaws.com

stackEndpoint:

AWS CloudFormation optional api end point url which controls amazon region selection; when omitted, will be constructed from stackEndpintFormat and amazonRegion
  • Type: java.lang.String
  • Required: No

stackName:

AWS CloudFormation stack name; must be unique under your aws account / region; alternatively, see stackNameProperty
  • Type: java.lang.String
  • Required: Yes
  • Default: amazon-builder

stackNameProperty:

name of project.property which, if set dynamically, will be used instead of plug-in property stackName
  • Type: java.lang.String
  • Required: No

stackResultProperty:

name of project.property which will contain Stack instance after execution of this maven goal, which can be used by groovy script as follows: 
def stack = project.properties["amazonStack"]
println "name = " + stack.stackName
println "status = " + stack.stackStatus
  • Type: java.lang.String
  • Required: Yes
  • Default: amazonStack

stackServerId:

AWS CloudFormation amazon security credentials stored in maven settings.xml under server id entry; username="Access Key ID", password="Secret Access Key";
  • Type: java.lang.String
  • Required: Yes
  • Default: com.example.aws.stack

stackTimeout:

AWS CloudFormation operation timeout; seconds
  • Type: java.lang.String
  • Required: No
  • Default: 600