ClusterContainerV1beta1 class

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

ClusterContainerV1beta1(String name, {ClusterContainerV1beta1Args? args, CustomResourceOptions? options})
Creates a new ClusterContainerV1beta1. name The Pulumi resource name. args Arguments used to configure this ClusterContainerV1beta1. The set of arguments for Cluster. options Resource options controlling this resource's behavior.

Properties

addonsConfig ↔ Output<AddonsConfigResponseContainerV1beta1>
Configurations for the various addons available to run in the cluster.
latefinal
authenticatorGroupsConfig ↔ Output<AuthenticatorGroupsConfigResponseContainerV1beta1>
Configuration controlling RBAC group membership information.
latefinal
autopilot ↔ Output<AutopilotResponseContainerV1beta1>
Autopilot configuration for the cluster.
latefinal
autoscaling ↔ Output<ClusterAutoscalingResponseContainerV1beta1>
Cluster-level autoscaling configuration.
latefinal
binaryAuthorization ↔ Output<BinaryAuthorizationResponseContainerV1beta1>
Configuration for Binary Authorization.
latefinal
childResources → Set<Resource>
finalinherited
clusterIpv4Cidr ↔ Output<String>
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.
latefinal
clusterTelemetry ↔ Output<ClusterTelemetryResponse>
Telemetry integration for the cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
conditions ↔ Output<List<Map<String, dynamic>>>
Which conditions caused the current cluster state.
latefinal
confidentialNodes ↔ Output<ConfidentialNodesResponseContainerV1beta1>
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
latefinal
costManagementConfig ↔ Output<CostManagementConfigResponseContainerV1beta1>
Configuration for the fine-grained cost management feature.
latefinal
createTime ↔ Output<String>
Output only The time the cluster was created, in RFC3339 text format.
latefinal
currentMasterVersion ↔ Output<String>
Output only The current software version of the master endpoint.
latefinal
currentNodeCount ↔ Output<int>
Output only The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
latefinal
currentNodeVersion ↔ Output<String>
Output only Deprecated, use NodePool.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
latefinal
databaseEncryption ↔ Output<DatabaseEncryptionResponseContainerV1beta1>
Configuration of etcd encryption.
latefinal
defaultMaxPodsConstraint ↔ Output<MaxPodsConstraintResponseContainerV1beta1>
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.
latefinal
description ↔ Output<String>
An optional description of this cluster.
latefinal
enableK8sBetaApis ↔ Output<K8sBetaAPIConfigResponseContainerV1beta1>
Kubernetes open source beta apis enabled on the cluster. Only beta apis.
latefinal
enableKubernetesAlpha ↔ Output<bool>
Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.
latefinal
enableTpu ↔ Output<bool>
Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.
latefinal
endpoint ↔ Output<String>
Output only The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.
latefinal
enterpriseConfig ↔ Output<EnterpriseConfigResponseContainerV1beta1>
GKE Enterprise Configuration.
latefinal
etag ↔ Output<String>
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.
latefinal
expireTime ↔ Output<String>
Output only The time the cluster will be automatically deleted in RFC3339 text format.
latefinal
fleet ↔ Output<FleetResponseContainerV1beta1>
Fleet information for the cluster.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
identityServiceConfig ↔ Output<IdentityServiceConfigResponseContainerV1beta1>
Configuration for Identity Service component.
latefinal
initialClusterVersion ↔ Output<String>
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
latefinal
initialNodeCount ↔ Output<int>
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.
latefinal
instanceGroupUrls ↔ Output<List<String>>
Deprecated. Use node_pools.instance_group_urls.
latefinal
ipAllocationPolicy ↔ Output<IPAllocationPolicyResponseContainerV1beta1>
Configuration for cluster IP allocation.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
labelFingerprint ↔ Output<String>
The fingerprint of the set of labels for this cluster.
latefinal
legacyAbac ↔ Output<LegacyAbacResponseContainerV1beta1>
Configuration for the legacy ABAC authorization mode.
latefinal
location ↔ Output<String>
latefinal
locations ↔ Output<List<String>>
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.
latefinal
loggingConfig ↔ Output<LoggingConfigResponseContainerV1beta1>
Logging configuration for the cluster.
latefinal
loggingService ↔ Output<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.
latefinal
maintenancePolicy ↔ Output<MaintenancePolicyResponseContainerV1beta1>
Configure the maintenance policy for this cluster.
latefinal
master ↔ Output<Map<String, dynamic>>
Configuration for master components.
latefinal
masterAuth ↔ Output<MasterAuthResponseContainerV1beta1>
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.
latefinal
masterAuthorizedNetworksConfig ↔ Output<MasterAuthorizedNetworksConfigResponseContainerV1beta1>
The configuration options for master authorized networks feature.
latefinal
masterIpv4CidrBlock ↔ Output<String>
The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.
latefinal
meshCertificates ↔ Output<MeshCertificatesResponseContainerV1beta1>
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
latefinal
monitoringConfig ↔ Output<MonitoringConfigResponseContainerV1beta1>
Monitoring configuration for the cluster.
latefinal
monitoringService ↔ Output<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.
latefinal
name ↔ Output<String>
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.
latefinal
network ↔ Output<String>
The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used. On output this shows the network ID instead of the name.
latefinal
networkConfig ↔ Output<NetworkConfigResponseContainerV1beta1>
Configuration for cluster networking.
latefinal
networkPolicy ↔ Output<NetworkPolicyResponseContainerV1beta1>
Configuration options for the NetworkPolicy feature.
latefinal
nodeConfig ↔ Output<NodeConfigResponseContainerV1beta1>
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.
latefinal
nodeIpv4CidrSize ↔ Output<int>
Output only The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.
latefinal
nodePoolAutoConfig ↔ Output<NodePoolAutoConfigResponseContainerV1beta1>
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
latefinal
nodePoolDefaults ↔ Output<NodePoolDefaultsResponseContainerV1beta1>
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
latefinal
nodePools ↔ Output<List<Map<String, dynamic>>>
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
latefinal
notificationConfig ↔ Output<NotificationConfigResponseContainerV1beta1>
Notification configuration of the cluster.
latefinal
parentProductConfig ↔ Output<ParentProductConfigResponseContainerV1beta1>
The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster.
latefinal
podSecurityPolicyConfig ↔ Output<PodSecurityPolicyConfigResponse>
Configuration for the PodSecurityPolicy feature.
latefinal
privateCluster ↔ Output<bool>
If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.
latefinal
privateClusterConfig ↔ Output<PrivateClusterConfigResponseContainerV1beta1>
Configuration for private cluster.
latefinal
project ↔ Output<String>
latefinal
protectConfig ↔ Output<ProtectConfigResponse>
Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
latefinal
releaseChannel ↔ Output<ReleaseChannelResponseContainerV1beta1>
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.
latefinal
resourceLabels ↔ Output<Map<String, String>>
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
resourceUsageExportConfig ↔ Output<ResourceUsageExportConfigResponseContainerV1beta1>
Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPostureConfig ↔ Output<SecurityPostureConfigResponseContainerV1beta1>
Enable/Disable Security Posture API features for the cluster.
latefinal
Output only Server-defined URL for the resource.
latefinal
servicesIpv4Cidr ↔ Output<String>
Output only The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
latefinal
shieldedNodes ↔ Output<ShieldedNodesResponseContainerV1beta1>
Shielded Nodes configuration.
latefinal
status ↔ Output<String>
Output only The current status of this cluster.
latefinal
statusMessage ↔ Output<String>
Output only Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
latefinal
subnetwork ↔ Output<String>
The name of the Google Compute Engine subnetwork to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
latefinal
tpuConfig ↔ Output<TpuConfigResponse>
Configuration for Cloud TPU support;
latefinal
tpuIpv4CidrBlock ↔ Output<String>
Output only The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
verticalPodAutoscaling ↔ Output<VerticalPodAutoscalingResponseContainerV1beta1>
Cluster-level Vertical Pod Autoscaling configuration.
latefinal
workloadAltsConfig ↔ Output<WorkloadALTSConfigResponse>
Configuration for direct-path (via ALTS) with workload identity.
latefinal
workloadCertificates ↔ Output<WorkloadCertificatesResponse>
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
latefinal
workloadIdentityConfig ↔ Output<WorkloadIdentityConfigResponseContainerV1beta1>
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
latefinal
zone ↔ Output<String>
Output only The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getKubeconfig() → Future<ClusterGetKubeconfigContainerV1beta1Result>
Generate a kubeconfig for cluster authentication.
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited