I want to pass input parameter to cloudformation properties from text file or save the text file in s3 bucket and point the s3 URL in CF properties.
Please let me know if this is possible? If yes, how to do?
There isn't a way if you're using the AWS management console to create the CloudFormation stack, but you can if you use the AWS CLI. Save the parameters into a text file (e.g. parameters.txt) in one of the following formats:
Shorthand:
ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean ...
JSON:
[
{
"ParameterKey": "string",
"ParameterValue": "string",
"UsePreviousValue": true|false
}
...
]
Then use the AWS CLI command cloudformation create-stack, e.g.:
aws cloudformation create-stack --stack-name <YourStackName> \
--template-body file://<YourTemplateFileName.ext> \
--parameters file://parameters.txt
Unfortunately it doesn't seem --parameters can reference an S3 bucket directly, only a local file or inline parameters.
See this blog parameter you pass using s3 url:
https://aws.amazon.com/blogs/devops/passing-parameters-to-cloudformation-stacks-with-the-aws-cli-and-powershell/
also try this:
aws cloudformation create-stack --stack-name <YourStackName> \
--template-body file://<YourTemplateFileName.ext> \
--parameters $(aws s3 cp S3:/yourbucketname\parameters.txt - )
Related
I'm trying to deploy nested stack using command
aws cloudformation deploy --stack-name "${STACK_NAME}" --template-file "${S3_ROOT_TEMPLATE}" --parameter-overrides ${PARAMS[#]} --region ${REGION}
But despite the S3_ROOT_TEMPLATE having proper url, I get the error
Invalid template path
https://<s3-bucket-name>.s3.us-east-2.amazonaws.com/sm-domain-templates/main_stack.yaml
Any idea what's wrong with the above?
Even though in the console you have to use S3 path, in the awscli command, it expects the local file path of the root stack file
The following command deploys a template named S3_ROOT_TEMPLATE to a stack named STACK_NAME:
STACK_NAME="cfn-demo"
S3_ROOT_TEMPLATE="cfn-demo.yaml"
REGION="us-east-1"
bucket_name="cfn-demo-bucket"
aws cloudformation deploy --stack-name $STACK_NAME --template-file $S3_ROOT_TEMPLATE --parameter-overrides $PARAMS[#] --region $REGION
If your templates are sized greater than 51,200 bytes, then the name of the S3 bucket where this command uploads your CloudFormation template.
aws cloudformation deploy --stack-name $STACK_NAME --template-file $S3_ROOT_TEMPLATE --parameter-overrides $PARAMS[#] --region $REGION --s3-bucket $bucket_name
For updating the stack, you could upload the template file to the S3 bucket by using copy and then, update the stack by using the S3 object URL as the template source.
aws s3 cp $S3_ROOT_TEMPLATE s3://$bucket_name
aws cloudformation update-stack --stack-name $STACK_NAME --template-url https://$bucket_name.s3.$REGION.amazonaws.com/$S3_ROOT_TEMPLATE
This page describes how to set a stack name in some AWS console GUI: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-using-console-create-stack-parameters.html
How do I set these values in the SAM Template .yml files?
I'm specifically doing this on a Stack that is only a Lambda Layer if that matters.
I can see that there is some way to do this via CLI as described here:
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-cli-creating-stack.html
aws cloudformation create-stack --stack-name myteststack --template-url "ssm-doc://arn:aws:ssm:us-east-1:123456789012:document/documentName"
Is it even possible to set the name in the template?
Unfortunately, it seems like stack name is NOT part of the SAM templates. This is done via the command arguments to deploy the stack.
From the same link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-cli-creating-stack.html
The following example creates the myteststack stack in an Amazon S3 bucket:
PROMPT> aws cloudformation create-stack \
--stack-name myteststack \
--template-body file:///home/testuser/mytemplate.json \
--parameters ParameterKey=Parm1,ParameterValue=test1 ParameterKey=Parm2,ParameterValue=test2
So when creating the stack, the --stack-name argument is how this is set.
The reason I was confused is because I didn't realize where that command was being issued.
I have a template file in a S3 bucket. I want to create a cloudformation stack with it.
I run:
aws cloudformation create --template https://mybucket-us-east-1.s3.us-east-1.amazonaws.com/template/1.0/the-template.template --stack-name test-stack
Then I get this error:
Invalid template path https://mybucket-us-east-1.s3.us-east-1.amazonaws.com/template/1.0/the-template.template
What is the correct syntax to create/deploy a cloudformation stack from a template file found in a S3 bucket?
jprdanm was right. This command worked, however, I also needed to add --capabilities CAPABILITY_NAMED_IAM at the end of it, so:
aws cloudformation create-stack --template-url https://mybucket-us-east-1.s3.us-east-1.amazonaws.com/template/1.0/the-template.template --stack-name test-stack --capabilities CAPABILITY_NAMED_IAM
I was trying to update the existing CloudFormation stack with the below command.
aws cloudformation deploy
there is no option to pass parameter file with deploy option. we tried to pass parameter file with --parameter-overrides but it's giving the below error.
value passed to --parameter-overrides must be of format Key=Value
the command we try to execute is
aws cloudformation deploy --template-file sg.yml --stack-name Common-SG --parameter-overrides ip.json --no-execute-changeset
is there any way to pass the parameters in file with aws cloudformation deploy
Passing a parameters stored as JSON in a local file looks like:
aws cloudformation deploy \
--stack-name demo \
--template-file test.yml --parameter-overrides file://test.json \
and the test.json like this.
{
"Parameters": {
"BucketName": "myawesometestdemo"
}
}
test.yml
---
AWSTemplateFormatVersion: '2010-09-09'
Description: Simple S3 Bucket test
Parameters:
BucketName:
Type: String
Description: The name of the S3 Bucket to create
Metadata:
AWS::CloudFormation::Interface:
ParameterLabels:
BucketName:
default: S3 Bucket Name
Resources:
S3Bucket:
Type: AWS::S3::Bucket
Properties:
BucketName: !Ref BucketName
aws cli version :
aws --version
aws-cli/2.2.35 Python/3. XXX
workaround for this issue is pass parameters with jq command.
yum install jq
Below is the syntax for the same.
aws cloudformation deploy --template-file sg.yml --stack-name Common-SG --parameter-overrides $(jq -r '.[] | [.ParameterKey, .ParameterValue] | "\(.[0])=\(.[1])"' ip.json) --no-execute-changeset
this might be too late already, but for the sake of future similar issue I found this answer on (https://github.com/aws/serverless-application-model/issues/111)
The command should look like:
aws cloudformation deploy --template-file sg.yml --stack-name Common-SG --parameter-overrides $(cat params.properties) --no-execute-changeset
Now this is not going to be a json file, since "parameter-overrieds" expects a Key=Value pairs!
You can actually pass a file path to Cloudformation deploy --parameter-overrides. The below syntax worked for me:
aws cloudformation deploy \
--template-file template.yml \
--stack-name my-stack \
--parameter-overrides file://path/to_parameter_file.json
where file://path/to_parameter_file.json represents the path to the parameter you want to pass.
I had the same issue with the files
Initially I had used
[
{
"ParameterKey": "EnvironmentStage",
"ParameterValue": "sandbox"
}
]
This did not work I got the error that the elements should be of Class 'Str' and not an ordered.Dict
2nd iteration I changed it to as mentioned in the earlier responses that did not work either
finally I have it as
[
"EnvironmentStage=sandbox"
]
and it works well
This worked for me in buildspec file:
Structure of parameters.json:
[
{
"ParameterKey": "Key1",
"ParameterValue": "Value1"
}
]
and then:
post_build:
commands:
- echo "Start build..."
- aws cloudformation deploy --template-file ./template.yaml --parameter-overrides $(jq -r '.[] | [.ParameterKey, .ParameterValue] | "\(.[0])=\(.[1])"' ./parameters/parameters.json) --stack-name ${stackName} --capabilities CAPABILITY_NAMED_IAM CAPABILITY_AUTO_EXPAND
You can do like this based on aws doc:
https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html
aws cloudformation deploy --template-file /path_to_template/template.json --stack-name my-new-stack --parameter-overrides Key1=Value1 Key2=Value2
I ran this command:
aws cloudformation create-stack --stack-name my-stackname --template-body file://stack.yml --parameters file://stack-params.json
And got this result:
arams.json
{
"StackId": "arn:aws:cloudformation:us-east-1:343434345343:stack/some-stack-name/43434f-sed434-1147-867c-098sdfs09sdd"
}
However, I'm looking for a way to programmatically/automatically capture values for VPCID, PrivateSubnet1, PrivateSubnet2, PublicSubnet1, PublicSubnet2, S3BucketName & DBSubnetGroup based on the values in the output section of the base stack created above.
I don't want to login to my aws cloudformation service console to manually copy and paste these values.
Is there a way to automatically extract that data, maybe some script of some kind?
I could pipe the output of the above command to another program and parse the data if that data was in the output but all I get in the output is the stackid.
How do I get the VPCID, PrivateSubnet1, PrivateSubnet2, PublicSubnet1, PublicSubnet2, S3BucketName & DBSubnetGroup based on the values in the output section of the base stack created above?
You can use the aws cloudformation wait command to wait for your stack to finish before checking the output values. For example:
aws cloudformation create-stack \
--stack-name my-stackname \
--template-body file://stack.yml \
--parameters file://stack-params.json
aws cloudformation wait stack-create-complete \
--stack-name my-stackname
aws cloudformation describe-stacks \
--stack-name my-stackname \
--query "Stacks[0].Outputs"
If you want to get the stack outputs one by one, you can use a query such as:
aws cloudformation describe-stacks \
--stack-name my-stackname \
--query "Stacks[0].Outputs[?OutputKey=='VPCID'].OutputValue" \
--output text
Note that for wait, you need to use stack-update-complete if you are doing an update rather than a create.