Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::SecurityPolicy (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::SecurityPolicy.

Represents a Google Cloud Armor security policy resource.

Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#adaptive_protection_config

def adaptive_protection_config() -> ::Google::Cloud::Compute::V1::SecurityPolicyAdaptiveProtectionConfig
Returns

#adaptive_protection_config=

def adaptive_protection_config=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyAdaptiveProtectionConfig
Parameter
Returns

#advanced_options_config

def advanced_options_config() -> ::Google::Cloud::Compute::V1::SecurityPolicyAdvancedOptionsConfig
Returns

#advanced_options_config=

def advanced_options_config=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyAdvancedOptionsConfig
Parameter
Returns

#associations

def associations() -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyAssociation>
Returns

#associations=

def associations=(value) -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyAssociation>
Parameter
Returns

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#ddos_protection_config

def ddos_protection_config() -> ::Google::Cloud::Compute::V1::SecurityPolicyDdosProtectionConfig
Returns

#ddos_protection_config=

def ddos_protection_config=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyDdosProtectionConfig
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#fingerprint

def fingerprint() -> ::String
Returns
  • (::String) — Specifies 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 error412 conditionNotMet.

    To see the latest fingerprint, make get() request to the security policy.

#fingerprint=

def fingerprint=(value) -> ::String
Parameter
  • value (::String) — Specifies 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 error412 conditionNotMet.

    To see the latest fingerprint, make get() request to the security policy.

Returns
  • (::String) — Specifies 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 error412 conditionNotMet.

    To see the latest fingerprint, make get() request to the security policy.

#id

def id() -> ::Integer
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies
Returns
  • (::String) — Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::String) — A 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.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::String) — A 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.

Returns
  • (::String) — A 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

#name

def name() -> ::String
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Output only. [Output Only] The parent of the security policy.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] The parent of the security policy.
Returns
  • (::String) — Output only. [Output Only] The parent of the security policy.

#recaptcha_options_config

def recaptcha_options_config() -> ::Google::Cloud::Compute::V1::SecurityPolicyRecaptchaOptionsConfig
Returns

#recaptcha_options_config=

def recaptcha_options_config=(value) -> ::Google::Cloud::Compute::V1::SecurityPolicyRecaptchaOptionsConfig
Parameter
Returns

#region

def region() -> ::String
Returns
  • (::String) — Output only. [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
Returns
  • (::String) — Output only. [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

#rules

def rules() -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyRule>
Returns
  • (::Array<::Google::Cloud::Compute::V1::SecurityPolicyRule>) — A 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.

#rules=

def rules=(value) -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyRule>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::SecurityPolicyRule>) — A 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.
Returns
  • (::Array<::Google::Cloud::Compute::V1::SecurityPolicyRule>) — A 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.

#self_link

def self_link() -> ::String
Returns
  • (::String) — Output only. [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — Output only. [Output Only] Server-defined URL for the resource.

#short_name

def short_name() -> ::String
Returns
  • (::String) — User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

#short_name=

def short_name=(value) -> ::String
Parameter
  • value (::String) — User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.
Returns
  • (::String) — User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

#type

def type() -> ::String
Returns
  • (::String) — The 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 (preview only): 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. Check the Type enum for the list of possible values.

#type=

def type=(value) -> ::String
Parameter
  • value (::String) — The 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 (preview only): 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. Check the Type enum for the list of possible values.

Returns
  • (::String) — The 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 (preview only): 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. Check the Type enum for the list of possible values.

#user_defined_fields

def user_defined_fields() -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyUserDefinedField>
Returns
  • (::Array<::Google::Cloud::Compute::V1::SecurityPolicyUserDefinedField>) —

    Definitions 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"

#user_defined_fields=

def user_defined_fields=(value) -> ::Array<::Google::Cloud::Compute::V1::SecurityPolicyUserDefinedField>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::SecurityPolicyUserDefinedField>) —

    Definitions 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"
Returns
  • (::Array<::Google::Cloud::Compute::V1::SecurityPolicyUserDefinedField>) —

    Definitions 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"