ClusterArgs

data class ClusterArgs(val addonsConfig: Output<AddonsConfigArgs>? = null, val authenticatorGroupsConfig: Output<AuthenticatorGroupsConfigArgs>? = null, val autopilot: Output<AutopilotArgs>? = null, val autoscaling: Output<ClusterAutoscalingArgs>? = null, val binaryAuthorization: Output<BinaryAuthorizationArgs>? = null, val clusterIpv4Cidr: Output<String>? = null, val conditions: Output<List<StatusConditionArgs>>? = null, val confidentialNodes: Output<ConfidentialNodesArgs>? = null, val costManagementConfig: Output<CostManagementConfigArgs>? = null, val databaseEncryption: Output<DatabaseEncryptionArgs>? = null, val defaultMaxPodsConstraint: Output<MaxPodsConstraintArgs>? = null, val description: Output<String>? = null, val enableKubernetesAlpha: Output<Boolean>? = null, val enableTpu: Output<Boolean>? = null, val etag: Output<String>? = null, val fleet: Output<FleetArgs>? = null, val identityServiceConfig: Output<IdentityServiceConfigArgs>? = null, val initialClusterVersion: Output<String>? = null, val initialNodeCount: Output<Int>? = null, val instanceGroupUrls: Output<List<String>>? = null, val ipAllocationPolicy: Output<IPAllocationPolicyArgs>? = null, val legacyAbac: Output<LegacyAbacArgs>? = null, val location: Output<String>? = null, val locations: Output<List<String>>? = null, val loggingConfig: Output<LoggingConfigArgs>? = null, val loggingService: Output<String>? = null, val maintenancePolicy: Output<MaintenancePolicyArgs>? = null, val masterAuth: Output<MasterAuthArgs>? = null, val masterAuthorizedNetworksConfig: Output<MasterAuthorizedNetworksConfigArgs>? = null, val meshCertificates: Output<MeshCertificatesArgs>? = null, val monitoringConfig: Output<MonitoringConfigArgs>? = null, val monitoringService: Output<String>? = null, val name: Output<String>? = null, val network: Output<String>? = null, val networkConfig: Output<NetworkConfigArgs>? = null, val networkPolicy: Output<NetworkPolicyArgs>? = null, val nodeConfig: Output<NodeConfigArgs>? = null, val nodePoolAutoConfig: Output<NodePoolAutoConfigArgs>? = null, val nodePoolDefaults: Output<NodePoolDefaultsArgs>? = null, val nodePools: Output<List<NodePoolArgs>>? = null, val notificationConfig: Output<NotificationConfigArgs>? = null, val parent: Output<String>? = null, val privateClusterConfig: Output<PrivateClusterConfigArgs>? = null, val project: Output<String>? = null, val releaseChannel: Output<ReleaseChannelArgs>? = null, val resourceLabels: Output<Map<String, String>>? = null, val resourceUsageExportConfig: Output<ResourceUsageExportConfigArgs>? = null, val shieldedNodes: Output<ShieldedNodesArgs>? = null, val subnetwork: Output<String>? = null, val verticalPodAutoscaling: Output<VerticalPodAutoscalingArgs>? = null, val workloadIdentityConfig: Output<WorkloadIdentityConfigArgs>? = null, val zone: Output<String>? = null) : ConvertibleToJava<ClusterArgs>

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Constructors

