1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. getOrderableCluster
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.redshift.getOrderableCluster

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Information about Redshift Orderable Clusters and valid parameter combinations.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.redshift.getOrderableCluster({
    clusterType: "multi-node",
    preferredNodeTypes: [
        "dc2.large",
        "ds2.xlarge",
    ],
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.redshift.get_orderable_cluster(cluster_type="multi-node",
    preferred_node_types=[
        "dc2.large",
        "ds2.xlarge",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.GetOrderableCluster(ctx, &redshift.GetOrderableClusterArgs{
			ClusterType: pulumi.StringRef("multi-node"),
			PreferredNodeTypes: []string{
				"dc2.large",
				"ds2.xlarge",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.RedShift.GetOrderableCluster.Invoke(new()
    {
        ClusterType = "multi-node",
        PreferredNodeTypes = new[]
        {
            "dc2.large",
            "ds2.xlarge",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.RedshiftFunctions;
import com.pulumi.aws.redshift.inputs.GetOrderableClusterArgs;
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 test = RedshiftFunctions.getOrderableCluster(GetOrderableClusterArgs.builder()
            .clusterType("multi-node")
            .preferredNodeTypes(            
                "dc2.large",
                "ds2.xlarge")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:redshift:getOrderableCluster
      arguments:
        clusterType: multi-node
        preferredNodeTypes:
          - dc2.large
          - ds2.xlarge
Copy

Using getOrderableCluster

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 getOrderableCluster(args: GetOrderableClusterArgs, opts?: InvokeOptions): Promise<GetOrderableClusterResult>
function getOrderableClusterOutput(args: GetOrderableClusterOutputArgs, opts?: InvokeOptions): Output<GetOrderableClusterResult>
Copy
def get_orderable_cluster(cluster_type: Optional[str] = None,
                          cluster_version: Optional[str] = None,
                          node_type: Optional[str] = None,
                          preferred_node_types: Optional[Sequence[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOrderableClusterResult
def get_orderable_cluster_output(cluster_type: Optional[pulumi.Input[str]] = None,
                          cluster_version: Optional[pulumi.Input[str]] = None,
                          node_type: Optional[pulumi.Input[str]] = None,
                          preferred_node_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOrderableClusterResult]
Copy
func GetOrderableCluster(ctx *Context, args *GetOrderableClusterArgs, opts ...InvokeOption) (*GetOrderableClusterResult, error)
func GetOrderableClusterOutput(ctx *Context, args *GetOrderableClusterOutputArgs, opts ...InvokeOption) GetOrderableClusterResultOutput
Copy

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

public static class GetOrderableCluster 
{
    public static Task<GetOrderableClusterResult> InvokeAsync(GetOrderableClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetOrderableClusterResult> Invoke(GetOrderableClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrderableClusterResult> getOrderableCluster(GetOrderableClusterArgs args, InvokeOptions options)
public static Output<GetOrderableClusterResult> getOrderableCluster(GetOrderableClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:redshift/getOrderableCluster:getOrderableCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterType string
Reshift Cluster typeE.g., multi-node or single-node
ClusterVersion string
Redshift Cluster versionE.g., 1.0
NodeType string
Redshift Cluster node typeE.g., dc2.8xlarge
PreferredNodeTypes List<string>
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
ClusterType string
Reshift Cluster typeE.g., multi-node or single-node
ClusterVersion string
Redshift Cluster versionE.g., 1.0
NodeType string
Redshift Cluster node typeE.g., dc2.8xlarge
PreferredNodeTypes []string
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
clusterType String
Reshift Cluster typeE.g., multi-node or single-node
clusterVersion String
Redshift Cluster versionE.g., 1.0
nodeType String
Redshift Cluster node typeE.g., dc2.8xlarge
preferredNodeTypes List<String>
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
clusterType string
Reshift Cluster typeE.g., multi-node or single-node
clusterVersion string
Redshift Cluster versionE.g., 1.0
nodeType string
Redshift Cluster node typeE.g., dc2.8xlarge
preferredNodeTypes string[]
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
cluster_type str
Reshift Cluster typeE.g., multi-node or single-node
cluster_version str
Redshift Cluster versionE.g., 1.0
node_type str
Redshift Cluster node typeE.g., dc2.8xlarge
preferred_node_types Sequence[str]
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
clusterType String
Reshift Cluster typeE.g., multi-node or single-node
clusterVersion String
Redshift Cluster versionE.g., 1.0
nodeType String
Redshift Cluster node typeE.g., dc2.8xlarge
preferredNodeTypes List<String>
Ordered list of preferred Redshift Cluster node types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.

getOrderableCluster Result

The following output properties are available:

AvailabilityZones List<string>
List of Availability Zone names where the Redshift Cluster is available.
ClusterType string
ClusterVersion string
Id string
The provider-assigned unique ID for this managed resource.
NodeType string
PreferredNodeTypes List<string>
AvailabilityZones []string
List of Availability Zone names where the Redshift Cluster is available.
ClusterType string
ClusterVersion string
Id string
The provider-assigned unique ID for this managed resource.
NodeType string
PreferredNodeTypes []string
availabilityZones List<String>
List of Availability Zone names where the Redshift Cluster is available.
clusterType String
clusterVersion String
id String
The provider-assigned unique ID for this managed resource.
nodeType String
preferredNodeTypes List<String>
availabilityZones string[]
List of Availability Zone names where the Redshift Cluster is available.
clusterType string
clusterVersion string
id string
The provider-assigned unique ID for this managed resource.
nodeType string
preferredNodeTypes string[]
availability_zones Sequence[str]
List of Availability Zone names where the Redshift Cluster is available.
cluster_type str
cluster_version str
id str
The provider-assigned unique ID for this managed resource.
node_type str
preferred_node_types Sequence[str]
availabilityZones List<String>
List of Availability Zone names where the Redshift Cluster is available.
clusterType String
clusterVersion String
id String
The provider-assigned unique ID for this managed resource.
nodeType String
preferredNodeTypes List<String>

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi