ibm.ContainerVpcCluster

(String) The ID of the VPC cluster.

CosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

Crk string

Root Key ID for boot volume encryption.

Include this option to allow public outbound access from the cluster workers. By default, public outbound access is blocked in OpenShift versions 4.15 and later and Kubernetes versions 1.30 and later. This option is usable only from OpenShift versions 4.15 and later and Kubernetes versions 1.30 and later.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Enables Secure-by-default security group configuration. Once the upgrade begins, it cannot be undone. During the upgrade, network traffic to your cluster may temporarily be blocked. This option is usable only from OpenShift versions 4.15 and later and Kubernetes versions 1.30 and later.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

Entitlement string

Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

HostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

KmsConfig ContainerVpcClusterKmsConfig

Set to true to enable image security enforcement policies in a cluster.

KmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

KmsInstanceId string

Instance ID for boot volume encryption.

KubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

Name string

The name of the cluster.

OperatingSystem string

The operating system of the workers in the default worker pool. For supported options, see Red Hat OpenShift on IBM Cloud version information or IBM Cloud Kubernetes Service version information. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

PatchVersion string

Updates the worker nodes with the required patch version. The patch_version should be in the format: patch_version_fixpack_version. For more information, about Kubernetes version information and update, see Kubernetes version update. Note To update the patch or fix pack versions of the worker nodes, run the command ibmcloud ks workers -c <cluster_name_or_id> output json. Fetch the required patch & fix pack versions from kubeVersion.target and set the patch_version parameter.

PodSubnet string

Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must have a CIDR of at least /23 or larger. For more information, see the documentation. Default value is 172.30.0.0/16.

ResourceGroupId string

The ID of the resource group. You can retrieve the value by running ibmcloud resource groups or by using the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.

RetryPatchVersion double

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

SecondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

SecurityGroups List<string>

Enables users to define specific security groups for their workers.

ServiceSubnet string

Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least ’/24’ or larger. For more information, see the documentation. Default value is 172.21.0.0/16.

Tags List<string>

A list of tags that you want to associate with your VPC cluster. Note For users on account to add tags to a resource, they must be assigned the [appropriate permissions]/docs/account?topic=account-access).

Taints List<ContainerVpcClusterTaint>

A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for taints:

Timeouts ContainerVpcClusterTimeouts

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

Zones []ContainerVpcClusterZoneArgs

Set to true to wait and update the Kubernetes version of worker nodes. NOTE Setting wait_for_worker_update to false is not recommended. Setting false results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.

WaitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

WorkerCount double

The number of worker nodes per zone in the default worker pool. Default value 1. Note If the requested number of worker nodes is fewer than the minimum 2 worker nodes that are required for an OpenShift cluster, cluster creation will be rejected. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

WorkerLabels Dictionary<string, string>

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Flavor string

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

VpcId string

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

(String) The ID of the VPC cluster.

CosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

Crk string

Root Key ID for boot volume encryption.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

Entitlement string

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

HostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

KmsConfig ContainerVpcClusterKmsConfigArgs

Set to true to enable image security enforcement policies in a cluster.

KmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

KmsInstanceId string

Instance ID for boot volume encryption.

KubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

Name string

The name of the cluster.

OperatingSystem string

PatchVersion string

PodSubnet string

ResourceGroupId string

RetryPatchVersion float64

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

SecondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

SecurityGroups []string

Enables users to define specific security groups for their workers.

ServiceSubnet string

Tags []string

Taints []ContainerVpcClusterTaintArgs

Nested scheme for taints:

Timeouts ContainerVpcClusterTimeoutsArgs

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

zones List<ContainerVpcClusterZone>

WaitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

WorkerCount float64

WorkerLabels map[string]string

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

flavor String

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

vpcId String

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

(String) The ID of the VPC cluster.

cosInstanceCrn String

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk String

Root Key ID for boot volume encryption.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement String

forceDeleteStorage Boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId String

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

Set to true to enable image security enforcement policies in a cluster.

