Skip to main content

security_policies

Creates, updates, deletes, gets or lists a security_policies resource.

Overview​

Namesecurity_policies
TypeResource
Idgoogle.compute.security_policies

Fields​

NameDatatypeDescription
idstring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
adaptiveProtectionConfigobjectConfiguration options for Cloud Armor Adaptive Protection (CAAP).
advancedOptionsConfigobject
creationTimestampstring[Output Only] Creation timestamp in RFC3339 text format.
ddosProtectionConfigobject
fingerprintstringSpecifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
kindstring[Output only] Type of the resource. Always compute#securityPolicyfor security policies
labelFingerprintstringA fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
labelsobjectLabels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
recaptchaOptionsConfigobject
regionstring[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
rulesarrayA list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
selfLinkstring[Output Only] Server-defined URL for the resource.
typestringThe type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
userDefinedFieldsarrayDefinitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"

Methods​

NameAccessible byRequired ParamsDescription
getSELECTproject, securityPolicyList all of the ordered rules present in a single specified policy.
listSELECTprojectList all the policies that have been configured for the specified project.
insertINSERTprojectCreates a new policy in the specified project using the data included in the request.
deleteDELETEproject, securityPolicyDeletes the specified policy.
patchUPDATEproject, securityPolicyPatches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.
patch_ruleUPDATEproject, securityPolicyPatches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
set_labelsEXECproject, resourceSets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

SELECT examples​

List all the policies that have been configured for the specified project.

SELECT
id,
name,
description,
adaptiveProtectionConfig,
advancedOptionsConfig,
creationTimestamp,
ddosProtectionConfig,
fingerprint,
kind,
labelFingerprint,
labels,
recaptchaOptionsConfig,
region,
rules,
selfLink,
type,
userDefinedFields
FROM google.compute.security_policies
WHERE project = '{{ project }}';

INSERT example​

Use the following StackQL query and manifest file to create a new security_policies resource.

/*+ create */
INSERT INTO google.compute.security_policies (
project,
userDefinedFields,
name,
description,
rules,
adaptiveProtectionConfig,
ddosProtectionConfig,
advancedOptionsConfig,
recaptchaOptionsConfig,
fingerprint,
type,
labels,
labelFingerprint,
region
)
SELECT 
'{{ project }}',
'{{ userDefinedFields }}',
'{{ name }}',
'{{ description }}',
'{{ rules }}',
'{{ adaptiveProtectionConfig }}',
'{{ ddosProtectionConfig }}',
'{{ advancedOptionsConfig }}',
'{{ recaptchaOptionsConfig }}',
'{{ fingerprint }}',
'{{ type }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ region }}'
;

UPDATE example​

Updates a security_policies resource.

/*+ update */
UPDATE google.compute.security_policies
SET 
userDefinedFields = '{{ userDefinedFields }}',
name = '{{ name }}',
description = '{{ description }}',
rules = '{{ rules }}',
adaptiveProtectionConfig = '{{ adaptiveProtectionConfig }}',
ddosProtectionConfig = '{{ ddosProtectionConfig }}',
advancedOptionsConfig = '{{ advancedOptionsConfig }}',
recaptchaOptionsConfig = '{{ recaptchaOptionsConfig }}',
fingerprint = '{{ fingerprint }}',
type = '{{ type }}',
labels = '{{ labels }}',
labelFingerprint = '{{ labelFingerprint }}',
region = '{{ region }}'
WHERE 
project = '{{ project }}'
AND securityPolicy = '{{ securityPolicy }}';

DELETE example​

Deletes the specified security_policies resource.

/*+ delete */
DELETE FROM google.compute.security_policies
WHERE project = '{{ project }}'
AND securityPolicy = '{{ securityPolicy }}';