Package com.hashicorp.cdktf.providers.google.container_node_pool

Interface ContainerNodePoolConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    ContainerNodePoolConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:19.287Z")
@Stability(Stable)
public interface ContainerNodePoolConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCluster

        @Stability(Stable)
@NotNull
String getCluster()
        The cluster to create the node pool for. Cluster must be present in location provided for zonal clusters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#cluster ContainerNodePool#cluster}

      • getAutoscaling

        @Stability(Stable)
@Nullable
default ContainerNodePoolAutoscaling getAutoscaling()
        autoscaling block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#autoscaling ContainerNodePool#autoscaling}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#id ContainerNodePool#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getInitialNodeCount

        @Stability(Stable)
@Nullable
default Number getInitialNodeCount()
        The initial number of nodes for the pool.

        In regional or multi-zonal clusters, this is the number of nodes per zone. Changing this will force recreation of the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#initial_node_count ContainerNodePool#initial_node_count}

      • getLocation

        @Stability(Stable)
@Nullable
default String getLocation()
        The location (region or zone) of the cluster.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#location ContainerNodePool#location}

      • getManagement

        @Stability(Stable)
@Nullable
default ContainerNodePoolManagement getManagement()
        management block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#management ContainerNodePool#management}

      • getMaxPodsPerNode

        @Stability(Stable)
@Nullable
default Number getMaxPodsPerNode()
        The maximum number of pods per node in this node pool.

        Note that this does not work on node pools which are "route-based" - that is, node pools belonging to clusters that do not have IP Aliasing enabled. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#max_pods_per_node ContainerNodePool#max_pods_per_node}

      • getName

        @Stability(Stable)
@Nullable
default String getName()
        The name of the node pool. If left blank, Terraform will auto-generate a unique name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#name ContainerNodePool#name}

      • getNamePrefix

        @Stability(Stable)
@Nullable
default String getNamePrefix()
        Creates a unique name for the node pool beginning with the specified prefix. Conflicts with name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#name_prefix ContainerNodePool#name_prefix}

      • getNetworkConfig

        @Stability(Stable)
@Nullable
default ContainerNodePoolNetworkConfig getNetworkConfig()
        network_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#network_config ContainerNodePool#network_config}

      • getNodeConfig

        @Stability(Stable)
@Nullable
default ContainerNodePoolNodeConfig getNodeConfig()
        node_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#node_config ContainerNodePool#node_config}

      • getNodeCount

        @Stability(Stable)
@Nullable
default Number getNodeCount()
        The number of nodes per instance group.

        This field can be used to update the number of nodes per instance group but should not be used alongside autoscaling. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#node_count ContainerNodePool#node_count}

      • getNodeLocations

        @Stability(Stable)
@Nullable
default List<String> getNodeLocations()
        The list of zones in which the node pool's nodes should be located.

        Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If unspecified, the cluster-level node_locations will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#node_locations ContainerNodePool#node_locations}

      • getPlacementPolicy

        @Stability(Stable)
@Nullable
default ContainerNodePoolPlacementPolicy getPlacementPolicy()
        placement_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#placement_policy ContainerNodePool#placement_policy}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The ID of the project in which to create the node pool.

        If blank, the provider-configured project will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#project ContainerNodePool#project}

      • getQueuedProvisioning

        @Stability(Stable)
@Nullable
default ContainerNodePoolQueuedProvisioning getQueuedProvisioning()
        queued_provisioning block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#queued_provisioning ContainerNodePool#queued_provisioning}

      • getTimeouts

        @Stability(Stable)
@Nullable
default ContainerNodePoolTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#timeouts ContainerNodePool#timeouts}

      • getUpgradeSettings

        @Stability(Stable)
@Nullable
default ContainerNodePoolUpgradeSettings getUpgradeSettings()
        upgrade_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#upgrade_settings ContainerNodePool#upgrade_settings}

      • getVersion

        @Stability(Stable)
@Nullable
default String getVersion()
        The Kubernetes version for the nodes in this pool.

        Note that if this field and auto_upgrade are both specified, they will fight each other for what the node version should be, so setting both is highly discouraged. While a fuzzy version can be specified, it's recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source's version_prefix field to approximate fuzzy versions in a Terraform-compatible way. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/container_node_pool#version ContainerNodePool#version}