kmsAccountId String

Account ID for boot volume encryption, if other account is providing the kms.

taints List<ContainerVpcClusterTaint>

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId String

Instance ID for boot volume encryption.

kubeVersion String

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

name String

The name of the cluster.

operatingSystem String

patchVersion String

podSubnet String

resourceGroupId String

retryPatchVersion Double

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage String

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups List<String>

Enables users to define specific security groups for their workers.

serviceSubnet String

tags List<String>

Nested scheme for taints:

updateAllWorkers Boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

zones ContainerVpcClusterZone[]

waitTill String

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

workerCount Double

workerLabels Map<String,String>

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

flavor string

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

vpcId string

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

containerVpcClusterId string

(String) The ID of the VPC cluster.

cosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk string

Root Key ID for boot volume encryption.

disableOutboundTrafficProtection boolean

disablePublicServiceEndpoint boolean

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

enableSecureByDefault boolean

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement string

forceDeleteStorage boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

imageSecurityEnforcement boolean

Set to true to enable image security enforcement policies in a cluster.

kmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

taints ContainerVpcClusterTaint[]

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId string

Instance ID for boot volume encryption.

kubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

name string

The name of the cluster.

operatingSystem string

patchVersion string

podSubnet string

resourceGroupId string

retryPatchVersion number

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups string[]

Enables users to define specific security groups for their workers.

serviceSubnet string

tags string[]

Nested scheme for taints:

zones Sequence[ContainerVpcClusterZoneArgs]

updateAllWorkers boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

waitForWorkerUpdate boolean

waitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

workerCount number

workerLabels {[key: string]: string}

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

flavor str

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

vpc_id str

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

container_vpc_cluster_id str

(String) The ID of the VPC cluster.

cos_instance_crn str

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk str

Root Key ID for boot volume encryption.

disable_outbound_traffic_protection bool

disable_public_service_endpoint bool

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

enable_secure_by_default bool

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement str

force_delete_storage bool

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

host_pool_id str

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

image_security_enforcement bool

Set to true to enable image security enforcement policies in a cluster.

kms_account_id str

Account ID for boot volume encryption, if other account is providing the kms.

kms_config ContainerVpcClusterKmsConfigArgs

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kms_instance_id str

Instance ID for boot volume encryption.

kube_version str

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

name str

The name of the cluster.

operating_system str

patch_version str

pod_subnet str

resource_group_id str

retry_patch_version float

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondary_storage str

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

security_groups Sequence[str]

Enables users to define specific security groups for their workers.

service_subnet str

tags Sequence[str]

taints Sequence[ContainerVpcClusterTaintArgs]

Nested scheme for taints:

timeouts ContainerVpcClusterTimeoutsArgs

update_all_workers bool

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

wait_for_worker_update bool

wait_till str

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

worker_count float

worker_labels Mapping[str, str]

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

flavor String

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

vpcId String

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

zones List<Property Map>

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

(String) The ID of the VPC cluster.

cosInstanceCrn String

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk String

Root Key ID for boot volume encryption.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement String

forceDeleteStorage Boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId String

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

kmsConfig Property Map

Set to true to enable image security enforcement policies in a cluster.

kmsAccountId String

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId String

Instance ID for boot volume encryption.

kubeVersion String

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

name String

The name of the cluster.

operatingSystem String

patchVersion String

podSubnet String

resourceGroupId String

retryPatchVersion Number

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage String

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups List<String>

Enables users to define specific security groups for their workers.

serviceSubnet String

tags List<String>

taints List<Property Map>

Nested scheme for taints:

timeouts Property Map

updateAllWorkers Boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

Albs List<ContainerVpcClusterAlb>

waitTill String

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

workerCount Number

workerLabels Map<String>

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ContainerVpcCluster resource produces the following output properties:

Albs List<ContainerVpcClusterAlb>: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
Crn string: (String) The CRN of the VPC cluster.
Id string: The provider-assigned unique ID for this managed resource.
IngressHostname string: (String) The hostname that was assigned to your Ingress subdomain.
IngressSecret string: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
MasterStatus string: (String) The status of the Kubernetes master.
MasterUrl string: (String) The URL of the Kubernetes master.
PrivateServiceEndpointUrl string: (String) The private service endpoint URL.
PublicServiceEndpointUrl string: (String) The public service endpoint URL.
ResourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
ResourceCrn string: The crn of the resource
ResourceGroupName string: The resource group name in which resource is provisioned
ResourceName string: The name of the resource
ResourceStatus string: The status of the resource
State string: (String) The state of the VPC cluster.
VpeServiceEndpointUrl string: (String) The virtual private endpoint URL.

Albs []ContainerVpcClusterAlb: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
Crn string: (String) The CRN of the VPC cluster.
Id string: The provider-assigned unique ID for this managed resource.
IngressHostname string: (String) The hostname that was assigned to your Ingress subdomain.
IngressSecret string: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
MasterStatus string: (String) The status of the Kubernetes master.
MasterUrl string: (String) The URL of the Kubernetes master.
PrivateServiceEndpointUrl string: (String) The private service endpoint URL.
PublicServiceEndpointUrl string: (String) The public service endpoint URL.
ResourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
ResourceCrn string: The crn of the resource
ResourceGroupName string: The resource group name in which resource is provisioned
ResourceName string: The name of the resource
ResourceStatus string: The status of the resource
State string: (String) The state of the VPC cluster.
VpeServiceEndpointUrl string: (String) The virtual private endpoint URL.

albs List<ContainerVpcClusterAlb>: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
crn String: (String) The CRN of the VPC cluster.
id String: The provider-assigned unique ID for this managed resource.
ingressHostname String: (String) The hostname that was assigned to your Ingress subdomain.
ingressSecret String: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
masterStatus String: (String) The status of the Kubernetes master.
masterUrl String: (String) The URL of the Kubernetes master.
privateServiceEndpointUrl String: (String) The private service endpoint URL.
publicServiceEndpointUrl String: (String) The public service endpoint URL.
resourceControllerUrl String: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
resourceCrn String: The crn of the resource
resourceGroupName String: The resource group name in which resource is provisioned
resourceName String: The name of the resource
resourceStatus String: The status of the resource
state String: (String) The state of the VPC cluster.
vpeServiceEndpointUrl String: (String) The virtual private endpoint URL.

albs ContainerVpcClusterAlb[]: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
crn string: (String) The CRN of the VPC cluster.
id string: The provider-assigned unique ID for this managed resource.
ingressHostname string: (String) The hostname that was assigned to your Ingress subdomain.
ingressSecret string: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
masterStatus string: (String) The status of the Kubernetes master.
masterUrl string: (String) The URL of the Kubernetes master.
privateServiceEndpointUrl string: (String) The private service endpoint URL.
publicServiceEndpointUrl string: (String) The public service endpoint URL.
resourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
resourceCrn string: The crn of the resource
resourceGroupName string: The resource group name in which resource is provisioned
resourceName string: The name of the resource
resourceStatus string: The status of the resource
state string: (String) The state of the VPC cluster.
vpeServiceEndpointUrl string: (String) The virtual private endpoint URL.

albs Sequence[ContainerVpcClusterAlb]: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
crn str: (String) The CRN of the VPC cluster.
id str: The provider-assigned unique ID for this managed resource.
ingress_hostname str: (String) The hostname that was assigned to your Ingress subdomain.
ingress_secret str: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
master_status str: (String) The status of the Kubernetes master.
master_url str: (String) The URL of the Kubernetes master.
private_service_endpoint_url str: (String) The private service endpoint URL.
public_service_endpoint_url str: (String) The public service endpoint URL.
resource_controller_url str: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
resource_crn str: The crn of the resource
resource_group_name str: The resource group name in which resource is provisioned
resource_name str: The name of the resource
resource_status str: The status of the resource
state str: (String) The state of the VPC cluster.
vpe_service_endpoint_url str: (String) The virtual private endpoint URL.

albs List<Property Map>: (List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.
crn String: (String) The CRN of the VPC cluster.
id String: The provider-assigned unique ID for this managed resource.
ingressHostname String: (String) The hostname that was assigned to your Ingress subdomain.
ingressSecret String: (String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.
masterStatus String: (String) The status of the Kubernetes master.
masterUrl String: (String) The URL of the Kubernetes master.
privateServiceEndpointUrl String: (String) The private service endpoint URL.
publicServiceEndpointUrl String: (String) The public service endpoint URL.
resourceControllerUrl String: The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
resourceCrn String: The crn of the resource
resourceGroupName String: The resource group name in which resource is provisioned
resourceName String: The name of the resource
resourceStatus String: The status of the resource
state String: (String) The state of the VPC cluster.
vpeServiceEndpointUrl String: (String) The virtual private endpoint URL.

Look up Existing ContainerVpcCluster Resource

Get an existing ContainerVpcCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ContainerVpcClusterState, opts?: CustomResourceOptions): ContainerVpcCluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        albs: Optional[Sequence[ContainerVpcClusterAlbArgs]] = None,
        container_vpc_cluster_id: Optional[str] = None,
        cos_instance_crn: Optional[str] = None,
        crk: Optional[str] = None,
        crn: Optional[str] = None,
        disable_outbound_traffic_protection: Optional[bool] = None,
        disable_public_service_endpoint: Optional[bool] = None,
        enable_secure_by_default: Optional[bool] = None,
        entitlement: Optional[str] = None,
        flavor: Optional[str] = None,
        force_delete_storage: Optional[bool] = None,
        host_pool_id: Optional[str] = None,
        image_security_enforcement: Optional[bool] = None,
        ingress_hostname: Optional[str] = None,
        ingress_secret: Optional[str] = None,
        kms_account_id: Optional[str] = None,
        kms_config: Optional[ContainerVpcClusterKmsConfigArgs] = None,
        kms_instance_id: Optional[str] = None,
        kube_version: Optional[str] = None,
        master_status: Optional[str] = None,
        master_url: Optional[str] = None,
        name: Optional[str] = None,
        operating_system: Optional[str] = None,
        patch_version: Optional[str] = None,
        pod_subnet: Optional[str] = None,
        private_service_endpoint_url: Optional[str] = None,
        public_service_endpoint_url: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        retry_patch_version: Optional[float] = None,
        secondary_storage: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        service_subnet: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        taints: Optional[Sequence[ContainerVpcClusterTaintArgs]] = None,
        timeouts: Optional[ContainerVpcClusterTimeoutsArgs] = None,
        update_all_workers: Optional[bool] = None,
        vpc_id: Optional[str] = None,
        vpe_service_endpoint_url: Optional[str] = None,
        wait_for_worker_update: Optional[bool] = None,
        wait_till: Optional[str] = None,
        worker_count: Optional[float] = None,
        worker_labels: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[ContainerVpcClusterZoneArgs]] = None) -> ContainerVpcCluster

func GetContainerVpcCluster(ctx *Context, name string, id IDInput, state *ContainerVpcClusterState, opts ...ResourceOption) (*ContainerVpcCluster, error)

public static ContainerVpcCluster Get(string name, Input<string> id, ContainerVpcClusterState? state, CustomResourceOptions? opts = null)

public static ContainerVpcCluster get(String name, Output<String> id, ContainerVpcClusterState state, CustomResourceOptions options)

resources:  _:    type: ibm:ContainerVpcCluster    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

(String) The ID of the VPC cluster.

CosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

Crk string

Root Key ID for boot volume encryption.

Crn string

(String) The CRN of the VPC cluster.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

Entitlement string

Flavor string

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

HostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

KmsConfig ContainerVpcClusterKmsConfig

Set to true to enable image security enforcement policies in a cluster.

