IPAllocationPolicyResponse class

Configuration for controlling how IPs are allocated in the cluster.

Constructors

IPAllocationPolicyResponse({required Input<AdditionalPodRangesConfigResponse> additionalPodRangesConfig, required Input<String> clusterIpv4Cidr, required Input<String> clusterIpv4CidrBlock, required Input<String> clusterSecondaryRangeName, required Input<bool> createSubnetwork, required Input<double> defaultPodIpv4RangeUtilization, required Input<String> ipv6AccessType, required Input<String> nodeIpv4Cidr, required Input<String> nodeIpv4CidrBlock, required Input<PodCIDROverprovisionConfigResponse> podCidrOverprovisionConfig, required Input<String> servicesIpv4Cidr, required Input<String> servicesIpv4CidrBlock, required Input<String> servicesIpv6CidrBlock, required Input<String> servicesSecondaryRangeName, required Input<String> stackType, required Input<String> subnetIpv6CidrBlock, required Input<String> subnetworkName, required Input<String> tpuIpv4CidrBlock, required Input<bool> useIpAliases, required Input<bool> useRoutes})

Creates a new IPAllocationPolicyResponse. 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. clusterIpv4Cidr This field is deprecated, use cluster_ipv4_cidr_block. clusterIpv4CidrBlock 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. clusterSecondaryRangeName 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 is true and create_subnetwork is false. createSubnetwork Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true. defaultPodIpv4RangeUtilization 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=numNodesnumZonespodIPsPerNode. ipv6AccessType The ipv6 access type (internal or external) when create_subnetwork is true nodeIpv4Cidr This field is deprecated, use node_ipv4_cidr_block. nodeIpv4CidrBlock 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. 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. servicesIpv4Cidr This field is deprecated, use services_ipv4_cidr_block. servicesIpv4CidrBlock 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. servicesIpv6CidrBlock Output only The services IPv6 CIDR block for the cluster. servicesSecondaryRangeName 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 is true and create_subnetwork is false. stackType The IP stack type of the cluster subnetIpv6CidrBlock Output only The subnet's IPv6 CIDR block used by nodes and pods. subnetworkName 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. tpuIpv4CidrBlock 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. useIpAliases 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 useRoutes 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

const

IPAllocationPolicyResponse.fromMap(Map<String, dynamic> map)

factory

Properties

additionalPodRangesConfig → Input<AdditionalPodRangesConfigResponse>

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.

final

clusterIpv4Cidr → Input<String>

This field is deprecated, use cluster_ipv4_cidr_block.

final

clusterIpv4CidrBlock → Input<String>

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.

final

clusterSecondaryRangeName → Input<String>

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 is true and create_subnetwork is false.

final

createSubnetwork → Input<bool>

Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true.

final

defaultPodIpv4RangeUtilization → Input<double>

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=numNodesnumZonespodIPsPerNode.

final

hashCode → int

The hash code for this object.

no setter, inherited

ipv6AccessType → Input<String>

The ipv6 access type (internal or external) when create_subnetwork is true

final

nodeIpv4Cidr → Input<String>

This field is deprecated, use node_ipv4_cidr_block.

final

nodeIpv4CidrBlock → Input<String>

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.

final

podCidrOverprovisionConfig → Input<PodCIDROverprovisionConfigResponse>

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

servicesIpv4Cidr → Input<String>

This field is deprecated, use services_ipv4_cidr_block.

final

servicesIpv4CidrBlock → Input<String>

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.

final

servicesIpv6CidrBlock → Input<String>

Output only The services IPv6 CIDR block for the cluster.

final

servicesSecondaryRangeName → Input<String>

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 is true and create_subnetwork is false.

final

stackType → Input<String>

The IP stack type of the cluster

final

subnetIpv6CidrBlock → Input<String>

Output only The subnet's IPv6 CIDR block used by nodes and pods.

final

subnetworkName → Input<String>

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.

final

tpuIpv4CidrBlock → Input<String>

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.

final

useIpAliases → Input<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

final

useRoutes → Input<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

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited