ionoscloud.getDataplatformCluster
Explore with Pulumi AI
The Dataplatform Cluster Data Source can be used to search for and return an existing Dataplatform Cluster. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search and make sure that your resources have unique names.
Example Usage
By ID
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";
const example = ionoscloud.getDataplatformCluster({
id: "cluster_id",
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.get_dataplatform_cluster(id="cluster_id")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ionoscloud.LookupDataplatformCluster(ctx, &ionoscloud.LookupDataplatformClusterArgs{
Id: pulumi.StringRef("cluster_id"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = Ionoscloud.GetDataplatformCluster.Invoke(new()
{
Id = "cluster_id",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetDataplatformClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = IonoscloudFunctions.getDataplatformCluster(GetDataplatformClusterArgs.builder()
.id("cluster_id")
.build());
}
}
variables:
example:
fn::invoke:
function: ionoscloud:getDataplatformCluster
arguments:
id: cluster_id
By Name
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";
const example = ionoscloud.getDataplatformCluster({
name: "Dataplatform_Cluster_Example",
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.get_dataplatform_cluster(name="Dataplatform_Cluster_Example")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ionoscloud.LookupDataplatformCluster(ctx, &ionoscloud.LookupDataplatformClusterArgs{
Name: pulumi.StringRef("Dataplatform_Cluster_Example"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = Ionoscloud.GetDataplatformCluster.Invoke(new()
{
Name = "Dataplatform_Cluster_Example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetDataplatformClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = IonoscloudFunctions.getDataplatformCluster(GetDataplatformClusterArgs.builder()
.name("Dataplatform_Cluster_Example")
.build());
}
}
variables:
example:
fn::invoke:
function: ionoscloud:getDataplatformCluster
arguments:
name: Dataplatform_Cluster_Example
By Name with Partial Match
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@pulumi/ionoscloud";
const example = ionoscloud.getDataplatformCluster({
name: "_Example",
partialMatch: true,
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.get_dataplatform_cluster(name="_Example",
partial_match=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ionoscloud.LookupDataplatformCluster(ctx, &ionoscloud.LookupDataplatformClusterArgs{
Name: pulumi.StringRef("_Example"),
PartialMatch: pulumi.BoolRef(true),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = Ionoscloud.GetDataplatformCluster.Invoke(new()
{
Name = "_Example",
PartialMatch = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetDataplatformClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = IonoscloudFunctions.getDataplatformCluster(GetDataplatformClusterArgs.builder()
.name("_Example")
.partialMatch(true)
.build());
}
}
variables:
example:
fn::invoke:
function: ionoscloud:getDataplatformCluster
arguments:
name: _Example
partialMatch: true
Using getDataplatformCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDataplatformCluster(args: GetDataplatformClusterArgs, opts?: InvokeOptions): Promise<GetDataplatformClusterResult>
function getDataplatformClusterOutput(args: GetDataplatformClusterOutputArgs, opts?: InvokeOptions): Output<GetDataplatformClusterResult>
def get_dataplatform_cluster(id: Optional[str] = None,
name: Optional[str] = None,
partial_match: Optional[bool] = None,
timeouts: Optional[GetDataplatformClusterTimeouts] = None,
opts: Optional[InvokeOptions] = None) -> GetDataplatformClusterResult
def get_dataplatform_cluster_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
partial_match: Optional[pulumi.Input[bool]] = None,
timeouts: Optional[pulumi.Input[GetDataplatformClusterTimeoutsArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDataplatformClusterResult]
func LookupDataplatformCluster(ctx *Context, args *LookupDataplatformClusterArgs, opts ...InvokeOption) (*LookupDataplatformClusterResult, error)
func LookupDataplatformClusterOutput(ctx *Context, args *LookupDataplatformClusterOutputArgs, opts ...InvokeOption) LookupDataplatformClusterResultOutput
> Note: This function is named LookupDataplatformCluster
in the Go SDK.
public static class GetDataplatformCluster
{
public static Task<GetDataplatformClusterResult> InvokeAsync(GetDataplatformClusterArgs args, InvokeOptions? opts = null)
public static Output<GetDataplatformClusterResult> Invoke(GetDataplatformClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataplatformClusterResult> getDataplatformCluster(GetDataplatformClusterArgs args, InvokeOptions options)
public static Output<GetDataplatformClusterResult> getDataplatformCluster(GetDataplatformClusterArgs args, InvokeOptions options)
fn::invoke:
function: ionoscloud:index/getDataplatformCluster:getDataplatformCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- ID of the cluster you want to search for.
- Name string
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - Partial
Match bool Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- Timeouts
Get
Dataplatform Cluster Timeouts
- Id string
- ID of the cluster you want to search for.
- Name string
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - Partial
Match bool Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- Timeouts
Get
Dataplatform Cluster Timeouts
- id String
- ID of the cluster you want to search for.
- name String
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - partial
Match Boolean Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- timeouts
Get
Dataplatform Cluster Timeouts
- id string
- ID of the cluster you want to search for.
- name string
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - partial
Match boolean Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- timeouts
Get
Dataplatform Cluster Timeouts
- id str
- ID of the cluster you want to search for.
- name str
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - partial_
match bool Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- timeouts
Get
Dataplatform Cluster Timeouts
- id String
- ID of the cluster you want to search for.
- name String
- Name of an existing cluster that you want to search for. Search by name is case-insensitive. The whole resource name is required if
partial_match
parameter is not set to true. - partial
Match Boolean Whether partial matching is allowed or not when using name argument. Default value is false.
Either
id
orname
must be provided. If none, or both are provided, the datasource will return an error.- timeouts Property Map
getDataplatformCluster Result
The following output properties are available:
- Ca
Crt string - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- Configs
List<Get
Dataplatform Cluster Config> - structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- Datacenter
Id string - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- Id string
- The UUID of the cluster.
- Kube
Config string - Kubernetes configuration
- Lans
List<Get
Dataplatform Cluster Lan> - A list of LANs you want this node pool to be part of
- Maintenance
Windows List<GetDataplatform Cluster Maintenance Window> - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- Name string
- The name of your cluster.
- Server string
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - User
Tokens Dictionary<string, string> - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- Version string
- The version of the Data Platform.
- Partial
Match bool - Timeouts
Get
Dataplatform Cluster Timeouts
- Ca
Crt string - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- Configs
[]Get
Dataplatform Cluster Config - structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- Datacenter
Id string - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- Id string
- The UUID of the cluster.
- Kube
Config string - Kubernetes configuration
- Lans
[]Get
Dataplatform Cluster Lan - A list of LANs you want this node pool to be part of
- Maintenance
Windows []GetDataplatform Cluster Maintenance Window - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- Name string
- The name of your cluster.
- Server string
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - User
Tokens map[string]string - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- Version string
- The version of the Data Platform.
- Partial
Match bool - Timeouts
Get
Dataplatform Cluster Timeouts
- ca
Crt String - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- configs
List<Get
Dataplatform Cluster Config> - structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- datacenter
Id String - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- id String
- The UUID of the cluster.
- kube
Config String - Kubernetes configuration
- lans
List<Get
Dataplatform Cluster Lan> - A list of LANs you want this node pool to be part of
- maintenance
Windows List<GetDataplatform Cluster Maintenance Window> - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- name String
- The name of your cluster.
- server String
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - user
Tokens Map<String,String> - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- version String
- The version of the Data Platform.
- partial
Match Boolean - timeouts
Get
Dataplatform Cluster Timeouts
- ca
Crt string - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- configs
Get
Dataplatform Cluster Config[] - structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- datacenter
Id string - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- id string
- The UUID of the cluster.
- kube
Config string - Kubernetes configuration
- lans
Get
Dataplatform Cluster Lan[] - A list of LANs you want this node pool to be part of
- maintenance
Windows GetDataplatform Cluster Maintenance Window[] - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- name string
- The name of your cluster.
- server string
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - user
Tokens {[key: string]: string} - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- version string
- The version of the Data Platform.
- partial
Match boolean - timeouts
Get
Dataplatform Cluster Timeouts
- ca_
crt str - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- configs
Sequence[Get
Dataplatform Cluster Config] - structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- datacenter_
id str - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- id str
- The UUID of the cluster.
- kube_
config str - Kubernetes configuration
- lans
Sequence[Get
Dataplatform Cluster Lan] - A list of LANs you want this node pool to be part of
- maintenance_
windows Sequence[GetDataplatform Cluster Maintenance Window] - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- name str
- The name of your cluster.
- server str
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - user_
tokens Mapping[str, str] - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- version str
- The version of the Data Platform.
- partial_
match bool - timeouts
Get
Dataplatform Cluster Timeouts
- ca
Crt String - base64 decoded cluster certificate authority data (provided as an attribute for direct use)
- configs List<Property Map>
- structured kubernetes config consisting of a list with 1 item with the following fields:
- api_version - Kubernetes API Version
- kind - "Config"
- current-context - string
- clusters - list of
- name - name of cluster
- cluster - map of
- certificate-authority-data - base64 decoded cluster CA data
- server - server address in the form
https://host:port
- contexts - list of
- name - context name
- context - map of
- cluster - cluster name
- user - cluster user
- users - list of
- name - user name
- user - map of
- token - user token used for authentication
- datacenter
Id String - The UUID of the virtual data center (VDC) in which the cluster is provisioned.
- id String
- The UUID of the cluster.
- kube
Config String - Kubernetes configuration
- lans List<Property Map>
- A list of LANs you want this node pool to be part of
- maintenance
Windows List<Property Map> - Starting time of a weekly 4 hour-long window, during which maintenance might occur in hh:mm:ss format
- name String
- The name of your cluster.
- server String
- cluster server (same as
config[0].clusters[0].cluster.server
but provided as an attribute for ease of use) - user
Tokens Map<String> - a convenience map to be search the token of a specific user
- key - is the user name
- value - is the token
- version String
- The version of the Data Platform.
- partial
Match Boolean - timeouts Property Map
Supporting Types
GetDataplatformClusterConfig
GetDataplatformClusterConfigCluster
GetDataplatformClusterConfigContext
GetDataplatformClusterConfigUser
GetDataplatformClusterLan
- Dhcp bool
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- Lan
Id string - The LAN ID of an existing LAN at the related data center
- Routes
List<Get
Dataplatform Cluster Lan Route> - An array of additional LANs attached to worker nodes
- Dhcp bool
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- Lan
Id string - The LAN ID of an existing LAN at the related data center
- Routes
[]Get
Dataplatform Cluster Lan Route - An array of additional LANs attached to worker nodes
- dhcp Boolean
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- lan
Id String - The LAN ID of an existing LAN at the related data center
- routes
List<Get
Dataplatform Cluster Lan Route> - An array of additional LANs attached to worker nodes
- dhcp boolean
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- lan
Id string - The LAN ID of an existing LAN at the related data center
- routes
Get
Dataplatform Cluster Lan Route[] - An array of additional LANs attached to worker nodes
- dhcp bool
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- lan_
id str - The LAN ID of an existing LAN at the related data center
- routes
Sequence[Get
Dataplatform Cluster Lan Route] - An array of additional LANs attached to worker nodes
- dhcp Boolean
- Indicates if the Kubernetes node pool LAN will reserve an IP using DHCP. The default value is 'true'.
- lan
Id String - The LAN ID of an existing LAN at the related data center
- routes List<Property Map>
- An array of additional LANs attached to worker nodes
GetDataplatformClusterLanRoute
GetDataplatformClusterMaintenanceWindow
- Day
Of stringThe Week - Time string
- Time at which the maintenance should start.
- Day
Of stringThe Week - Time string
- Time at which the maintenance should start.
- day
Of StringThe Week - time String
- Time at which the maintenance should start.
- day
Of stringThe Week - time string
- Time at which the maintenance should start.
- day_
of_ strthe_ week - time str
- Time at which the maintenance should start.
- day
Of StringThe Week - time String
- Time at which the maintenance should start.
GetDataplatformClusterTimeouts
Package Details
- Repository
- ionoscloud ionos-cloud/terraform-provider-ionoscloud
- License
- Notes
- This Pulumi package is based on the
ionoscloud
Terraform Provider.