IngressHostname string

(String) The hostname that was assigned to your Ingress subdomain.

IngressSecret string

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

KmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

KmsInstanceId string

Instance ID for boot volume encryption.

KubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

MasterStatus string

(String) The status of the Kubernetes master.

MasterUrl string

(String) The URL of the Kubernetes master.

Name string

The name of the cluster.

OperatingSystem string

PatchVersion string

PodSubnet string

PrivateServiceEndpointUrl string

(String) The private service endpoint URL.

PublicServiceEndpointUrl string

(String) The public service endpoint URL.

ResourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

ResourceCrn string

The crn of the resource

ResourceGroupId string

ResourceGroupName string

The resource group name in which resource is provisioned

ResourceName string

The name of the resource

ResourceStatus string

The status of the resource

RetryPatchVersion double

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

SecondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

SecurityGroups List<string>

Enables users to define specific security groups for their workers.

ServiceSubnet string

State string

(String) The state of the VPC cluster.

Tags List<string>

Taints List<ContainerVpcClusterTaint>

Nested scheme for taints:

Timeouts ContainerVpcClusterTimeouts

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

VpcId string

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

VpeServiceEndpointUrl string

(String) The virtual private endpoint URL.

Zones List<ContainerVpcClusterZone>

WaitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

WorkerCount double

WorkerLabels Dictionary<string, string>

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

Albs []ContainerVpcClusterAlbArgs

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

(String) The ID of the VPC cluster.

CosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

Crk string

Root Key ID for boot volume encryption.

Crn string

(String) The CRN of the VPC cluster.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

Entitlement string

Flavor string

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

HostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

KmsConfig ContainerVpcClusterKmsConfigArgs

Set to true to enable image security enforcement policies in a cluster.

IngressHostname string

(String) The hostname that was assigned to your Ingress subdomain.

IngressSecret string

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

KmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

KmsInstanceId string

Instance ID for boot volume encryption.

KubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

MasterStatus string

(String) The status of the Kubernetes master.

MasterUrl string

(String) The URL of the Kubernetes master.

Name string

The name of the cluster.

OperatingSystem string

PatchVersion string

PodSubnet string

PrivateServiceEndpointUrl string

(String) The private service endpoint URL.

PublicServiceEndpointUrl string

(String) The public service endpoint URL.

ResourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

ResourceCrn string

The crn of the resource

ResourceGroupId string

ResourceGroupName string

The resource group name in which resource is provisioned

ResourceName string

The name of the resource

ResourceStatus string

The status of the resource

RetryPatchVersion float64

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

SecondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

SecurityGroups []string

Enables users to define specific security groups for their workers.

ServiceSubnet string

State string

(String) The state of the VPC cluster.

Tags []string

Taints []ContainerVpcClusterTaintArgs

Nested scheme for taints:

Timeouts ContainerVpcClusterTimeoutsArgs

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

VpcId string

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

VpeServiceEndpointUrl string

(String) The virtual private endpoint URL.

Zones []ContainerVpcClusterZoneArgs

WaitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

WorkerCount float64

WorkerLabels map[string]string

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

albs List<ContainerVpcClusterAlb>

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

(String) The ID of the VPC cluster.

cosInstanceCrn String

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk String

Root Key ID for boot volume encryption.

crn String

(String) The CRN of the VPC cluster.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement String

flavor String

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

forceDeleteStorage Boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId String

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

Set to true to enable image security enforcement policies in a cluster.

ingressHostname String

(String) The hostname that was assigned to your Ingress subdomain.

ingressSecret String

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

kmsAccountId String

Account ID for boot volume encryption, if other account is providing the kms.

taints List<ContainerVpcClusterTaint>

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId String

Instance ID for boot volume encryption.

kubeVersion String

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

masterStatus String

(String) The status of the Kubernetes master.

masterUrl String

(String) The URL of the Kubernetes master.

name String

The name of the cluster.

operatingSystem String

patchVersion String

