ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getIsClusterNetwork
Explore with Pulumi AI
Provides a read-only data source to retrieve information about a ClusterNetwork. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const isClusterNetworkInstance = ibm.getIsClusterNetwork({
clusterNetworkId: ibm_is_cluster_network.is_cluster_network_instance.id,
});
import pulumi
import pulumi_ibm as ibm
is_cluster_network_instance = ibm.get_is_cluster_network(cluster_network_id=ibm_is_cluster_network["is_cluster_network_instance"]["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupIsClusterNetwork(ctx, &ibm.LookupIsClusterNetworkArgs{
ClusterNetworkId: ibm_is_cluster_network.Is_cluster_network_instance.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var isClusterNetworkInstance = Ibm.GetIsClusterNetwork.Invoke(new()
{
ClusterNetworkId = ibm_is_cluster_network.Is_cluster_network_instance.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsClusterNetworkArgs;
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 isClusterNetworkInstance = IbmFunctions.getIsClusterNetwork(GetIsClusterNetworkArgs.builder()
.clusterNetworkId(ibm_is_cluster_network.is_cluster_network_instance().id())
.build());
}
}
variables:
isClusterNetworkInstance:
fn::invoke:
function: ibm:getIsClusterNetwork
arguments:
clusterNetworkId: ${ibm_is_cluster_network.is_cluster_network_instance.id}
Using getIsClusterNetwork
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 getIsClusterNetwork(args: GetIsClusterNetworkArgs, opts?: InvokeOptions): Promise<GetIsClusterNetworkResult>
function getIsClusterNetworkOutput(args: GetIsClusterNetworkOutputArgs, opts?: InvokeOptions): Output<GetIsClusterNetworkResult>
def get_is_cluster_network(cluster_network_id: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIsClusterNetworkResult
def get_is_cluster_network_output(cluster_network_id: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIsClusterNetworkResult]
func LookupIsClusterNetwork(ctx *Context, args *LookupIsClusterNetworkArgs, opts ...InvokeOption) (*LookupIsClusterNetworkResult, error)
func LookupIsClusterNetworkOutput(ctx *Context, args *LookupIsClusterNetworkOutputArgs, opts ...InvokeOption) LookupIsClusterNetworkResultOutput
> Note: This function is named LookupIsClusterNetwork
in the Go SDK.
public static class GetIsClusterNetwork
{
public static Task<GetIsClusterNetworkResult> InvokeAsync(GetIsClusterNetworkArgs args, InvokeOptions? opts = null)
public static Output<GetIsClusterNetworkResult> Invoke(GetIsClusterNetworkInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIsClusterNetworkResult> getIsClusterNetwork(GetIsClusterNetworkArgs args, InvokeOptions options)
public static Output<GetIsClusterNetworkResult> getIsClusterNetwork(GetIsClusterNetworkArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getIsClusterNetwork:getIsClusterNetwork
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Network stringId - The cluster network identifier.
- Id string
- (String) The unique identifier for this VPC.
- Cluster
Network stringId - The cluster network identifier.
- Id string
- (String) The unique identifier for this VPC.
- cluster
Network StringId - The cluster network identifier.
- id String
- (String) The unique identifier for this VPC.
- cluster
Network stringId - The cluster network identifier.
- id string
- (String) The unique identifier for this VPC.
- cluster_
network_ strid - The cluster network identifier.
- id str
- (String) The unique identifier for this VPC.
- cluster
Network StringId - The cluster network identifier.
- id String
- (String) The unique identifier for this VPC.
getIsClusterNetwork Result
The following output properties are available:
- Cluster
Network stringId - Created
At string - (String) The date and time that the cluster network was created.
- Crn string
- (String) The CRN for this VPC.
- Href string
- (String) The URL for this zone.
- Id string
- (String) The unique identifier for this VPC.
- Lifecycle
Reasons List<GetIs Cluster Network Lifecycle Reason> - (List) The reasons for the current
lifecycle_state
(if any). - Lifecycle
State string - (String) The lifecycle state of the cluster network.
- Name string
- (String) The globally unique name for this zone.
- Profiles
List<Get
Is Cluster Network Profile> - (List) The profile for this cluster network. Nested schema for profile:
- Resource
Groups List<GetIs Cluster Network Resource Group> - (List) The resource group for this cluster network. Nested schema for resource_group:
- Resource
Type string - (String) The resource type.
- Subnet
Prefixes List<GetIs Cluster Network Subnet Prefix> - (List) The IP address ranges available for subnets for this cluster network.
- Vpcs
List<Get
Is Cluster Network Vpc> - (List) The VPC this cluster network resides in.
- Zones
List<Get
Is Cluster Network Zone> - (List) The zone this cluster network resides in. Nested schema for zone:
- Cluster
Network stringId - Created
At string - (String) The date and time that the cluster network was created.
- Crn string
- (String) The CRN for this VPC.
- Href string
- (String) The URL for this zone.
- Id string
- (String) The unique identifier for this VPC.
- Lifecycle
Reasons []GetIs Cluster Network Lifecycle Reason - (List) The reasons for the current
lifecycle_state
(if any). - Lifecycle
State string - (String) The lifecycle state of the cluster network.
- Name string
- (String) The globally unique name for this zone.
- Profiles
[]Get
Is Cluster Network Profile - (List) The profile for this cluster network. Nested schema for profile:
- Resource
Groups []GetIs Cluster Network Resource Group - (List) The resource group for this cluster network. Nested schema for resource_group:
- Resource
Type string - (String) The resource type.
- Subnet
Prefixes []GetIs Cluster Network Subnet Prefix - (List) The IP address ranges available for subnets for this cluster network.
- Vpcs
[]Get
Is Cluster Network Vpc - (List) The VPC this cluster network resides in.
- Zones
[]Get
Is Cluster Network Zone - (List) The zone this cluster network resides in. Nested schema for zone:
- cluster
Network StringId - created
At String - (String) The date and time that the cluster network was created.
- crn String
- (String) The CRN for this VPC.
- href String
- (String) The URL for this zone.
- id String
- (String) The unique identifier for this VPC.
- lifecycle
Reasons List<GetIs Cluster Network Lifecycle Reason> - (List) The reasons for the current
lifecycle_state
(if any). - lifecycle
State String - (String) The lifecycle state of the cluster network.
- name String
- (String) The globally unique name for this zone.
- profiles
List<Get
Is Cluster Network Profile> - (List) The profile for this cluster network. Nested schema for profile:
- resource
Groups List<GetIs Cluster Network Resource Group> - (List) The resource group for this cluster network. Nested schema for resource_group:
- resource
Type String - (String) The resource type.
- subnet
Prefixes List<GetIs Cluster Network Subnet Prefix> - (List) The IP address ranges available for subnets for this cluster network.
- vpcs
List<Get
Is Cluster Network Vpc> - (List) The VPC this cluster network resides in.
- zones
List<Get
Is Cluster Network Zone> - (List) The zone this cluster network resides in. Nested schema for zone:
- cluster
Network stringId - created
At string - (String) The date and time that the cluster network was created.
- crn string
- (String) The CRN for this VPC.
- href string
- (String) The URL for this zone.
- id string
- (String) The unique identifier for this VPC.
- lifecycle
Reasons GetIs Cluster Network Lifecycle Reason[] - (List) The reasons for the current
lifecycle_state
(if any). - lifecycle
State string - (String) The lifecycle state of the cluster network.
- name string
- (String) The globally unique name for this zone.
- profiles
Get
Is Cluster Network Profile[] - (List) The profile for this cluster network. Nested schema for profile:
- resource
Groups GetIs Cluster Network Resource Group[] - (List) The resource group for this cluster network. Nested schema for resource_group:
- resource
Type string - (String) The resource type.
- subnet
Prefixes GetIs Cluster Network Subnet Prefix[] - (List) The IP address ranges available for subnets for this cluster network.
- vpcs
Get
Is Cluster Network Vpc[] - (List) The VPC this cluster network resides in.
- zones
Get
Is Cluster Network Zone[] - (List) The zone this cluster network resides in. Nested schema for zone:
- cluster_
network_ strid - created_
at str - (String) The date and time that the cluster network was created.
- crn str
- (String) The CRN for this VPC.
- href str
- (String) The URL for this zone.
- id str
- (String) The unique identifier for this VPC.
- lifecycle_
reasons Sequence[GetIs Cluster Network Lifecycle Reason] - (List) The reasons for the current
lifecycle_state
(if any). - lifecycle_
state str - (String) The lifecycle state of the cluster network.
- name str
- (String) The globally unique name for this zone.
- profiles
Sequence[Get
Is Cluster Network Profile] - (List) The profile for this cluster network. Nested schema for profile:
- resource_
groups Sequence[GetIs Cluster Network Resource Group] - (List) The resource group for this cluster network. Nested schema for resource_group:
- resource_
type str - (String) The resource type.
- subnet_
prefixes Sequence[GetIs Cluster Network Subnet Prefix] - (List) The IP address ranges available for subnets for this cluster network.
- vpcs
Sequence[Get
Is Cluster Network Vpc] - (List) The VPC this cluster network resides in.
- zones
Sequence[Get
Is Cluster Network Zone] - (List) The zone this cluster network resides in. Nested schema for zone:
- cluster
Network StringId - created
At String - (String) The date and time that the cluster network was created.
- crn String
- (String) The CRN for this VPC.
- href String
- (String) The URL for this zone.
- id String
- (String) The unique identifier for this VPC.
- lifecycle
Reasons List<Property Map> - (List) The reasons for the current
lifecycle_state
(if any). - lifecycle
State String - (String) The lifecycle state of the cluster network.
- name String
- (String) The globally unique name for this zone.
- profiles List<Property Map>
- (List) The profile for this cluster network. Nested schema for profile:
- resource
Groups List<Property Map> - (List) The resource group for this cluster network. Nested schema for resource_group:
- resource
Type String - (String) The resource type.
- subnet
Prefixes List<Property Map> - (List) The IP address ranges available for subnets for this cluster network.
- vpcs List<Property Map>
- (List) The VPC this cluster network resides in.
- zones List<Property Map>
- (List) The zone this cluster network resides in. Nested schema for zone:
Supporting Types
GetIsClusterNetworkLifecycleReason
- Code string
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - Message string
- (String) An explanation of the reason for this lifecycle state.
- More
Info string - (String) Link to documentation about deleted resources.
- Code string
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - Message string
- (String) An explanation of the reason for this lifecycle state.
- More
Info string - (String) Link to documentation about deleted resources.
- code String
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - message String
- (String) An explanation of the reason for this lifecycle state.
- more
Info String - (String) Link to documentation about deleted resources.
- code string
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - message string
- (String) An explanation of the reason for this lifecycle state.
- more
Info string - (String) Link to documentation about deleted resources.
- code str
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - message str
- (String) An explanation of the reason for this lifecycle state.
- more_
info str - (String) Link to documentation about deleted resources.
- code String
- (String) A reason code for this lifecycle state:-
internal_error
: internal error (contact IBM support)-resource_suspended_by_provider
: The resource has been suspended (contact IBM support)The enumerated values for this property mayexpand in the future. - message String
- (String) An explanation of the reason for this lifecycle state.
- more
Info String - (String) Link to documentation about deleted resources.
GetIsClusterNetworkProfile
- Href string
- (String) The URL for this zone.
- Name string
- (String) The globally unique name for this zone.
- Resource
Type string - (String) The resource type.
- Href string
- (String) The URL for this zone.
- Name string
- (String) The globally unique name for this zone.
- Resource
Type string - (String) The resource type.
- href String
- (String) The URL for this zone.
- name String
- (String) The globally unique name for this zone.
- resource
Type String - (String) The resource type.
- href string
- (String) The URL for this zone.
- name string
- (String) The globally unique name for this zone.
- resource
Type string - (String) The resource type.
- href str
- (String) The URL for this zone.
- name str
- (String) The globally unique name for this zone.
- resource_
type str - (String) The resource type.
- href String
- (String) The URL for this zone.
- name String
- (String) The globally unique name for this zone.
- resource
Type String - (String) The resource type.
GetIsClusterNetworkResourceGroup
GetIsClusterNetworkSubnetPrefix
- Allocation
Policy string - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - Cidr string
- (String) The CIDR block for this prefix.
- Allocation
Policy string - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - Cidr string
- (String) The CIDR block for this prefix.
- allocation
Policy String - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - cidr String
- (String) The CIDR block for this prefix.
- allocation
Policy string - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - cidr string
- (String) The CIDR block for this prefix.
- allocation_
policy str - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - cidr str
- (String) The CIDR block for this prefix.
- allocation
Policy String - (String) The allocation policy for this subnet prefix:-
auto
: Subnets created by total count in this cluster network can use this prefix. - cidr String
- (String) The CIDR block for this prefix.
GetIsClusterNetworkVpc
- Crn string
- (String) The CRN for this VPC.
- Deleteds
List<Get
Is Cluster Network Vpc Deleted> - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- Href string
- (String) The URL for this zone.
- Id string
- (String) The unique identifier for this VPC.
- Name string
- (String) The globally unique name for this zone.
- Resource
Type string - (String) The resource type.
- Crn string
- (String) The CRN for this VPC.
- Deleteds
[]Get
Is Cluster Network Vpc Deleted - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- Href string
- (String) The URL for this zone.
- Id string
- (String) The unique identifier for this VPC.
- Name string
- (String) The globally unique name for this zone.
- Resource
Type string - (String) The resource type.
- crn String
- (String) The CRN for this VPC.
- deleteds
List<Get
Is Cluster Network Vpc Deleted> - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- href String
- (String) The URL for this zone.
- id String
- (String) The unique identifier for this VPC.
- name String
- (String) The globally unique name for this zone.
- resource
Type String - (String) The resource type.
- crn string
- (String) The CRN for this VPC.
- deleteds
Get
Is Cluster Network Vpc Deleted[] - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- href string
- (String) The URL for this zone.
- id string
- (String) The unique identifier for this VPC.
- name string
- (String) The globally unique name for this zone.
- resource
Type string - (String) The resource type.
- crn str
- (String) The CRN for this VPC.
- deleteds
Sequence[Get
Is Cluster Network Vpc Deleted] - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- href str
- (String) The URL for this zone.
- id str
- (String) The unique identifier for this VPC.
- name str
- (String) The globally unique name for this zone.
- resource_
type str - (String) The resource type.
- crn String
- (String) The CRN for this VPC.
- deleteds List<Property Map>
- (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
- href String
- (String) The URL for this zone.
- id String
- (String) The unique identifier for this VPC.
- name String
- (String) The globally unique name for this zone.
- resource
Type String - (String) The resource type.
GetIsClusterNetworkVpcDeleted
- More
Info string - (String) Link to documentation about deleted resources.
- More
Info string - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
- more
Info string - (String) Link to documentation about deleted resources.
- more_
info str - (String) Link to documentation about deleted resources.
- more
Info String - (String) Link to documentation about deleted resources.
GetIsClusterNetworkZone
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.