如何在 AWS CloudFormation 部署中将参数作为文件传递？

Question

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

Answer 1

Passing a parameters stored as JSON in a local file looks like:

aws cloudformation deploy \
    --stack-name ${CI_PROJECT_NAME}-${STAGE} \
    --template-file deployment.yml \
    --s3-bucket ${CI_BUCKET} \
    --role-arn ${DEPLOYMENT_ROLE} \
    --no-fail-on-empty-changeset \
    --parameter-overrides file://./env/sandbox/config-sandbox.json \

and the config-sandbox.json like this.

{
  "Parameters": {
   
    "EnvironmentStage": "sandbox",
   
  }
}

More details: https://aws.amazon.com/fr/blogs/devops/passing-parameters-to-cloudformation-stacks-with-the-aws-cli-and-powershell/

Answer 2

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!

Answer 3

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

Answer 4

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.

Answer 5

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

Answer 6

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

Answer 7

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

Answer 8

aws cloudformation create-stack  --stack-name startmyinstance  
    --template-body file://home/ec2-user/templates/startmyinstance.json
    --parameters  ParameterKey=KeyPairName,ParameterValue=MyKey ParameterKey=InstanceType,ParameterValue=t1.micro
'''