gcp_compute_subnetwork

ancestors

Type: UNORDERED_LIST_STRING

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. This field can be set only at resource creation time.

enable_flow_logs

Type: BOOLEAN
Provider name: enableFlowLogs
Description: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn’t supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

external_ipv6_prefix

Type: STRING
Provider name: externalIpv6Prefix
Description: The external IPv6 address range that is owned by this subnetwork.

gateway_address

Type: STRING
Provider name: gatewayAddress
Description: [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

id

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

internal_ipv6_prefix

Type: STRING
Provider name: internalIpv6Prefix
Description: [Output Only] The internal IPv6 address range that is assigned to this subnetwork.

ip_cidr_range

Type: STRING
Provider name: ipCidrRange
Description: The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

ipv6_access_type

Type: STRING
Provider name: ipv6AccessType
Description: The access type of IPv6 address this subnet holds. It’s immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.
Possible values:

• EXTERNAL - VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.
  
• INTERNAL - VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.
  

ipv6_cidr_range

Type: STRING
Provider name: ipv6CidrRange
Description: [Output Only] This field is for internal use.

kind

Type: STRING
Provider name: kind
Description: [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

labels

Type: UNORDERED_LIST_STRING

log_config

Type: STRUCT
Provider name: logConfig
Description: This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

• aggregation_interval
  Type: STRING
  Provider name: aggregationInterval
  Description: Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.
  Possible values:
  
  • INTERVAL_10_MIN
  • INTERVAL_15_MIN
  • INTERVAL_1_MIN
  • INTERVAL_30_SEC
  • INTERVAL_5_MIN
  • INTERVAL_5_SEC
• enable
  Type: BOOLEAN
  Provider name: enable
  Description: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn’t supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.
  
• filter_expr
  Type: STRING
  Provider name: filterExpr
  Description: Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.
  
• flow_sampling
  Type: FLOAT
  Provider name: flowSampling
  Description: Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.
  
• metadata
  Type: STRING
  Provider name: metadata
  Description: Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.
  Possible values:
  
  • CUSTOM_METADATA
  • EXCLUDE_ALL_METADATA
  • INCLUDE_ALL_METADATA
• metadata_fields
  Type: UNORDERED_LIST_STRING
  Provider name: metadataFields
  Description: Can only be specified if VPC flow logs for this subnetwork is enabled and “metadata” was set to CUSTOM_METADATA.
  

name

Type: STRING
Provider name: name
Description: The name of the resource, provided by the client when initially creating the resource. 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.

network

Type: STRING
Provider name: network
Description: The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

organization_id

Type: STRING

parent

Type: STRING

private_ip_google_access

Type: BOOLEAN
Provider name: privateIpGoogleAccess
Description: Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.

private_ipv6_google_access

Type: STRING
Provider name: privateIpv6GoogleAccess
Description: This field is for internal use. This field can be both set at resource creation time and updated using patch.
Possible values:

• DISABLE_GOOGLE_ACCESS - Disable private IPv6 access to/from Google services.
  
• ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE - Bidirectional private IPv6 access to/from Google services.
  
• ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE - Outbound private IPv6 access from VMs in this subnet to Google services.
  

project_id

Type: STRING

project_number

Type: STRING

purpose

Type: STRING
Provider name: purpose
Description: The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn’t supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.
Possible values:

• INTERNAL_HTTPS_LOAD_BALANCER - Subnet reserved for Internal HTTP(S) Load Balancing.
  
• PRIVATE - Regular user created or automatically created subnet.
  
• PRIVATE_RFC_1918 - Regular user created or automatically created subnet.
  
• PRIVATE_SERVICE_CONNECT - Subnetworks created for Private Service Connect in the producer network.
  
• REGIONAL_MANAGED_PROXY - Subnetwork used for Regional Internal/External HTTP(S) Load Balancing.
  

region

Type: STRING
Provider name: region
Description: URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

resource_name

Type: STRING

role

Type: STRING
Provider name: role
Description: The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.
Possible values:

• ACTIVE - The ACTIVE subnet that is currently used.
  
• BACKUP - The BACKUP subnet that could be promoted to ACTIVE.
  

secondary_ip_ranges

Type: UNORDERED_LIST_STRUCT
Provider name: secondaryIpRanges
Description: An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.

• ip_cidr_range
  Type: STRING
  Provider name: ipCidrRange
  Description: The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.
  
• range_name
  Type: STRING
  Provider name: rangeName
  Description: The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
  

self_link

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

stack_type

Type: STRING
Provider name: stackType
Description: The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.
Possible values:

• IPV4_IPV6 - New VMs in this subnet can have both IPv4 and IPv6 addresses.
  
• IPV4_ONLY - New VMs in this subnet will only be assigned IPv4 addresses.
  

state

Type: STRING
Provider name: state
Description: [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY
Possible values:

• DRAINING - Subnetwork is being drained.
  
• READY - Subnetwork is ready for use.
  

tags

Type: UNORDERED_LIST_STRING