Class: Google::Apis::ComputeAlpha::SecurityPolicy

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecurityPolicy

Returns a new instance of SecurityPolicy.



42877
42878
42879
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42877

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

Returns:



42709
42710
42711
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42709

def adaptive_protection_config
  @adaptive_protection_config
end

#advanced_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdvancedOptionsConfig

Corresponds to the JSON property advancedOptionsConfig

Returns:



42714
42715
42716
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42714

def advanced_options_config
  @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

Returns:



42719
42720
42721
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42719

def associations
  @associations
end

#cloud_armor_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyCloudArmorConfig

Configuration options for Cloud Armor. Corresponds to the JSON property cloudArmorConfig

Returns:



42724
42725
42726
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42724

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

Returns:

  • (String) 


42729
42730
42731
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42729

def creation_timestamp
  @creation_timestamp
end

#ddos_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyDdosProtectionConfig

Corresponds to the JSON property ddosProtectionConfig

Returns:



42734
42735
42736
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42734

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

Returns:

  • (String) 


42740
42741
42742
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42740

def description
  @description
end

#display_name ⇒ 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 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

Returns:

  • (String) 


42752
42753
42754
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42752

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.

Returns:

  • (String) 


42764
42765
42766
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42764

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

Returns:

  • (Fixnum) 


42770
42771
42772
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42770

def id
  @id
end

#kind ⇒ String

[Output only] Type of the resource. Always compute#securityPolicyfor security policies Corresponds to the JSON property kind

Returns:

  • (String) 


42776
42777
42778
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42776

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.

Returns:

  • (String) 


42787
42788
42789
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42787

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

Returns:

  • (Hash<String,String>) 


42794
42795
42796
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42794

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

Returns:

  • (String) 


42804
42805
42806
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42804

def name
  @name
end

#parent ⇒ String

[Output Only] The parent of the security policy. Corresponds to the JSON property parent

Returns:

  • (String) 


42809
42810
42811
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42809

def parent
  @parent
end

#recaptcha_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyRecaptchaOptionsConfig

Corresponds to the JSON property recaptchaOptionsConfig

Returns:



42814
42815
42816
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42814

def recaptcha_options_config
  @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

Returns:

  • (String) 


42820
42821
42822
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42820

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

Returns:

  • (Fixnum) 


42826
42827
42828
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42826

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

Returns:



42836
42837
42838
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42836

def rules
  @rules
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


42841
42842
42843
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42841

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

Returns:

  • (String) 


42846
42847
42848
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42846

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

Returns:

  • (String) 


42865
42866
42867
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42865

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

Returns:



42875
42876
42877
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42875

def user_defined_fields
  @user_defined_fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



42882
42883
42884
42885
42886
42887
42888
42889
42890
42891
42892
42893
42894
42895
42896
42897
42898
42899
42900
42901
42902
42903
42904
42905
42906
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42882

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