-
Notifications
You must be signed in to change notification settings - Fork 29
/
aws-ssm-document.json
231 lines (231 loc) · 8.11 KB
/
aws-ssm-document.json
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
{
"typeName": "AWS::SSM::Document",
"description": "The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.",
"sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm",
"definitions": {
"AttachmentsSource": {
"type": "object",
"properties": {
"Key": {
"description": "The key of a key-value pair that identifies the location of an attachment to a document.",
"type": "string",
"enum": [
"SourceUrl",
"S3FileUrl",
"AttachmentReference"
]
},
"Values": {
"description": "The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.",
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"minItems": 1,
"maxItems": 1,
"insertionOrder": false
},
"Name": {
"description": "The name of the document attachment file.",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"minLength": 1,
"maxLength": 128
}
},
"additionalProperties": false
},
"Tag": {
"type": "object",
"properties": {
"Key": {
"description": "The name of the tag.",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"minLength": 1,
"maxLength": 128
},
"Value": {
"description": "The value of the tag.",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"minLength": 1,
"maxLength": 256
}
},
"additionalProperties": false
},
"DocumentRequires": {
"type": "object",
"properties": {
"Name": {
"description": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN).",
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$",
"maxLength": 200
},
"Version": {
"description": "The document version required by the current document.",
"type": "string",
"pattern": "([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)",
"maxLength": 8
}
},
"additionalProperties": false
}
},
"properties": {
"Content": {
"description": "The content for the Systems Manager document in JSON, YAML or String format.",
"type": [
"object",
"string"
]
},
"Attachments": {
"description": "A list of key and value pairs that describe attachments to a version of a document.",
"type": "array",
"items": {
"$ref": "#/definitions/AttachmentsSource"
},
"minItems": 0,
"maxItems": 20,
"insertionOrder": false
},
"Name": {
"description": "A name for the Systems Manager document.",
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-.]{3,128}$"
},
"VersionName": {
"description": "An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.",
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-.]{1,128}$"
},
"DocumentType": {
"description": "The type of document to create.",
"type": "string",
"enum": [
"ApplicationConfiguration",
"ApplicationConfigurationSchema",
"Automation",
"Automation.ChangeTemplate",
"ChangeCalendar",
"CloudFormation",
"Command",
"DeploymentStrategy",
"Package",
"Policy",
"ProblemAnalysis",
"ProblemAnalysisTemplate",
"Session"
]
},
"DocumentFormat": {
"description": "Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.",
"type": "string",
"enum": [
"YAML",
"JSON",
"TEXT"
],
"default": "JSON"
},
"TargetType": {
"description": "Specify a target type to define the kinds of resources the document can run on.",
"type": "string",
"pattern": "^\\/[\\w\\.\\-\\:\\/]*$"
},
"Tags": {
"description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.",
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
},
"maxItems": 1000,
"insertionOrder": false
},
"Requires": {
"description": "A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.",
"type": "array",
"items": {
"$ref": "#/definitions/DocumentRequires"
},
"minItems": 1,
"insertionOrder": false
},
"UpdateMethod": {
"description": "Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.",
"type": "string",
"enum": [
"Replace",
"NewVersion"
],
"default": "Replace"
}
},
"additionalProperties": false,
"required": [
"Content"
],
"createOnlyProperties": [
"/properties/Name",
"/properties/DocumentType"
],
"conditionalCreateOnlyProperties": [
"/properties/Content",
"/properties/Attachments",
"/properties/VersionName",
"/properties/DocumentFormat",
"/properties/TargetType",
"/properties/Requires"
],
"writeOnlyProperties": [
"/properties/UpdateMethod",
"/properties/Attachments"
],
"primaryIdentifier": [
"/properties/Name"
],
"tagging": {
"taggable": true
},
"handlers": {
"create": {
"permissions": [
"ssm:CreateDocument",
"s3:GetObject",
"iam:PassRole"
]
},
"read": {
"permissions": [
"ssm:GetDocument"
]
},
"update": {
"permissions": [
"ssm:UpdateDocument",
"s3:GetObject",
"ssm:AddTagsToResource",
"ssm:RemoveTagsFromResource",
"ssm:ListTagsForResource",
"iam:PassRole",
"ssm:UpdateDocumentDefaultVersion",
"ssm:DescribeDocument"
]
},
"delete": {
"permissions": [
"ssm:DeleteDocument"
]
},
"list": {
"permissions": [
"ssm:ListDocuments"
]
}
}
}