/
firewall_policy_rule_schema.go
executable file
·337 lines (335 loc) · 12.4 KB
/
firewall_policy_rule_schema.go
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
// Copyright 2023 Google LLC. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package compute
import (
"github.com/GoogleCloudPlatform/declarative-resource-client-library/dcl"
)
func DCLFirewallPolicyRuleSchema() *dcl.Schema {
return &dcl.Schema{
Info: &dcl.Info{
Title: "Compute/FirewallPolicyRule",
Description: "The Compute FirewallPolicyRule resource",
StructName: "FirewallPolicyRule",
},
Paths: &dcl.Paths{
Get: &dcl.Path{
Description: "The function used to get information about a FirewallPolicyRule",
Parameters: []dcl.PathParameters{
dcl.PathParameters{
Name: "firewallPolicyRule",
Required: true,
Description: "A full instance of a FirewallPolicyRule",
},
},
},
Apply: &dcl.Path{
Description: "The function used to apply information about a FirewallPolicyRule",
Parameters: []dcl.PathParameters{
dcl.PathParameters{
Name: "firewallPolicyRule",
Required: true,
Description: "A full instance of a FirewallPolicyRule",
},
},
},
Delete: &dcl.Path{
Description: "The function used to delete a FirewallPolicyRule",
Parameters: []dcl.PathParameters{
dcl.PathParameters{
Name: "firewallPolicyRule",
Required: true,
Description: "A full instance of a FirewallPolicyRule",
},
},
},
DeleteAll: &dcl.Path{
Description: "The function used to delete all FirewallPolicyRule",
Parameters: []dcl.PathParameters{
dcl.PathParameters{
Name: "firewallPolicy",
Required: true,
Schema: &dcl.PathParametersSchema{
Type: "string",
},
},
},
},
List: &dcl.Path{
Description: "The function used to list information about many FirewallPolicyRule",
Parameters: []dcl.PathParameters{
dcl.PathParameters{
Name: "firewallPolicy",
Required: true,
Schema: &dcl.PathParametersSchema{
Type: "string",
},
},
},
},
},
Components: &dcl.Components{
Schemas: map[string]*dcl.Component{
"FirewallPolicyRule": &dcl.Component{
Title: "FirewallPolicyRule",
ID: "locations/global/firewallPolicies/{{firewall_policy}}/rules/{{priority}}",
Locations: []string{
"global",
},
HasCreate: true,
SchemaProperty: dcl.Property{
Type: "object",
Required: []string{
"priority",
"match",
"action",
"direction",
"firewallPolicy",
},
Properties: map[string]*dcl.Property{
"action": &dcl.Property{
Type: "string",
GoName: "Action",
Description: "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".",
},
"description": &dcl.Property{
Type: "string",
GoName: "Description",
Description: "An optional description for this resource.",
},
"direction": &dcl.Property{
Type: "string",
GoName: "Direction",
GoType: "FirewallPolicyRuleDirectionEnum",
Description: "The direction in which this rule applies. Possible values: INGRESS, EGRESS",
Enum: []string{
"INGRESS",
"EGRESS",
},
},
"disabled": &dcl.Property{
Type: "boolean",
GoName: "Disabled",
Description: "Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.",
},
"enableLogging": &dcl.Property{
Type: "boolean",
GoName: "EnableLogging",
Description: "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules.",
},
"firewallPolicy": &dcl.Property{
Type: "string",
GoName: "FirewallPolicy",
Description: "The firewall policy of the resource.",
Immutable: true,
ResourceReferences: []*dcl.PropertyResourceReference{
&dcl.PropertyResourceReference{
Resource: "Compute/FirewallPolicy",
Field: "name",
Parent: true,
},
},
},
"kind": &dcl.Property{
Type: "string",
GoName: "Kind",
ReadOnly: true,
Description: "Type of the resource. Always `compute#firewallPolicyRule` for firewall policy rules",
Immutable: true,
},
"match": &dcl.Property{
Type: "object",
GoName: "Match",
GoType: "FirewallPolicyRuleMatch",
Description: "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.",
Required: []string{
"layer4Configs",
},
Properties: map[string]*dcl.Property{
"destFqdns": &dcl.Property{
Type: "array",
GoName: "DestFqdns",
Description: "Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"destIPRanges": &dcl.Property{
Type: "array",
GoName: "DestIPRanges",
Description: "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"destRegionCodes": &dcl.Property{
Type: "array",
GoName: "DestRegionCodes",
Description: "The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"destThreatIntelligences": &dcl.Property{
Type: "array",
GoName: "DestThreatIntelligences",
Description: "Name of the Google Cloud Threat Intelligence list.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"layer4Configs": &dcl.Property{
Type: "array",
GoName: "Layer4Configs",
Description: "Pairs of IP protocols and ports that the rule should match.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "object",
GoType: "FirewallPolicyRuleMatchLayer4Configs",
Required: []string{
"ipProtocol",
},
Properties: map[string]*dcl.Property{
"ipProtocol": &dcl.Property{
Type: "string",
GoName: "IPProtocol",
Description: "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (`tcp`, `udp`, `icmp`, `esp`, `ah`, `ipip`, `sctp`), or the IP protocol number.",
},
"ports": &dcl.Property{
Type: "array",
GoName: "Ports",
Description: "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
},
},
},
"srcFqdns": &dcl.Property{
Type: "array",
GoName: "SrcFqdns",
Description: "Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"srcIPRanges": &dcl.Property{
Type: "array",
GoName: "SrcIPRanges",
Description: "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"srcRegionCodes": &dcl.Property{
Type: "array",
GoName: "SrcRegionCodes",
Description: "The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
"srcThreatIntelligences": &dcl.Property{
Type: "array",
GoName: "SrcThreatIntelligences",
Description: "Name of the Google Cloud Threat Intelligence list.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
},
},
},
},
"priority": &dcl.Property{
Type: "integer",
Format: "int64",
GoName: "Priority",
Description: "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.",
Immutable: true,
},
"ruleTupleCount": &dcl.Property{
Type: "integer",
Format: "int64",
GoName: "RuleTupleCount",
ReadOnly: true,
Description: "Calculation of the complexity of a single firewall policy rule.",
},
"targetResources": &dcl.Property{
Type: "array",
GoName: "TargetResources",
Description: "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
ResourceReferences: []*dcl.PropertyResourceReference{
&dcl.PropertyResourceReference{
Resource: "Compute/Network",
Field: "selfLink",
},
},
},
},
"targetServiceAccounts": &dcl.Property{
Type: "array",
GoName: "TargetServiceAccounts",
Description: "A list of service accounts indicating the sets of instances that are applied with this rule.",
SendEmpty: true,
ListType: "list",
Items: &dcl.Property{
Type: "string",
GoType: "string",
ResourceReferences: []*dcl.PropertyResourceReference{
&dcl.PropertyResourceReference{
Resource: "Iam/ServiceAccount",
Field: "name",
},
},
},
},
},
},
},
},
},
}
}