podSubnet String

privateServiceEndpointUrl String

(String) The private service endpoint URL.

publicServiceEndpointUrl String

(String) The public service endpoint URL.

resourceControllerUrl String

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

resourceCrn String

The crn of the resource

resourceGroupId String

resourceGroupName String

The resource group name in which resource is provisioned

resourceName String

The name of the resource

resourceStatus String

The status of the resource

retryPatchVersion Double

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage String

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups List<String>

Enables users to define specific security groups for their workers.

serviceSubnet String

state String

(String) The state of the VPC cluster.

tags List<String>

Nested scheme for taints:

updateAllWorkers Boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

vpcId String

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

vpeServiceEndpointUrl String

(String) The virtual private endpoint URL.

zones List<ContainerVpcClusterZone>

waitTill String

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

workerCount Double

workerLabels Map<String,String>

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

albs ContainerVpcClusterAlb[]

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

containerVpcClusterId string

(String) The ID of the VPC cluster.

cosInstanceCrn string

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk string

Root Key ID for boot volume encryption.

crn string

(String) The CRN of the VPC cluster.

disableOutboundTrafficProtection boolean

disablePublicServiceEndpoint boolean

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

enableSecureByDefault boolean

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement string

flavor string

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

forceDeleteStorage boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId string

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

imageSecurityEnforcement boolean

Set to true to enable image security enforcement policies in a cluster.

ingressHostname string

(String) The hostname that was assigned to your Ingress subdomain.

ingressSecret string

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

kmsAccountId string

Account ID for boot volume encryption, if other account is providing the kms.

taints ContainerVpcClusterTaint[]

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId string

Instance ID for boot volume encryption.

kubeVersion string

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

masterStatus string

(String) The status of the Kubernetes master.

masterUrl string

(String) The URL of the Kubernetes master.

name string

The name of the cluster.

operatingSystem string

patchVersion string

podSubnet string

privateServiceEndpointUrl string

(String) The private service endpoint URL.

publicServiceEndpointUrl string

(String) The public service endpoint URL.

resourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

resourceCrn string

The crn of the resource

resourceGroupId string

resourceGroupName string

The resource group name in which resource is provisioned

resourceName string

The name of the resource

resourceStatus string

The status of the resource

retryPatchVersion number

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage string

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups string[]

Enables users to define specific security groups for their workers.

serviceSubnet string

state string

(String) The state of the VPC cluster.

tags string[]

Nested scheme for taints:

zones ContainerVpcClusterZone[]

updateAllWorkers boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

vpcId string

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

vpeServiceEndpointUrl string

(String) The virtual private endpoint URL.

waitForWorkerUpdate boolean

waitTill string

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

workerCount number

workerLabels {[key: string]: string}

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

albs Sequence[ContainerVpcClusterAlbArgs]

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

container_vpc_cluster_id str

(String) The ID of the VPC cluster.

cos_instance_crn str

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk str

Root Key ID for boot volume encryption.

crn str

(String) The CRN of the VPC cluster.

disable_outbound_traffic_protection bool

disable_public_service_endpoint bool

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

enable_secure_by_default bool

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement str

flavor str

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

force_delete_storage bool

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

host_pool_id str

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

image_security_enforcement bool

Set to true to enable image security enforcement policies in a cluster.

ingress_hostname str

(String) The hostname that was assigned to your Ingress subdomain.

ingress_secret str

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

kms_account_id str

Account ID for boot volume encryption, if other account is providing the kms.

kms_config ContainerVpcClusterKmsConfigArgs

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kms_instance_id str

Instance ID for boot volume encryption.

kube_version str

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

master_status str

(String) The status of the Kubernetes master.

master_url str

(String) The URL of the Kubernetes master.

name str

The name of the cluster.

operating_system str

patch_version str

pod_subnet str

private_service_endpoint_url str

(String) The private service endpoint URL.

public_service_endpoint_url str

(String) The public service endpoint URL.

