ClusterUpdate class

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Constructors

ClusterUpdate({Input<AdditionalPodRangesConfig>? additionalPodRangesConfig, Input<AddonsConfig>? desiredAddonsConfig, Input<AuthenticatorGroupsConfig>? desiredAuthenticatorGroupsConfig, Input<WorkloadPolicyConfig>? desiredAutopilotWorkloadPolicyConfig, Input<BinaryAuthorization>? desiredBinaryAuthorization, Input<ClusterAutoscaling>? desiredClusterAutoscaling, Input<CostManagementConfig>? desiredCostManagementConfig, Input<DatabaseEncryption>? desiredDatabaseEncryption, Input<ClusterUpdateDesiredDatapathProvider>? desiredDatapathProvider, Input<DefaultSnatStatus>? desiredDefaultSnatStatus, Input<DNSConfig>? desiredDnsConfig, Input<bool>? desiredEnableFqdnNetworkPolicy, Input<bool>? desiredEnablePrivateEndpoint, Input<Fleet>? desiredFleet, Input<GatewayAPIConfig>? desiredGatewayApiConfig, Input<GcfsConfig>? desiredGcfsConfig, Input<IdentityServiceConfig>? desiredIdentityServiceConfig, Input<String>? desiredImageType, Input<IntraNodeVisibilityConfig>? desiredIntraNodeVisibilityConfig, Input<K8sBetaAPIConfig>? desiredK8sBetaApis, Input<ILBSubsettingConfig>? desiredL4ilbSubsettingConfig, Input<List<String>>? desiredLocations, Input<LoggingConfig>? desiredLoggingConfig, Input<String>? desiredLoggingService, Input<MasterAuthorizedNetworksConfig>? desiredMasterAuthorizedNetworksConfig, Input<String>? desiredMasterVersion, Input<MeshCertificates>? desiredMeshCertificates, Input<MonitoringConfig>? desiredMonitoringConfig, Input<String>? desiredMonitoringService, Input<ClusterNetworkPerformanceConfig>? desiredNetworkPerformanceConfig, Input<NetworkTags>? desiredNodePoolAutoConfigNetworkTags, Input<ResourceManagerTags>? desiredNodePoolAutoConfigResourceManagerTags, Input<NodePoolAutoscaling>? desiredNodePoolAutoscaling, Input<String>? desiredNodePoolId, Input<NodePoolLoggingConfig>? desiredNodePoolLoggingConfig, Input<String>? desiredNodeVersion, Input<NotificationConfig>? desiredNotificationConfig, Input<ParentProductConfig>? desiredParentProductConfig, Input<PrivateClusterConfig>? desiredPrivateClusterConfig, Input<ClusterUpdateDesiredPrivateIpv6GoogleAccess>? desiredPrivateIpv6GoogleAccess, Input<ReleaseChannel>? desiredReleaseChannel, Input<ResourceUsageExportConfig>? desiredResourceUsageExportConfig, Input<SecurityPostureConfig>? desiredSecurityPostureConfig, Input<ServiceExternalIPsConfig>? desiredServiceExternalIpsConfig, Input<ShieldedNodes>? desiredShieldedNodes, Input<ClusterUpdateDesiredStackType>? desiredStackType, Input<VerticalPodAutoscaling>? desiredVerticalPodAutoscaling, Input<WorkloadIdentityConfig>? desiredWorkloadIdentityConfig, Input<K8sBetaAPIConfig>? enableK8sBetaApis, Input<String>? etag, Input<AdditionalPodRangesConfig>? removedAdditionalPodRangesConfig})
Creates a new ClusterUpdate. additionalPodRangesConfig The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. desiredAddonsConfig Configurations for the various addons available to run in the cluster. desiredAuthenticatorGroupsConfig The desired authenticator groups config for the cluster. desiredAutopilotWorkloadPolicyConfig The desired workload policy configuration for the autopilot cluster. desiredBinaryAuthorization The desired configuration options for the Binary Authorization feature. desiredClusterAutoscaling Cluster-level autoscaling configuration. desiredCostManagementConfig The desired configuration for the fine-grained cost management feature. desiredDatabaseEncryption Configuration of etcd encryption. desiredDatapathProvider The desired datapath provider for the cluster. desiredDefaultSnatStatus The desired status of whether to disable default sNAT for this cluster. desiredDnsConfig DNSConfig contains clusterDNS config for this cluster. desiredEnableFqdnNetworkPolicy Enable/Disable FQDN Network Policy for the cluster. desiredEnablePrivateEndpoint Enable/Disable private endpoint for the cluster's master. desiredFleet The desired fleet configuration for the cluster. desiredGatewayApiConfig The desired config of Gateway API on this cluster. desiredGcfsConfig The desired GCFS config for the cluster desiredIdentityServiceConfig The desired Identity Service component configuration. desiredImageType The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. desiredIntraNodeVisibilityConfig The desired config of Intra-node visibility. desiredK8sBetaApis Desired Beta APIs to be enabled for cluster. desiredL4ilbSubsettingConfig The desired L4 Internal Load Balancer Subsetting configuration. desiredLocations The desired list of Google Compute Engine zones in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. desiredLoggingConfig The desired logging configuration. desiredLoggingService The logging service the cluster should use to write logs. Currently available options: * logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model * logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). * none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions. desiredMasterAuthorizedNetworksConfig The desired configuration options for master authorized networks feature. desiredMasterVersion The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version desiredMeshCertificates Configuration for issuance of mTLS keys and certificates to Kubernetes pods. desiredMonitoringConfig The desired monitoring configuration. desiredMonitoringService The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions. desiredNetworkPerformanceConfig The desired network performance config. desiredNodePoolAutoConfigNetworkTags The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. desiredNodePoolAutoConfigResourceManagerTags The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. desiredNodePoolAutoscaling Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. desiredNodePoolId The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. desiredNodePoolLoggingConfig The desired node pool logging configuration defaults for the cluster. desiredNodeVersion The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version desiredNotificationConfig The desired notification configuration. desiredParentProductConfig The desired parent product config for the cluster. desiredPrivateClusterConfig The desired private cluster configuration. desiredPrivateIpv6GoogleAccess The desired state of IPv6 connectivity to Google Services. desiredReleaseChannel The desired release channel configuration. desiredResourceUsageExportConfig The desired configuration for exporting resource usage. desiredSecurityPostureConfig Enable/Disable Security Posture API features for the cluster. desiredServiceExternalIpsConfig ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field. desiredShieldedNodes Configuration for Shielded Nodes. desiredStackType The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type. desiredVerticalPodAutoscaling Cluster-level Vertical Pod Autoscaling configuration. desiredWorkloadIdentityConfig Configuration for Workload Identity. enableK8sBetaApis Kubernetes open source beta apis enabled on the cluster. Only beta apis etag The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. removedAdditionalPodRangesConfig The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.
const
ClusterUpdate.fromMap(Map<String, dynamic> map)
factory

