Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ContainerVpcWorker
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ContainerVpcWorker

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create ContainerVpcWorker Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ContainerVpcWorker(name: string, args: ContainerVpcWorkerArgs, opts?: CustomResourceOptions);
@overload
def ContainerVpcWorker(resource_name: str,
                       args: ContainerVpcWorkerArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ContainerVpcWorker(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cluster_name: Optional[str] = None,
                       replace_worker: Optional[str] = None,
                       check_ptx_status: Optional[bool] = None,
                       container_vpc_worker_id: Optional[str] = None,
                       kube_config_path: Optional[str] = None,
                       ptx_timeout: Optional[str] = None,
                       resource_group_id: Optional[str] = None,
                       sds: Optional[str] = None,
                       sds_timeout: Optional[str] = None,
                       timeouts: Optional[ContainerVpcWorkerTimeoutsArgs] = None)
func NewContainerVpcWorker(ctx *Context, name string, args ContainerVpcWorkerArgs, opts ...ResourceOption) (*ContainerVpcWorker, error)
public ContainerVpcWorker(string name, ContainerVpcWorkerArgs args, CustomResourceOptions? opts = null)
public ContainerVpcWorker(String name, ContainerVpcWorkerArgs args)
public ContainerVpcWorker(String name, ContainerVpcWorkerArgs args, CustomResourceOptions options)

type: ibm:ContainerVpcWorker
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContainerVpcWorkerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ContainerVpcWorkerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerVpcWorkerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerVpcWorkerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ContainerVpcWorkerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var containerVpcWorkerResource = new Ibm.ContainerVpcWorker("containerVpcWorkerResource", new()
{
    ClusterName = "string",
    ReplaceWorker = "string",
    CheckPtxStatus = false,
    ContainerVpcWorkerId = "string",
    KubeConfigPath = "string",
    PtxTimeout = "string",
    ResourceGroupId = "string",
    Sds = "string",
    SdsTimeout = "string",
    Timeouts = new Ibm.Inputs.ContainerVpcWorkerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});
Copy
example, err := ibm.NewContainerVpcWorker(ctx, "containerVpcWorkerResource", &ibm.ContainerVpcWorkerArgs{
ClusterName: pulumi.String("string"),
ReplaceWorker: pulumi.String("string"),
CheckPtxStatus: pulumi.Bool(false),
ContainerVpcWorkerId: pulumi.String("string"),
KubeConfigPath: pulumi.String("string"),
PtxTimeout: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
Sds: pulumi.String("string"),
SdsTimeout: pulumi.String("string"),
Timeouts: &.ContainerVpcWorkerTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
Copy
var containerVpcWorkerResource = new ContainerVpcWorker("containerVpcWorkerResource", ContainerVpcWorkerArgs.builder()
    .clusterName("string")
    .replaceWorker("string")
    .checkPtxStatus(false)
    .containerVpcWorkerId("string")
    .kubeConfigPath("string")
    .ptxTimeout("string")
    .resourceGroupId("string")
    .sds("string")
    .sdsTimeout("string")
    .timeouts(ContainerVpcWorkerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());
Copy
container_vpc_worker_resource = ibm.ContainerVpcWorker("containerVpcWorkerResource",
    cluster_name="string",
    replace_worker="string",
    check_ptx_status=False,
    container_vpc_worker_id="string",
    kube_config_path="string",
    ptx_timeout="string",
    resource_group_id="string",
    sds="string",
    sds_timeout="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })
Copy
const containerVpcWorkerResource = new ibm.ContainerVpcWorker("containerVpcWorkerResource", {
    clusterName: "string",
    replaceWorker: "string",
    checkPtxStatus: false,
    containerVpcWorkerId: "string",
    kubeConfigPath: "string",
    ptxTimeout: "string",
    resourceGroupId: "string",
    sds: "string",
    sdsTimeout: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});
Copy
type: ibm:ContainerVpcWorker
properties:
    checkPtxStatus: false
    clusterName: string
    containerVpcWorkerId: string
    kubeConfigPath: string
    ptxTimeout: string
    replaceWorker: string
    resourceGroupId: string
    sds: string
    sdsTimeout: string
    timeouts:
        create: string
        delete: string
Copy

ContainerVpcWorker Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ContainerVpcWorker resource accepts the following input properties:

ClusterName This property is required. string
The name or ID of the cluster.
ReplaceWorker This property is required. string
The ID of the worker that needs to be replaced.
CheckPtxStatus bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
ContainerVpcWorkerId string
(String) The unique identifier of the worker.
KubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
PtxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
ResourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
Sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
SdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
Timeouts ContainerVpcWorkerTimeouts
ClusterName This property is required. string
The name or ID of the cluster.
ReplaceWorker This property is required. string
The ID of the worker that needs to be replaced.
CheckPtxStatus bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
ContainerVpcWorkerId string
(String) The unique identifier of the worker.
KubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
PtxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
ResourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
Sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
SdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
Timeouts ContainerVpcWorkerTimeoutsArgs
clusterName This property is required. String
The name or ID of the cluster.
replaceWorker This property is required. String
The ID of the worker that needs to be replaced.
checkPtxStatus Boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
containerVpcWorkerId String
(String) The unique identifier of the worker.
kubeConfigPath String
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout String
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
resourceGroupId String
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds String
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout String
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeouts
clusterName This property is required. string
The name or ID of the cluster.
replaceWorker This property is required. string
The ID of the worker that needs to be replaced.
checkPtxStatus boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
containerVpcWorkerId string
(String) The unique identifier of the worker.
kubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
resourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeouts
cluster_name This property is required. str
The name or ID of the cluster.
replace_worker This property is required. str
The ID of the worker that needs to be replaced.
check_ptx_status bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
container_vpc_worker_id str
(String) The unique identifier of the worker.
kube_config_path str
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptx_timeout str
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
resource_group_id str
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds str
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sds_timeout str
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeoutsArgs
clusterName This property is required. String
The name or ID of the cluster.
replaceWorker This property is required. String
The ID of the worker that needs to be replaced.
checkPtxStatus Boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
containerVpcWorkerId String
(String) The unique identifier of the worker.
kubeConfigPath String
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout String
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
resourceGroupId String
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds String
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout String
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Ip string
(String) The IP of the worker.
Id string
The provider-assigned unique ID for this managed resource.
Ip string
(String) The IP of the worker.
id String
The provider-assigned unique ID for this managed resource.
ip String
(String) The IP of the worker.
id string
The provider-assigned unique ID for this managed resource.
ip string
(String) The IP of the worker.
id str
The provider-assigned unique ID for this managed resource.
ip str
(String) The IP of the worker.
id String
The provider-assigned unique ID for this managed resource.
ip String
(String) The IP of the worker.

Look up Existing ContainerVpcWorker Resource

Get an existing ContainerVpcWorker 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?: ContainerVpcWorkerState, opts?: CustomResourceOptions): ContainerVpcWorker
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_ptx_status: Optional[bool] = None,
        cluster_name: Optional[str] = None,
        container_vpc_worker_id: Optional[str] = None,
        ip: Optional[str] = None,
        kube_config_path: Optional[str] = None,
        ptx_timeout: Optional[str] = None,
        replace_worker: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        sds: Optional[str] = None,
        sds_timeout: Optional[str] = None,
        timeouts: Optional[ContainerVpcWorkerTimeoutsArgs] = None) -> ContainerVpcWorker
func GetContainerVpcWorker(ctx *Context, name string, id IDInput, state *ContainerVpcWorkerState, opts ...ResourceOption) (*ContainerVpcWorker, error)
public static ContainerVpcWorker Get(string name, Input<string> id, ContainerVpcWorkerState? state, CustomResourceOptions? opts = null)
public static ContainerVpcWorker get(String name, Output<String> id, ContainerVpcWorkerState state, CustomResourceOptions options)
resources:  _:    type: ibm:ContainerVpcWorker    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CheckPtxStatus bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
ClusterName string
The name or ID of the cluster.
ContainerVpcWorkerId string
(String) The unique identifier of the worker.
Ip string
(String) The IP of the worker.
KubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
PtxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
ReplaceWorker string
The ID of the worker that needs to be replaced.
ResourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
Sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
SdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
Timeouts ContainerVpcWorkerTimeouts
CheckPtxStatus bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
ClusterName string
The name or ID of the cluster.
ContainerVpcWorkerId string
(String) The unique identifier of the worker.
Ip string
(String) The IP of the worker.
KubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
PtxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
ReplaceWorker string
The ID of the worker that needs to be replaced.
ResourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
Sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
SdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
Timeouts ContainerVpcWorkerTimeoutsArgs
checkPtxStatus Boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
clusterName String
The name or ID of the cluster.
containerVpcWorkerId String
(String) The unique identifier of the worker.
ip String
(String) The IP of the worker.
kubeConfigPath String
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout String
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
replaceWorker String
The ID of the worker that needs to be replaced.
resourceGroupId String
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds String
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout String
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeouts
checkPtxStatus boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
clusterName string
The name or ID of the cluster.
containerVpcWorkerId string
(String) The unique identifier of the worker.
ip string
(String) The IP of the worker.
kubeConfigPath string
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout string
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
replaceWorker string
The ID of the worker that needs to be replaced.
resourceGroupId string
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds string
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout string
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeouts
check_ptx_status bool
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
cluster_name str
The name or ID of the cluster.
container_vpc_worker_id str
(String) The unique identifier of the worker.
ip str
(String) The IP of the worker.
kube_config_path str
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptx_timeout str
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
replace_worker str
The ID of the worker that needs to be replaced.
resource_group_id str
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds str
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sds_timeout str
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts ContainerVpcWorkerTimeoutsArgs
checkPtxStatus Boolean
Boolean value to check the status of Portworx on the replaced worker instance. By default, this variable is set as false.
clusterName String
The name or ID of the cluster.
containerVpcWorkerId String
(String) The unique identifier of the worker.
ip String
(String) The IP of the worker.
kubeConfigPath String
The Cluster config with absolute path. If check_ptx_status is true, this variable should hold a valid value. To retrieve the cluster config, run ibmcloud cluster config -c <Cluster_ID> or use the ibm.getContainerClusterConfig data source.
ptxTimeout String
The Status of Portworx on the replaced worker is considered failed when no response is received for 15 minutes.
replaceWorker String
The ID of the worker that needs to be replaced.
resourceGroupId String
The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
sds String
Software Defined Storage (SDS) parameter performs worker replace based on the installed SDS solution in the cluster. Supported value ODF
sdsTimeout String
The Status of the Software Defined Storage on the replaced worker is considered failed when no response is received for 30 minutes.
timeouts Property Map

Supporting Types

ContainerVpcWorkerTimeouts
, ContainerVpcWorkerTimeoutsArgs

Create string
Delete string
Create string
Delete string
create String
delete String
create string
delete string
create str
delete str
create String
delete String

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm