Class: Google::Apis::ComputeAlpha::SecurityPolicy
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::SecurityPolicy
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#adaptive_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdaptiveProtectionConfig
Configuration options for Cloud Armor Adaptive Protection (CAAP).
-
#advanced_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdvancedOptionsConfig
Corresponds to the JSON property
advancedOptionsConfig
. -
#associations ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyAssociation>
A list of associations that belong to this policy.
-
#cloud_armor_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyCloudArmorConfig
Configuration options for Cloud Armor.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#ddos_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyDdosProtectionConfig
Corresponds to the JSON property
ddosProtectionConfig
. -
#description ⇒ String
An optional description of this resource.
-
#display_name ⇒ String
User-provided name of the Organization security plicy.
-
#fingerprint ⇒ String
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output only] Type of the resource.
-
#label_fingerprint ⇒ 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.
-
#labels ⇒ Hash<String,String>
Labels for this resource.
-
#name ⇒ String
Name of the resource.
-
#parent ⇒ String
[Output Only] The parent of the security policy.
-
#recaptcha_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRecaptchaOptionsConfig
Corresponds to the JSON property
recaptchaOptionsConfig
. -
#region ⇒ String
[Output Only] URL of the region where the regional security policy resides.
-
#rule_tuple_count ⇒ Fixnum
[Output Only] Total count of all security policy rule tuples.
-
#rules ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyRule>
A list of rules that belong to this policy.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#type ⇒ String
The type indicates the intended use of the security policy.
-
#user_defined_fields ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyUserDefinedField>
Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SecurityPolicy
constructor
A new instance of SecurityPolicy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SecurityPolicy
Returns a new instance of SecurityPolicy.
41025 41026 41027 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41025 def initialize(**args) update!(**args) end |
Instance Attribute Details
#adaptive_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdaptiveProtectionConfig
Configuration options for Cloud Armor Adaptive Protection (CAAP).
Corresponds to the JSON property adaptiveProtectionConfig
40857 40858 40859 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40857 def adaptive_protection_config @adaptive_protection_config end |
#advanced_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdvancedOptionsConfig
Corresponds to the JSON property advancedOptionsConfig
40862 40863 40864 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40862 def @advanced_options_config end |
#associations ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyAssociation>
A list of associations that belong to this policy.
Corresponds to the JSON property associations
40867 40868 40869 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40867 def associations @associations end |
#cloud_armor_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyCloudArmorConfig
Configuration options for Cloud Armor.
Corresponds to the JSON property cloudArmorConfig
40872 40873 40874 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40872 def cloud_armor_config @cloud_armor_config end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
40877 40878 40879 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40877 def @creation_timestamp end |
#ddos_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyDdosProtectionConfig
Corresponds to the JSON property ddosProtectionConfig
40882 40883 40884 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40882 def ddos_protection_config @ddos_protection_config end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
40888 40889 40890 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40888 def description @description end |
#display_name ⇒ String
User-provided name of the Organization security plicy. The name should be
unique in the organization in which the security policy is created. This
should only be used when SecurityPolicyType is FIREWALL. 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.
Corresponds to the JSON property displayName
40900 40901 40902 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40900 def display_name @display_name end |
#fingerprint ⇒ 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 error 412 conditionNotMet. To see the latest fingerprint, make get()
request to the security policy.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
40912 40913 40914 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40912 def fingerprint @fingerprint end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
40918 40919 40920 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40918 def id @id end |
#kind ⇒ String
[Output only] Type of the resource. Always compute#securityPolicyfor security
policies
Corresponds to the JSON property kind
40924 40925 40926 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40924 def kind @kind end |
#label_fingerprint ⇒ 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.
Corresponds to the JSON property labelFingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
40935 40936 40937 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40935 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels 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.
Corresponds to the JSON property labels
40942 40943 40944 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40942 def labels @labels end |
#name ⇒ String
Name 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.
Corresponds to the JSON property name
40952 40953 40954 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40952 def name @name end |
#parent ⇒ String
[Output Only] The parent of the security policy.
Corresponds to the JSON property parent
40957 40958 40959 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40957 def parent @parent end |
#recaptcha_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRecaptchaOptionsConfig
Corresponds to the JSON property recaptchaOptionsConfig
40962 40963 40964 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40962 def @recaptcha_options_config end |
#region ⇒ String
[Output Only] URL of the region where the regional security policy resides.
This field is not applicable to global security policies.
Corresponds to the JSON property region
40968 40969 40970 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40968 def region @region end |
#rule_tuple_count ⇒ Fixnum
[Output Only] Total count of all security policy rule tuples. A security
policy can not exceed a set number of tuples.
Corresponds to the JSON property ruleTupleCount
40974 40975 40976 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40974 def rule_tuple_count @rule_tuple_count end |
#rules ⇒ Array<Google::Apis::ComputeAlpha::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.
Corresponds to the JSON property rules
40984 40985 40986 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40984 def rules @rules end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
40989 40990 40991 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40989 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
40994 40995 40996 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 40994 def self_link_with_id @self_link_with_id end |
#type ⇒ 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: 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.
Corresponds to the JSON property type
41013 41014 41015 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41013 def type @type end |
#user_defined_fields ⇒ Array<Google::Apis::ComputeAlpha::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"
Corresponds to the JSON property userDefinedFields
41023 41024 41025 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41023 def user_defined_fields @user_defined_fields end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
41030 41031 41032 41033 41034 41035 41036 41037 41038 41039 41040 41041 41042 41043 41044 41045 41046 41047 41048 41049 41050 41051 41052 41053 41054 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 41030 def update!(**args) @adaptive_protection_config = args[:adaptive_protection_config] if args.key?(:adaptive_protection_config) @advanced_options_config = args[:advanced_options_config] if args.key?(:advanced_options_config) @associations = args[:associations] if args.key?(:associations) @cloud_armor_config = args[:cloud_armor_config] if args.key?(:cloud_armor_config) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @ddos_protection_config = args[:ddos_protection_config] if args.key?(:ddos_protection_config) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @recaptcha_options_config = args[:recaptcha_options_config] if args.key?(:recaptcha_options_config) @region = args[:region] if args.key?(:region) @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count) @rules = args[:rules] if args.key?(:rules) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @type = args[:type] if args.key?(:type) @user_defined_fields = args[:user_defined_fields] if args.key?(:user_defined_fields) end |