gcp_compute_firewall_policy

ancestors

Type: UNORDERED_LIST_STRING

associations

Type: UNORDERED_LIST_STRUCT
Provider name: associations
Description: A list of associations that belong to this firewall policy.

• attachment_target
  Type: STRING
  Provider name: attachmentTarget
  Description: The target that the firewall policy is attached to.
  
• firewall_policy_id
  Type: STRING
  Provider name: firewallPolicyId
  Description: [Output Only] The firewall policy ID of the association.
  
• gcp_display_name
  Type: STRING
  Provider name: displayName
  Description: [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
  
• name
  Type: STRING
  Provider name: name
  Description: The name for an association.
  
• short_name
  Type: STRING
  Provider name: shortName
  Description: [Output Only] The short name of the firewall policy of the association.
  

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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.

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

Type: STRING
Provider name: kind
Description: [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Name of the resource. For Organization Firewall Policies it’s a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

region

Type: STRING
Provider name: region
Description: [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

resource_name

Type: STRING

rule_tuple_count

Type: INT32
Provider name: ruleTupleCount
Description: [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

rules

Type: UNORDERED_LIST_STRUCT
Provider name: rules
Description: A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match “*”). If no rules are provided when creating a firewall policy, a default rule with action “allow” will be added.

• action
  Type: STRING
  Provider name: action
  Description: The Action to perform when the client connection triggers the rule. Valid actions are “allow”, “deny” and “goto_next”.
  
• description
  Type: STRING
  Provider name: description
  Description: An optional description for this resource.
  
• direction
  Type: STRING
  Provider name: direction
  Description: The direction in which this rule applies.
  Possible values:
  
  • EGRESS
  • INGRESS
• disabled
  Type: BOOLEAN
  Provider name: disabled
  Description: Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
  
• enable_logging
  Type: BOOLEAN
  Provider name: enableLogging
  Description: Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on “goto_next” rules.
  
• kind
  Type: STRING
  Provider name: kind
  Description: [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
  
• match
  Type: STRUCT
  Provider name: match
  Description: A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ‘action’ is enforced.
  
  • dest_address_groups
    Type: UNORDERED_LIST_STRING
    Provider name: destAddressGroups
    Description: Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
    
  • dest_fqdns
    Type: UNORDERED_LIST_STRING
    Provider name: destFqdns
    Description: Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
    
  • dest_ip_ranges
    Type: UNORDERED_LIST_STRING
    Provider name: destIpRanges
    Description: CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
    
  • dest_region_codes
    Type: UNORDERED_LIST_STRING
    Provider name: destRegionCodes
    Description: Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.“US” Maximum number of dest region codes allowed is 5000.
    
  • dest_threat_intelligences
    Type: UNORDERED_LIST_STRING
    Provider name: destThreatIntelligences
    Description: Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
    
  • layer4_configs
    Type: UNORDERED_LIST_STRUCT
    Provider name: layer4Configs
    Description: Pairs of IP protocols and ports that the rule should match.
    
    • ip_protocol
      Type: STRING
      Provider name: ipProtocol
      Description: The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
      
    • ports
      Type: UNORDERED_LIST_STRING
      Provider name: ports
      Description: An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [“22”], [“80”,“443”], and [“12345-12349”].
      
  • src_address_groups
    Type: UNORDERED_LIST_STRING
    Provider name: srcAddressGroups
    Description: Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
    
  • src_fqdns
    Type: UNORDERED_LIST_STRING
    Provider name: srcFqdns
    Description: Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
    
  • src_ip_ranges
    Type: UNORDERED_LIST_STRING
    Provider name: srcIpRanges
    Description: CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
    
  • src_region_codes
    Type: UNORDERED_LIST_STRING
    Provider name: srcRegionCodes
    Description: Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.“US” Maximum number of source region codes allowed is 5000.
    
  • src_secure_tags
    Type: UNORDERED_LIST_STRUCT
    Provider name: srcSecureTags
    Description: List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
    
    • name
      Type: STRING
      Provider name: name
      Description: Name of the secure tag, created with TagManager’s TagValue API.
      
    • state
      Type: STRING
      Provider name: state
      Description: [Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted.
      Possible values:
      
      • EFFECTIVE
      • INEFFECTIVE
  • src_threat_intelligences
    Type: UNORDERED_LIST_STRING
    Provider name: srcThreatIntelligences
    Description: Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
    
• priority
  Type: INT32
  Provider name: priority
  Description: An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
  
• rule_name
  Type: STRING
  Provider name: ruleName
  Description: An optional name for the rule. This field is not a unique identifier and can be updated.
  
• rule_tuple_count
  Type: INT32
  Provider name: ruleTupleCount
  Description: [Output Only] Calculation of the complexity of a single firewall policy rule.
  
• target_resources
  Type: UNORDERED_LIST_STRING
  Provider name: targetResources
  Description: A list of network resource URLs to which this rule applies. This field allows you to control which network’s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
  
• target_secure_tags
  Type: UNORDERED_LIST_STRUCT
  Provider name: targetSecureTags
  Description: A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
  
  • name
    Type: STRING
    Provider name: name
    Description: Name of the secure tag, created with TagManager’s TagValue API.
    
  • state
    Type: STRING
    Provider name: state
    Description: [Output Only] State of the secure tag, either EFFECTIVE or INEFFECTIVE. A secure tag is INEFFECTIVE when it is deleted or its network is deleted.
    Possible values:
    
    • EFFECTIVE
    • INEFFECTIVE
• target_service_accounts
  Type: UNORDERED_LIST_STRING
  Provider name: targetServiceAccounts
  Description: A list of service accounts indicating the sets of instances that are applied with this rule.
  

self_link

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.

self_link_with_id

Type: STRING
Provider name: selfLinkWithId
Description: [Output Only] Server-defined URL for this resource with the resource id.

short_name

Type: STRING
Provider name: shortName
Description: User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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.

tags

Type: UNORDERED_LIST_STRING