resource_controller_url str

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

resource_crn str

The crn of the resource

resource_group_id str

resource_group_name str

The resource group name in which resource is provisioned

resource_name str

The name of the resource

resource_status str

The status of the resource

retry_patch_version float

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondary_storage str

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

security_groups Sequence[str]

Enables users to define specific security groups for their workers.

service_subnet str

state str

(String) The state of the VPC cluster.

tags Sequence[str]

taints Sequence[ContainerVpcClusterTaintArgs]

Nested scheme for taints:

timeouts ContainerVpcClusterTimeoutsArgs

update_all_workers bool

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

vpc_id str

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

vpe_service_endpoint_url str

(String) The virtual private endpoint URL.

wait_for_worker_update bool

wait_till str

wait_till can be configured for Master Ready, One worker Ready, Ingress Ready or Normal

worker_count float

worker_labels Mapping[str, str]

Labels on all the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

zones Sequence[ContainerVpcClusterZoneArgs]

A nested block describes the zones of this VPC cluster's default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

Nested scheme for zones:

albs List<Property Map>

(List of Objects) A list of Application Load Balancers (ALBs) that are attached to the cluster.

(String) The ID of the VPC cluster.

cosInstanceCrn String

Required for OpenShift clusters only. The standard IBM Cloud Object Storage instance CRN to back up the internal registry in your OpenShift on VPC Generation 2 cluster.

crk String

Root Key ID for boot volume encryption.

crn String

(String) The CRN of the VPC cluster.

Disable the public service endpoint to prevent public access to the Kubernetes master. Default value is false.

Note

For users on account to add tags to a resource, you need to assign the right access. For more information, about tags, see Tags permission.
wait_till is set only for the first time creation of the resource, further modification are not impacted.

entitlement String

flavor String

The flavor of the VPC worker nodes in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

forceDeleteStorage Boolean

Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered

hostPoolId String

If provided, the cluster will be associated with a dedicated host pool identified by this ID.

kmsConfig Property Map

Set to true to enable image security enforcement policies in a cluster.

ingressHostname String

(String) The hostname that was assigned to your Ingress subdomain.

ingressSecret String

(String) The name of the Ingress secret that was created for you and that the Ingress subdomain uses.

kmsAccountId String

Account ID for boot volume encryption, if other account is providing the kms.

Use to attach a Key Protect instance to a cluster. Nested kms_config block has an instance_id, crk_id, private_endpoint and account_id.

kmsInstanceId String

Instance ID for boot volume encryption.

kubeVersion String

Specify the Kubernetes version, including the major.minor version. If you do not include this flag, the default version is used. To see available versions, run ibmcloud ks versions.

masterStatus String

(String) The status of the Kubernetes master.

masterUrl String

(String) The URL of the Kubernetes master.

name String

The name of the cluster.

operatingSystem String

patchVersion String

podSubnet String

privateServiceEndpointUrl String

(String) The private service endpoint URL.

publicServiceEndpointUrl String

(String) The public service endpoint URL.

resourceControllerUrl String

The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster

resourceCrn String

The crn of the resource

resourceGroupId String

resourceGroupName String

The resource group name in which resource is provisioned

resourceName String

The name of the resource

resourceStatus String

The status of the resource

retryPatchVersion Number

This argument retries the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.

secondaryStorage String

The secondary storage option for the workers in the default worker pool. This field only affects cluster creation, to manage the default worker pool, create a dedicated worker pool resource.

securityGroups List<String>

Enables users to define specific security groups for their workers.

serviceSubnet String

state String

(String) The state of the VPC cluster.

tags List<String>

taints List<Property Map>

Nested scheme for taints:

timeouts Property Map

updateAllWorkers Boolean

Set to true, if you want to update workers Kubernetes version with the cluster kube_version.

vpcId String

The ID of the VPC that you want to use for your cluster. To list available VPCs, run ibmcloud is vpcs.

vpeServiceEndpointUrl String

(String) The virtual private endpoint URL.