Class Subnetwork (1.15.0)

Subnetwork(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`creation_timestamp`	`str` [Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ `_creation_timestamp`.
`description`	`str` An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. This field is a member of `oneof`_ `_description`.
`enable_flow_logs`	`bool` 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. This field is a member of `oneof`_ `_enable_flow_logs`.
`external_ipv6_prefix`	`str` The external IPv6 address range that is owned by this subnetwork. This field is a member of `oneof`_ `_external_ipv6_prefix`.
`fingerprint`	`str` Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. This field is a member of `oneof`_ `_fingerprint`.
`gateway_address`	`str` [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field is a member of `oneof`_ `_gateway_address`.
`id`	`int` [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ `_id`.
`internal_ipv6_prefix`	`str` [Output Only] The internal IPv6 address range that is assigned to this subnetwork. This field is a member of `oneof`_ `_internal_ipv6_prefix`.
`ip_cidr_range`	`str` 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. This field is a member of `oneof`_ `_ip_cidr_range`.
`ipv6_access_type`	`str` 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. Check the Ipv6AccessType enum for the list of possible values. This field is a member of `oneof`_ `_ipv6_access_type`.
`ipv6_cidr_range`	`str` [Output Only] This field is for internal use. This field is a member of `oneof`_ `_ipv6_cidr_range`.
`kind`	`str` [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. This field is a member of `oneof`_ `_kind`.
`log_config`	`google.cloud.compute_v1.types.SubnetworkLogConfig` This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. This field is a member of `oneof`_ `_log_config`.
`name`	`str` 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. This field is a member of `oneof`_ `_name`.
`network`	`str` 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. This field is a member of `oneof`_ `_network`.
`private_ip_google_access`	`bool` 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. This field is a member of `oneof`_ `_private_ip_google_access`.
`private_ipv6_google_access`	`str` This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values. This field is a member of `oneof`_ `_private_ipv6_google_access`.
`purpose`	`str` 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. Check the Purpose enum for the list of possible values. This field is a member of `oneof`_ `_purpose`.
`region`	`str` URL of the region where the Subnetwork resides. This field can be set only at resource creation time. This field is a member of `oneof`_ `_region`.
`role`	`str` 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. Check the Role enum for the list of possible values. This field is a member of `oneof`_ `_role`.
`secondary_ip_ranges`	`MutableSequence[google.cloud.compute_v1.types.SubnetworkSecondaryRange]` 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.
`self_link`	`str` [Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ `_self_link`.
`stack_type`	`str` 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. Check the StackType enum for the list of possible values. This field is a member of `oneof`_ `_stack_type`.
`state`	`str` [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 Check the State enum for the list of possible values. This field is a member of `oneof`_ `_state`.

Classes

Ipv6AccessType

Ipv6AccessType(value)

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.

Values: UNDEFINED_IPV6_ACCESS_TYPE (0): A value indicating that the enum field is not set. EXTERNAL (35607499): VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network. INTERNAL (279295677): VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network. UNSPECIFIED_IPV6_ACCESS_TYPE (313080613): No description available.

PrivateIpv6GoogleAccess

PrivateIpv6GoogleAccess(value)

This field is for internal use. This field can be both set at resource creation time and updated using patch.

Values: UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS (0): A value indicating that the enum field is not set. DISABLE_GOOGLE_ACCESS (450958579): Disable private IPv6 access to/from Google services. ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE (427975994): Bidirectional private IPv6 access to/from Google services. ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE (288210263): Outbound private IPv6 access from VMs in this subnet to Google services.

Purpose

Purpose(value)

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.

Values: UNDEFINED_PURPOSE (0): A value indicating that the enum field is not set. GLOBAL_MANAGED_PROXY (236463602): Subnet reserved for Global Envoy-based Load Balancing. INTERNAL_HTTPS_LOAD_BALANCER (248748889): Subnet reserved for Internal HTTP(S) Load Balancing. PRIVATE (403485027): Regular user created or automatically created subnet. PRIVATE_NAT (367764517): Subnetwork used as source range for Private NAT Gateways. PRIVATE_RFC_1918 (254902107): Regular user created or automatically created subnet. PRIVATE_SERVICE_CONNECT (48134724): Subnetworks created for Private Service Connect in the producer network. REGIONAL_MANAGED_PROXY (153049966): Subnetwork used for Regional Envoy-based Load Balancing.

Role

Role(value)

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.

Values: UNDEFINED_ROLE (0): A value indicating that the enum field is not set. ACTIVE (314733318): The ACTIVE subnet that is currently used. BACKUP (341010882): The BACKUP subnet that could be promoted to ACTIVE.

StackType

StackType(value)

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.

Values: UNDEFINED_STACK_TYPE (0): A value indicating that the enum field is not set. IPV4_IPV6 (22197249): New VMs in this subnet can have both IPv4 and IPv6 addresses. IPV4_ONLY (22373798): New VMs in this subnet will only be assigned IPv4 addresses. UNSPECIFIED_STACK_TYPE (298084569): No description available.

State

State(value)

[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

Values: UNDEFINED_STATE (0): A value indicating that the enum field is not set. DRAINING (480455402): Subnetwork is being drained. READY (77848963): Subnetwork is ready for use.