Link copied to clipboard
fun ClusterArgs(addonsConfig: Output<AddonsConfigArgs>? = null, authenticatorGroupsConfig: Output<AuthenticatorGroupsConfigArgs>? = null, autopilot: Output<AutopilotArgs>? = null, autoscaling: Output<ClusterAutoscalingArgs>? = null, binaryAuthorization: Output<BinaryAuthorizationArgs>? = null, clusterIpv4Cidr: Output<String>? = null, conditions: Output<List<StatusConditionArgs>>? = null, confidentialNodes: Output<ConfidentialNodesArgs>? = null, costManagementConfig: Output<CostManagementConfigArgs>? = null, databaseEncryption: Output<DatabaseEncryptionArgs>? = null, defaultMaxPodsConstraint: Output<MaxPodsConstraintArgs>? = null, description: Output<String>? = null, enableKubernetesAlpha: Output<Boolean>? = null, enableTpu: Output<Boolean>? = null, etag: Output<String>? = null, fleet: Output<FleetArgs>? = null, identityServiceConfig: Output<IdentityServiceConfigArgs>? = null, initialClusterVersion: Output<String>? = null, initialNodeCount: Output<Int>? = null, instanceGroupUrls: Output<List<String>>? = null, ipAllocationPolicy: Output<IPAllocationPolicyArgs>? = null, legacyAbac: Output<LegacyAbacArgs>? = null, location: Output<String>? = null, locations: Output<List<String>>? = null, loggingConfig: Output<LoggingConfigArgs>? = null, loggingService: Output<String>? = null, maintenancePolicy: Output<MaintenancePolicyArgs>? = null, masterAuth: Output<MasterAuthArgs>? = null, masterAuthorizedNetworksConfig: Output<MasterAuthorizedNetworksConfigArgs>? = null, meshCertificates: Output<MeshCertificatesArgs>? = null, monitoringConfig: Output<MonitoringConfigArgs>? = null, monitoringService: Output<String>? = null, name: Output<String>? = null, network: Output<String>? = null, networkConfig: Output<NetworkConfigArgs>? = null, networkPolicy: Output<NetworkPolicyArgs>? = null, nodeConfig: Output<NodeConfigArgs>? = null, nodePoolAutoConfig: Output<NodePoolAutoConfigArgs>? = null, nodePoolDefaults: Output<NodePoolDefaultsArgs>? = null, nodePools: Output<List<NodePoolArgs>>? = null, notificationConfig: Output<NotificationConfigArgs>? = null, parent: Output<String>? = null, privateClusterConfig: Output<PrivateClusterConfigArgs>? = null, project: Output<String>? = null, releaseChannel: Output<ReleaseChannelArgs>? = null, resourceLabels: Output<Map<String, String>>? = null, resourceUsageExportConfig: Output<ResourceUsageExportConfigArgs>? = null, shieldedNodes: Output<ShieldedNodesArgs>? = null, subnetwork: Output<String>? = null, verticalPodAutoscaling: Output<VerticalPodAutoscalingArgs>? = null, workloadIdentityConfig: Output<WorkloadIdentityConfigArgs>? = null, zone: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ClusterArgs

Properties

Link copied to clipboard
val addonsConfig: Output<AddonsConfigArgs>? = null

Configurations for the various addons available to run in the cluster.

Link copied to clipboard

Configuration controlling RBAC group membership information.

Link copied to clipboard
val autopilot: Output<AutopilotArgs>? = null

Autopilot configuration for the cluster.

Link copied to clipboard
val autoscaling: Output<ClusterAutoscalingArgs>? = null

Cluster-level autoscaling configuration.

Link copied to clipboard

Configuration for Binary Authorization.

Link copied to clipboard
val clusterIpv4Cidr: Output<String>? = null

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

Link copied to clipboard
val conditions: Output<List<StatusConditionArgs>>? = null

Which conditions caused the current cluster state.

Link copied to clipboard

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

Link copied to clipboard

Configuration for the fine-grained cost management feature.

Link copied to clipboard

Configuration of etcd encryption.

Link copied to clipboard

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this cluster.

Link copied to clipboard
val enableKubernetesAlpha: Output<Boolean>? = null

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Link copied to clipboard
val enableTpu: Output<Boolean>? = null

Enable the ability to use Cloud TPUs in this cluster.

Link copied to clipboard
val etag: Output<String>? = null

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Link copied to clipboard
val fleet: Output<FleetArgs>? = null

Fleet information for the cluster.

Link copied to clipboard

Configuration for Identity Service component.

Link copied to clipboard
val initialClusterVersion: Output<String>? = null

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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

Link copied to clipboard
val initialNodeCount: Output<Int>? = null

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

Link copied to clipboard
val instanceGroupUrls: Output<List<String>>? = null

Deprecated. Use node_pools.instance_group_urls.

Link copied to clipboard

Configuration for cluster IP allocation.

Link copied to clipboard
val legacyAbac: Output<LegacyAbacArgs>? = null

Configuration for the legacy ABAC authorization mode.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val locations: Output<List<String>>? = null

The list of Google Compute Engine zones in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Link copied to clipboard
val loggingConfig: Output<LoggingConfigArgs>? = null

Logging configuration for the cluster.

Link copied to clipboard
val loggingService: Output<String>? = null

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.

Link copied to clipboard

Configure the maintenance policy for this cluster.

Link copied to clipboard
val masterAuth: Output<MasterAuthArgs>? = null

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Link copied to clipboard

The configuration options for master authorized networks feature.

Link copied to clipboard

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Link copied to clipboard

Monitoring configuration for the cluster.

Link copied to clipboard
val monitoringService: Output<String>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

Link copied to clipboard
val network: Output<String>? = null

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Link copied to clipboard
val networkConfig: Output<NetworkConfigArgs>? = null

Configuration for cluster networking.

Link copied to clipboard
val networkPolicy: Output<NetworkPolicyArgs>? = null

Configuration options for the NetworkPolicy feature.

Link copied to clipboard
val nodeConfig: Output<NodeConfigArgs>? = null

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Link copied to clipboard

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Link copied to clipboard

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Link copied to clipboard
val nodePools: Output<List<NodePoolArgs>>? = null

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

Link copied to clipboard

Notification configuration of the cluster.

Link copied to clipboard
val parent: Output<String>? = null

The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*.

Link copied to clipboard

Configuration for private cluster.

Link copied to clipboard
val project: Output<String>? = null

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Link copied to clipboard
val releaseChannel: Output<ReleaseChannelArgs>? = null

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

Link copied to clipboard
val resourceLabels: Output<Map<String, String>>? = null

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Link copied to clipboard

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Link copied to clipboard
val shieldedNodes: Output<ShieldedNodesArgs>? = null

Shielded Nodes configuration.

Link copied to clipboard
val subnetwork: Output<String>? = null

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Link copied to clipboard

Cluster-level Vertical Pod Autoscaling configuration.

Link copied to clipboard

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Link copied to clipboard
val zone: Output<String>? = null

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field. //