Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. pgEdge
  3. API Docs
  4. getClusters
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

pgedge.getClusters

Explore with Pulumi AI

pgedge logo
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

    Data source for pgEdge clusters.

    Using getClusters

    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 getClusters(opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(opts?: InvokeOptions): Output<GetClustersResult>
    def get_clusters(opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
    func GetClusters(ctx *Context, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, opts ...InvokeOption) GetClustersResultOutput

    > Note: This function is named GetClusters in the Go SDK.

    public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClustersResult> getClusters(InvokeOptions options)
public static Output<GetClustersResult> getClusters(InvokeOptions options)

    fn::invoke:
  function: pgedge:index/getClusters:getClusters
  arguments:
    # arguments dictionary

    getClusters Result

    The following output properties are available:

    Clusters List<Pgedge.Pgedge.Outputs.GetClustersCluster>
    Id string
    The provider-assigned unique ID for this managed resource.
    Clusters []GetClustersCluster
    Id string
    The provider-assigned unique ID for this managed resource.
    clusters List<GetClustersCluster>
    id String
    The provider-assigned unique ID for this managed resource.
    clusters GetClustersCluster[]
    id string
    The provider-assigned unique ID for this managed resource.
    clusters Sequence[GetClustersCluster]
    id str
    The provider-assigned unique ID for this managed resource.
    clusters List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetClustersCluster

    BackupStoreIds List<string>
    Backup store IDs of the cluster
    Capacity int
    Capacity of the cluster
    CloudAccountId string
    Cloud account ID of the cluster
    CreatedAt string
    Created at of the cluster
    FirewallRules List<Pgedge.Pgedge.Inputs.GetClustersClusterFirewallRule>
    Id string
    ID of the cluster
    Name string
    Name of the cluster
    Networks List<Pgedge.Pgedge.Inputs.GetClustersClusterNetwork>
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes List<Pgedge.Pgedge.Inputs.GetClustersClusterNode>
    Regions List<string>
    ResourceTags Dictionary<string, string>
    Resource tags of the cluster
    SshKeyId string
    SSH key ID of the cluster
    Status string
    Status of the cluster
    BackupStoreIds []string
    Backup store IDs of the cluster
    Capacity int
    Capacity of the cluster
    CloudAccountId string
    Cloud account ID of the cluster
    CreatedAt string
    Created at of the cluster
    FirewallRules []GetClustersClusterFirewallRule
    Id string
    ID of the cluster
    Name string
    Name of the cluster
    Networks []GetClustersClusterNetwork
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes []GetClustersClusterNode
    Regions []string
    ResourceTags map[string]string
    Resource tags of the cluster
    SshKeyId string
    SSH key ID of the cluster
    Status string
    Status of the cluster
    backupStoreIds List<String>
    Backup store IDs of the cluster
    capacity Integer
    Capacity of the cluster
    cloudAccountId String
    Cloud account ID of the cluster
    createdAt String
    Created at of the cluster
    firewallRules List<GetClustersClusterFirewallRule>
    id String
    ID of the cluster
    name String
    Name of the cluster
    networks List<GetClustersClusterNetwork>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<GetClustersClusterNode>
    regions List<String>
    resourceTags Map<String,String>
    Resource tags of the cluster
    sshKeyId String
    SSH key ID of the cluster
    status String
    Status of the cluster
    backupStoreIds string[]
    Backup store IDs of the cluster
    capacity number
    Capacity of the cluster
    cloudAccountId string
    Cloud account ID of the cluster
    createdAt string
    Created at of the cluster
    firewallRules GetClustersClusterFirewallRule[]
    id string
    ID of the cluster
    name string
    Name of the cluster
    networks GetClustersClusterNetwork[]
    nodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes GetClustersClusterNode[]
    regions string[]
    resourceTags {[key: string]: string}
    Resource tags of the cluster
    sshKeyId string
    SSH key ID of the cluster
    status string
    Status of the cluster
    backup_store_ids Sequence[str]
    Backup store IDs of the cluster
    capacity int
    Capacity of the cluster
    cloud_account_id str
    Cloud account ID of the cluster
    created_at str
    Created at of the cluster
    firewall_rules Sequence[GetClustersClusterFirewallRule]
    id str
    ID of the cluster
    name str
    Name of the cluster
    networks Sequence[GetClustersClusterNetwork]
    node_location str
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes Sequence[GetClustersClusterNode]
    regions Sequence[str]
    resource_tags Mapping[str, str]
    Resource tags of the cluster
    ssh_key_id str
    SSH key ID of the cluster
    status str
    Status of the cluster
    backupStoreIds List<String>
    Backup store IDs of the cluster
    capacity Number
    Capacity of the cluster
    cloudAccountId String
    Cloud account ID of the cluster
    createdAt String
    Created at of the cluster
    firewallRules List<Property Map>
    id String
    ID of the cluster
    name String
    Name of the cluster
    networks List<Property Map>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<Property Map>
    regions List<String>
    resourceTags Map<String>
    Resource tags of the cluster
    sshKeyId String
    SSH key ID of the cluster
    status String
    Status of the cluster

    GetClustersClusterFirewallRule

    Name string
    Name of the firewall rule
    Port int
    Port for the firewall rule
    Sources List<string>
    Sources for the firewall rule
    Name string
    Name of the firewall rule
    Port int
    Port for the firewall rule
    Sources []string
    Sources for the firewall rule
    name String
    Name of the firewall rule
    port Integer
    Port for the firewall rule
    sources List<String>
    Sources for the firewall rule
    name string
    Name of the firewall rule
    port number
    Port for the firewall rule
    sources string[]
    Sources for the firewall rule
    name str
    Name of the firewall rule
    port int
    Port for the firewall rule
    sources Sequence[str]
    Sources for the firewall rule
    name String
    Name of the firewall rule
    port Number
    Port for the firewall rule
    sources List<String>
    Sources for the firewall rule

    GetClustersClusterNetwork

    Cidr string
    CIDR of the network
    External bool
    Is the network external
    ExternalId string
    External ID of the network
    Name string
    Name of the firewall rule
    PrivateSubnets List<string>
    PublicSubnets List<string>
    Region string
    Region of the network
    Cidr string
    CIDR of the network
    External bool
    Is the network external
    ExternalId string
    External ID of the network
    Name string
    Name of the firewall rule
    PrivateSubnets []string
    PublicSubnets []string
    Region string
    Region of the network
    cidr String
    CIDR of the network
    external Boolean
    Is the network external
    externalId String
    External ID of the network
    name String
    Name of the firewall rule
    privateSubnets List<String>
    publicSubnets List<String>
    region String
    Region of the network
    cidr string
    CIDR of the network
    external boolean
    Is the network external
    externalId string
    External ID of the network
    name string
    Name of the firewall rule
    privateSubnets string[]
    publicSubnets string[]
    region string
    Region of the network
    cidr str
    CIDR of the network
    external bool
    Is the network external
    external_id str
    External ID of the network
    name str
    Name of the firewall rule
    private_subnets Sequence[str]
    public_subnets Sequence[str]
    region str
    Region of the network
    cidr String
    CIDR of the network
    external Boolean
    Is the network external
    externalId String
    External ID of the network
    name String
    Name of the firewall rule
    privateSubnets List<String>
    publicSubnets List<String>
    region String
    Region of the network

    GetClustersClusterNode

    AvailabilityZone string
    Cloud provider availability zone name
    InstanceType string
    Instance type used for the node
    Name string
    Name of the firewall rule
    Options List<string>
    Region string
    Region of the network
    VolumeIops int
    Volume IOPS of the node data volume
    VolumeSize int
    Volume size of the node data volume
    VolumeType string
    Volume type of the node data volume
    AvailabilityZone string
    Cloud provider availability zone name
    InstanceType string
    Instance type used for the node
    Name string
    Name of the firewall rule
    Options []string
    Region string
    Region of the network
    VolumeIops int
    Volume IOPS of the node data volume
    VolumeSize int
    Volume size of the node data volume
    VolumeType string
    Volume type of the node data volume
    availabilityZone String
    Cloud provider availability zone name
    instanceType String
    Instance type used for the node
    name String
    Name of the firewall rule
    options List<String>
    region String
    Region of the network
    volumeIops Integer
    Volume IOPS of the node data volume
    volumeSize Integer
    Volume size of the node data volume
    volumeType String
    Volume type of the node data volume
    availabilityZone string
    Cloud provider availability zone name
    instanceType string
    Instance type used for the node
    name string
    Name of the firewall rule
    options string[]
    region string
    Region of the network
    volumeIops number
    Volume IOPS of the node data volume
    volumeSize number
    Volume size of the node data volume
    volumeType string
    Volume type of the node data volume
    availability_zone str
    Cloud provider availability zone name
    instance_type str
    Instance type used for the node
    name str
    Name of the firewall rule
    options Sequence[str]
    region str
    Region of the network
    volume_iops int
    Volume IOPS of the node data volume
    volume_size int
    Volume size of the node data volume
    volume_type str
    Volume type of the node data volume
    availabilityZone String
    Cloud provider availability zone name
    instanceType String
    Instance type used for the node
    name String
    Name of the firewall rule
    options List<String>
    region String
    Region of the network
    volumeIops Number
    Volume IOPS of the node data volume
    volumeSize Number
    Volume size of the node data volume
    volumeType String
    Volume type of the node data volume

    Package Details

    Repository
    pgedge pgEdge/pulumi-pgedge
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pgedge Terraform Provider.
    pgedge logo
    pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
    pgEdge/pulumi-pgedge