You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Override a comma delimited list: `"MyParam1=myValue1,MyParam1=myValue2"`or `MyParam1="myValue1,myValue2"`
32
33
33
34
Override parameters using a native YAML object:
35
+
34
36
```yaml
35
37
parameter-overrides:
36
38
MyParam1: myValue1
@@ -41,6 +43,7 @@ parameter-overrides:
41
43
```
42
44
43
45
Override parameters using a local JSON file: `"file:///${{ github.workspace }}/parameters.json"`with a file named `parameters.json` at the root of the repository:
46
+
44
47
```json
45
48
[
46
49
{
@@ -52,6 +55,58 @@ Override parameters using a local JSON file: `"file:///${{ github.workspace }}/p
52
55
53
56
> You can learn more about [AWS CloudFormation](https://aws.amazon.com/cloudformation/)
54
57
58
+
## Setting Tags
59
+
60
+
You can add tags to your CloudFormation stack by using the `tags` parameter. Tags can be specified in three formats:
Tags specified during stack creation or update will be applied to the stack and all its resources that support tagging. These tags can be useful for cost allocation, access control, and resource organization.
109
+
55
110
## Credentials and Region
56
111
57
112
This action relies on the [default behavior of the AWS SDK for Javascript](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) to determine AWS credentials and region.
@@ -71,7 +126,7 @@ This action requires the following minimum set of permissions:
71
126
72
127
> We recommend to read [AWS CloudFormation Security Best Practices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html)
name: 'AWS CloudFormation "Deploy CloudFormation Stack" Action for GitHub Actions'
2
3
description: "Deploys a AWS CloudFormation stack"
3
4
branding:
@@ -11,53 +12,105 @@ inputs:
11
12
description: "The path or URL to the CloudFormation template"
12
13
required: true
13
14
capabilities:
14
-
description: "The comma-delimited list of stack template capabilities to acknowledge. Defaults to 'CAPABILITY_IAM'"
15
+
description: >-
16
+
The comma-delimited list of stack template capabilities to acknowledge.
17
+
Defaults to 'CAPABILITY_IAM'
15
18
required: false
16
19
default: "CAPABILITY_IAM"
17
20
parameter-overrides:
18
-
description: 'The parameters to override in the stack inputs. You can pass a comma-delimited list, a file URL, or a native YAML object. Comma-delimited list has each entry formatted as <ParameterName>=<ParameterValue> or <ParameterName>="<ParameterValue>,<ParameterValue>". A JSON file can be a local file with a "file://" prefix or remote URL. The file should look like: [ { "ParameterKey": "KeyPairName", "ParameterValue": "MyKey" }]. For YAML objects, provide parameter keys and values directly in the YAML structure.'
21
+
description: >-
22
+
The parameters to override in the stack inputs. You can pass a comma-delimited
23
+
list, a file URL, or a native YAML object. Comma-delimited list has each entry
24
+
formatted as <ParameterName>=<ParameterValue> or
25
+
<ParameterName>="<ParameterValue>,<ParameterValue>". A JSON file can be a local
26
+
file with a "file://" prefix or remote URL. The file should look like:
27
+
[ { "ParameterKey": "KeyPairName", "ParameterValue": "MyKey" }]. For YAML
28
+
objects, provide parameter keys and values directly in the YAML structure.
19
29
required: false
20
30
no-execute-changeset:
21
-
description: "Indicates whether to execute to the change set or have it reviewed. Default to '0' (will execute the change set)"
31
+
description: >-
32
+
Indicates whether to execute to the change set or have it reviewed.
33
+
Default to '0' (will execute the change set)
22
34
required: false
23
35
default: "0"
24
36
no-delete-failed-changeset:
25
-
description: "Indicates whether to delete to a failed change set. Default to '0' (will delete the failed changeset)"
37
+
description: >-
38
+
Indicates whether to delete to a failed change set.
39
+
Default to '0' (will delete the failed changeset)
26
40
required: false
27
41
default: "0"
28
42
no-fail-on-empty-changeset:
29
-
description: "If the CloudFormation change set is empty, do not fail. Defaults to '0' (will fail on empty change set)"
43
+
description: >-
44
+
If the CloudFormation change set is empty, do not fail.
45
+
Defaults to '0' (will fail on empty change set)
30
46
required: false
31
47
default: "0"
32
48
disable-rollback:
33
-
description: "Disable rollback of the stack if stack creation fails. Defaults to '0' (will rollback if stack creation fails). This input is only used for stack creation, not for stack update"
49
+
description: >-
50
+
Disable rollback of the stack if stack creation fails.
51
+
Defaults to '0' (will rollback if stack creation fails).
52
+
This input is only used for stack creation, not for stack update
34
53
required: false
35
54
default: "0"
36
55
timeout-in-minutes:
37
-
description: "The amount of time that can pass before the stack status becomes CREATE_FAILED. This input is only used for stack creation, not for stack update"
56
+
description: >-
57
+
The amount of time that can pass before the stack status becomes CREATE_FAILED.
58
+
This input is only used for stack creation, not for stack update
38
59
required: false
39
60
notification-arns:
40
-
description: "The comma-delimited list of Amazon SNS topic ARNs to publish stack related events"
61
+
description: >-
62
+
The comma-delimited list of Amazon SNS topic ARNs to publish stack
63
+
related events
41
64
required: false
42
65
role-arn:
43
-
description: "The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack"
66
+
description: >-
67
+
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM)
68
+
role that AWS CloudFormation assumes to create the stack. AWS CloudFormation
69
+
uses the role's credentials to make calls on your behalf. AWS CloudFormation
70
+
always uses this role for all future operations on the stack. As long as users
71
+
have permission to operate on the stack, AWS CloudFormation uses this role even
72
+
if the users don't have permission to pass it. Ensure that the role grants
73
+
least privilege. If you don't specify a value, AWS CloudFormation uses the
74
+
role that was previously associated with the stack
44
75
required: false
45
76
tags:
46
-
description: 'Key-value pairs to associate with this stack. This input should be JSON-formatted, for example [ { "Key": "string", "Value": "string" } ]'
77
+
description: >-
78
+
Key-value pairs to associate with this stack. Can be specified in three formats:
description: "Whether to enable termination protection on the specified stack. Defaults to '0' (terminated protection will be disabled) This input is only used for stack creation, not for stack update"
93
+
description: >-
94
+
Whether to enable termination protection on the specified stack.
95
+
Defaults to '0' (terminated protection will be disabled)
96
+
This input is only used for stack creation, not for stack update
50
97
required: false
51
98
default: "0"
52
99
http-proxy:
53
100
description: 'Proxy to use for the AWS SDK agent'
54
101
required: false
55
102
change-set-name:
56
-
description: "The name of the change set to create. Defaults to '<stack-name>-CS'"
103
+
description: >-
104
+
The name of the change set to create.
105
+
Defaults to '<stack-name>-CS'
57
106
required: false
58
107
outputs:
59
108
stack-id:
60
-
description: "The id of the deployed stack. In addition, any outputs declared in the deployed CloudFormation stack will also be set as outputs for the action, e.g. if the stack has a stack output named 'foo', this action will also have an output named 'foo'."
109
+
description: >-
110
+
The id of the deployed stack. In addition, any outputs declared in the
111
+
deployed CloudFormation stack will also be set as outputs for the action,
112
+
e.g. if the stack has a stack output named 'foo', this action will also
0 commit comments