# Class IPAllocationPolicy (2.65.0)

2.65.0 (latest) 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.1 2.55.1 2.54.0 2.53.0 2.52.0 2.50.0 2.49.0 2.48.0 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.4 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.2 2.10.8 2.9.0 2.8.1 2.7.1 2.6.1 2.5.0 2.4.1 2.3.1 2.2.0 2.1.0 2.0.1 1.0.3 0.5.0 0.4.0 0.3.0

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

Configuration for controlling how IPs are allocated in the
cluster.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `use_ip_aliases` | `bool` Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode |
| `create_subnetwork` | `bool` Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. |
| `subnetwork_name` | `str` A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. |
| `cluster_ipv4_cidr` | `str` This field is deprecated, use cluster_ipv4_cidr_block. |
| `node_ipv4_cidr` | `str` This field is deprecated, use node_ipv4_cidr_block. |
| `services_ipv4_cidr` | `str` This field is deprecated, use services_ipv4_cidr_block. |
| `cluster_secondary_range_name` | `str` The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. |
| `services_secondary_range_name` | `str` The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. |
| `cluster_ipv4_cidr_block` | `str` The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a `CIDR `__ notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. |
| `node_ipv4_cidr_block` | `str` The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a `CIDR `__ notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. |
| `services_ipv4_cidr_block` | `str` The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a `CIDR `__ notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. |
| `allow_route_overlap` | `bool` If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. |
| `tpu_ipv4_cidr_block` | `str` The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a `CIDR `__ notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. |
| `use_routes` | `bool` Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode |
| `stack_type` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.IPAllocationPolicy.StackType` IP stack type |
| `ipv6_access_type` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.IPAllocationPolicy.IPv6AccessType` The ipv6 access type (internal or external) when create_subnetwork is true |
| `pod_cidr_overprovision_config` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.PodCIDROverprovisionConfig` \[PRIVATE FIELD\] Pod CIDR size overprovisioning config for the cluster. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. |
| `subnet_ipv6_cidr_block` | `str` Output only. The subnet's IPv6 CIDR block used by nodes and pods. |
| `services_ipv6_cidr_block` | `str` Output only. The services IPv6 CIDR block for the cluster. |
| `additional_pod_ranges_config` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.AdditionalPodRangesConfig` Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. |
| `default_pod_ipv4_range_utilization` | `float` Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/\[Total number of IPs in the secondary range\], Usage=numNodes\\ \*numZones\*\\ podIPsPerNode. |
| `additional_ip_ranges_configs` | `MutableSequence[https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.AdditionalIPRangesConfig]` Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. |
| `auto_ipam_config` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.AutoIpamConfig` Optional. AutoIpamConfig contains all information related to Auto IPAM |
| `network_tier_config` | `https://docs.cloud.google.com/python/docs/reference/container/latest/google.cloud.container_v1beta1.types.NetworkTierConfig` Cluster-level network tier configuration is used to determine the default network tier for external IP addresses on cluster resources, such as node pools and load balancers. |

## Classes

### IPv6AccessType

    IPv6AccessType(value)

IPv6 access type

### StackType

    StackType(value)

Possible values for IP stack type