|
| 1 | +# Copyright 2024 Google Inc. |
| 2 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +# you may not use this file except in compliance with the License. |
| 4 | +# You may obtain a copy of the License at |
| 5 | +# |
| 6 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +# |
| 8 | +# Unless required by applicable law or agreed to in writing, software |
| 9 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +# See the License for the specific language governing permissions and |
| 12 | +# limitations under the License. |
| 13 | + |
| 14 | +--- |
| 15 | +name: Application |
| 16 | +description: Specifies application endpoint(s) to protect behind a Security Gateway. |
| 17 | +base_url: projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications |
| 18 | +update_mask: true |
| 19 | +self_link: projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications/{{application_id}} |
| 20 | +create_url: projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications?applicationId={{application_id}} |
| 21 | +update_verb: PATCH |
| 22 | +id_format: projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications/{{application_id}} |
| 23 | +import_format: |
| 24 | + - projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications/{{application_id}} |
| 25 | +iam_policy: |
| 26 | + method_name_separator: ':' |
| 27 | + iam_conditions_request_type: 'QUERY_PARAM_NESTED' |
| 28 | + allowed_iam_role: 'roles/beyondcorp.securityGatewayUser' |
| 29 | + parent_resource_attribute: 'application_id' |
| 30 | + import_format: |
| 31 | + - 'projects/{{project}}/locations/global/securityGateways/{{security_gateways_id}}/applications/{{application_id}}' |
| 32 | + - '{{application_id}}' |
| 33 | +examples: |
| 34 | + - name: beyondcorp_security_gateway_application_basic |
| 35 | + primary_resource_id: example |
| 36 | + primary_resource_name: 'fmt.Sprintf("default%s", context["random_suffix"]), fmt.Sprintf("google%s", context["random_suffix"])' |
| 37 | + vars: |
| 38 | + security_gateway_name: default |
| 39 | + application_name: google |
| 40 | +autogen_async: true |
| 41 | +async: |
| 42 | + operation: |
| 43 | + timeouts: |
| 44 | + insert_minutes: 20 |
| 45 | + update_minutes: 20 |
| 46 | + delete_minutes: 20 |
| 47 | + base_url: '{{op_id}}' |
| 48 | + actions: |
| 49 | + - create |
| 50 | + - delete |
| 51 | + - update |
| 52 | + type: OpAsync |
| 53 | + result: |
| 54 | + resource_inside_response: true |
| 55 | + error: {} |
| 56 | + include_project: false |
| 57 | +autogen_status: QXBwbGljYXRpb24= |
| 58 | +parameters: |
| 59 | + - name: securityGatewaysId |
| 60 | + type: String |
| 61 | + description: Part of `parent`. See documentation of `projectsId`. |
| 62 | + immutable: true |
| 63 | + url_param_only: true |
| 64 | + required: true |
| 65 | + - name: applicationId |
| 66 | + type: String |
| 67 | + description: |- |
| 68 | + Optional. User-settable Application resource ID. |
| 69 | + * Must start with a letter. |
| 70 | + * Must contain between 4-63 characters from `/a-z-/`. |
| 71 | + * Must end with a number or letter. |
| 72 | + immutable: true |
| 73 | + url_param_only: true |
| 74 | + required: true |
| 75 | +properties: |
| 76 | + - name: createTime |
| 77 | + type: String |
| 78 | + description: Output only. Timestamp when the resource was created. |
| 79 | + output: true |
| 80 | + - name: displayName |
| 81 | + type: String |
| 82 | + description: |- |
| 83 | + Optional. An arbitrary user-provided name for the Application resource. |
| 84 | + Cannot exceed 64 characters. |
| 85 | + - name: endpointMatchers |
| 86 | + type: Array |
| 87 | + description: |- |
| 88 | + Required. Endpoint matchers associated with an application. |
| 89 | + A combination of hostname and ports as endpoint matcher is used to match |
| 90 | + the application. |
| 91 | + Match conditions for OR logic. |
| 92 | + An array of match conditions to allow for multiple matching criteria. |
| 93 | + The rule is considered a match if one the conditions are met. |
| 94 | + The conditions can be one of the following combination |
| 95 | + (Hostname), (Hostname & Ports) |
| 96 | +
|
| 97 | + EXAMPLES: |
| 98 | + Hostname - ("*.abc.com"), ("xyz.abc.com") |
| 99 | + Hostname and Ports - ("abc.com" and "22"), ("abc.com" and "22,33") etc |
| 100 | + required: true |
| 101 | + item_type: |
| 102 | + type: NestedObject |
| 103 | + properties: |
| 104 | + - name: hostname |
| 105 | + type: String |
| 106 | + description: Required. Hostname of the application. |
| 107 | + required: true |
| 108 | + - name: ports |
| 109 | + type: Array |
| 110 | + description: Optional. Ports of the application. |
| 111 | + item_type: |
| 112 | + type: Integer |
| 113 | + - name: name |
| 114 | + type: String |
| 115 | + description: Identifier. Name of the resource. |
| 116 | + output: true |
| 117 | + - name: updateTime |
| 118 | + type: String |
| 119 | + description: Output only. Timestamp when the resource was last modified. |
| 120 | + output: true |
0 commit comments