Properties

additionalPodRangesConfig → Input<AdditionalPodRangesConfig>?
The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
final
desiredAddonsConfig → Input<AddonsConfig>?
Configurations for the various addons available to run in the cluster.
final
desiredAuthenticatorGroupsConfig → Input<AuthenticatorGroupsConfig>?
The desired authenticator groups config for the cluster.
final
desiredAutopilotWorkloadPolicyConfig → Input<WorkloadPolicyConfig>?
The desired workload policy configuration for the autopilot cluster.
final
desiredBinaryAuthorization → Input<BinaryAuthorization>?
The desired configuration options for the Binary Authorization feature.
final
desiredClusterAutoscaling → Input<ClusterAutoscaling>?
Cluster-level autoscaling configuration.
final
desiredCostManagementConfig → Input<CostManagementConfig>?
The desired configuration for the fine-grained cost management feature.
final
desiredDatabaseEncryption → Input<DatabaseEncryption>?
Configuration of etcd encryption.
final
desiredDatapathProvider → Input<ClusterUpdateDesiredDatapathProvider>?
The desired datapath provider for the cluster.
final
desiredDefaultSnatStatus → Input<DefaultSnatStatus>?
The desired status of whether to disable default sNAT for this cluster.
final
desiredDnsConfig → Input<DNSConfig>?
DNSConfig contains clusterDNS config for this cluster.
final
desiredEnableFqdnNetworkPolicy → Input<bool>?
Enable/Disable FQDN Network Policy for the cluster.
final
desiredEnablePrivateEndpoint → Input<bool>?
Enable/Disable private endpoint for the cluster's master.
final
desiredFleet → Input<Fleet>?
The desired fleet configuration for the cluster.
final
desiredGatewayApiConfig → Input<GatewayAPIConfig>?
The desired config of Gateway API on this cluster.
final
desiredGcfsConfig → Input<GcfsConfig>?
The desired GCFS config for the cluster
final
desiredIdentityServiceConfig → Input<IdentityServiceConfig>?
The desired Identity Service component configuration.
final
desiredImageType → Input<String>?
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
final
desiredIntraNodeVisibilityConfig → Input<IntraNodeVisibilityConfig>?
The desired config of Intra-node visibility.
final
desiredK8sBetaApis → Input<K8sBetaAPIConfig>?
Desired Beta APIs to be enabled for cluster.
final
desiredL4ilbSubsettingConfig → Input<ILBSubsettingConfig>?
The desired L4 Internal Load Balancer Subsetting configuration.
final
desiredLocations → Input<List<String>>?
The desired list of Google Compute Engine zones in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
final
desiredLoggingConfig → Input<LoggingConfig>?
The desired logging configuration.
final
desiredLoggingService → Input<String>?
The logging service the cluster should use to write logs. Currently available options: * logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model * logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). * none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
final
desiredMasterAuthorizedNetworksConfig → Input<MasterAuthorizedNetworksConfig>?
The desired configuration options for master authorized networks feature.
final
desiredMasterVersion → Input<String>?
The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version
final
desiredMeshCertificates → Input<MeshCertificates>?
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
final
desiredMonitoringConfig → Input<MonitoringConfig>?
The desired monitoring configuration.
final
desiredMonitoringService → Input<String>?
The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
final
desiredNetworkPerformanceConfig → Input<ClusterNetworkPerformanceConfig>?
The desired network performance config.
final
desiredNodePoolAutoConfigNetworkTags → Input<NetworkTags>?
The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
final
desiredNodePoolAutoConfigResourceManagerTags → Input<ResourceManagerTags>?
The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
final
desiredNodePoolAutoscaling → Input<NodePoolAutoscaling>?
Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
final
desiredNodePoolId → Input<String>?
The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
final
desiredNodePoolLoggingConfig → Input<NodePoolLoggingConfig>?
The desired node pool logging configuration defaults for the cluster.
final
desiredNodeVersion → Input<String>?
The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
final
desiredNotificationConfig → Input<NotificationConfig>?
The desired notification configuration.
final
desiredParentProductConfig → Input<ParentProductConfig>?
The desired parent product config for the cluster.
final
desiredPrivateClusterConfig → Input<PrivateClusterConfig>?
The desired private cluster configuration.
final
desiredPrivateIpv6GoogleAccess → Input<ClusterUpdateDesiredPrivateIpv6GoogleAccess>?
The desired state of IPv6 connectivity to Google Services.
final
desiredReleaseChannel → Input<ReleaseChannel>?
The desired release channel configuration.
final
desiredResourceUsageExportConfig → Input<ResourceUsageExportConfig>?
The desired configuration for exporting resource usage.
final
desiredSecurityPostureConfig → Input<SecurityPostureConfig>?
Enable/Disable Security Posture API features for the cluster.
final
desiredServiceExternalIpsConfig → Input<ServiceExternalIPsConfig>?
ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
final
desiredShieldedNodes → Input<ShieldedNodes>?
Configuration for Shielded Nodes.
final
desiredStackType → Input<ClusterUpdateDesiredStackType>?
The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.
final
desiredVerticalPodAutoscaling → Input<VerticalPodAutoscaling>?
Cluster-level Vertical Pod Autoscaling configuration.
final
desiredWorkloadIdentityConfig → Input<WorkloadIdentityConfig>?
Configuration for Workload Identity.
final
enableK8sBetaApis → Input<K8sBetaAPIConfig>?
Kubernetes open source beta apis enabled on the cluster. Only beta apis
final
etag → Input<String>?
The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.
final
hashCode → int
The hash code for this object.
no setterinherited
removedAdditionalPodRangesConfig → Input<AdditionalPodRangesConfig>?
The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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