Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. getCluster
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.redshift.getCluster

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    Provides details about a specific redshift cluster.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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.GetClusterArgs;
import com.pulumi.aws.kinesis.FirehoseDeliveryStream;
import com.pulumi.aws.kinesis.FirehoseDeliveryStreamArgs;
import com.pulumi.aws.kinesis.inputs.FirehoseDeliveryStreamRedshiftConfigurationArgs;
import com.pulumi.aws.kinesis.inputs.FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationArgs;
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 = RedshiftFunctions.getCluster(GetClusterArgs.builder()
            .clusterIdentifier("example-cluster")
            .build());

        var exampleStream = new FirehoseDeliveryStream("exampleStream", FirehoseDeliveryStreamArgs.builder()
            .name("kinesis-firehose-example-stream")
            .destination("redshift")
            .redshiftConfiguration(FirehoseDeliveryStreamRedshiftConfigurationArgs.builder()
                .roleArn(firehoseRole.arn())
                .clusterJdbcurl(String.format("jdbc:redshift://%s/%s", example.applyValue(getClusterResult -> getClusterResult.endpoint()),example.applyValue(getClusterResult -> getClusterResult.databaseName())))
                .username("exampleuser")
                .password("Exampl3Pass")
                .dataTableName("example-table")
                .copyOptions("delimiter '|'")
                .dataTableColumns("example-col")
                .s3Configuration(FirehoseDeliveryStreamRedshiftConfigurationS3ConfigurationArgs.builder()
                    .roleArn(firehoseRole.arn())
                    .bucketArn(bucket.arn())
                    .bufferSize(10)
                    .bufferInterval(400)
                    .compressionFormat("GZIP")
                    .build())
                .build())
            .build());

    }
}

    resources:
  exampleStream:
    type: aws:kinesis:FirehoseDeliveryStream
    name: example_stream
    properties:
      name: kinesis-firehose-example-stream
      destination: redshift
      redshiftConfiguration:
        roleArn: ${firehoseRole.arn}
        clusterJdbcurl: jdbc:redshift://${example.endpoint}/${example.databaseName}
        username: exampleuser
        password: Exampl3Pass
        dataTableName: example-table
        copyOptions: delimiter '|'
        dataTableColumns: example-col
        s3Configuration:
          roleArn: ${firehoseRole.arn}
          bucketArn: ${bucket.arn}
          bufferSize: 10
          bufferInterval: 400
          compressionFormat: GZIP
variables:
  example:
    fn::invoke:
      function: aws:redshift:getCluster
      arguments:
        clusterIdentifier: example-cluster

    Using getCluster

    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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(cluster_identifier: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_identifier: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:redshift/getCluster:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterIdentifier string
    Cluster identifier
    Tags Dictionary<string, string>
    Tags associated to the cluster
    ClusterIdentifier string
    Cluster identifier
    Tags map[string]string
    Tags associated to the cluster
    clusterIdentifier String
    Cluster identifier
    tags Map<String,String>
    Tags associated to the cluster
    clusterIdentifier string
    Cluster identifier
    tags {[key: string]: string}
    Tags associated to the cluster
    cluster_identifier str
    Cluster identifier
    tags Mapping[str, str]
    Tags associated to the cluster
    clusterIdentifier String
    Cluster identifier
    tags Map<String>
    Tags associated to the cluster

    getCluster Result

    The following output properties are available:

    AllowVersionUpgrade bool
    Whether major version upgrades can be applied during maintenance period
    AquaConfigurationStatus string
    The value represents how the cluster is configured to use AQUA.
    Arn string
    ARN of cluster.
    AutomatedSnapshotRetentionPeriod int
    The backup retention period
    AvailabilityZone string
    Availability zone of the cluster
    AvailabilityZoneRelocationEnabled bool
    Indicates whether the cluster is able to be relocated to another availability zone.
    BucketName string
    Name of the S3 bucket where the log files are to be stored
    ClusterIdentifier string
    Cluster identifier
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    ClusterNodes List<GetClusterClusterNode>
    Nodes in the cluster. Cluster node blocks are documented below
    ClusterParameterGroupName string
    The name of the parameter group to be associated with this cluster
    ClusterPublicKey string
    Public key for the cluster
    ClusterRevisionNumber string
    The cluster revision number
    ClusterSubnetGroupName string
    The name of a cluster subnet group to be associated with this cluster
    ClusterType string
    Cluster type
    ClusterVersion string
    DatabaseName string
    Name of the default database in the cluster
    DefaultIamRoleArn string
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    ElasticIp string
    Elastic IP of the cluster
    EnableLogging bool
    Whether cluster logging is enabled
    Encrypted bool
    Whether the cluster data is encrypted
    Endpoint string
    Cluster endpoint
    EnhancedVpcRouting bool
    Whether enhanced VPC routing is enabled
    IamRoles List<string>
    IAM roles associated to the cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    KMS encryption key associated to the cluster
    LogDestinationType string
    The log destination type.
    LogExports List<string>
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    MaintenanceTrackName string
    The name of the maintenance track for the restored cluster.
    ManualSnapshotRetentionPeriod int
    (Optional) The default number of days to retain a manual snapshot.
    MasterUsername string
    Username for the master DB user
    MultiAz bool
    If the cluster is a Multi-AZ deployment
    NodeType string
    Cluster node type
    NumberOfNodes int
    Number of nodes in the cluster
    Port int
    Port the cluster responds on
    PreferredMaintenanceWindow string
    The maintenance window
    PubliclyAccessible bool
    Whether the cluster is publicly accessible
    S3KeyPrefix string
    Folder inside the S3 bucket where the log files are stored
    Tags Dictionary<string, string>
    Tags associated to the cluster
    VpcId string
    VPC Id associated with the cluster
    VpcSecurityGroupIds List<string>
    The VPC security group Ids associated with the cluster
    AllowVersionUpgrade bool
    Whether major version upgrades can be applied during maintenance period
    AquaConfigurationStatus string
    The value represents how the cluster is configured to use AQUA.
    Arn string
    ARN of cluster.
    AutomatedSnapshotRetentionPeriod int
    The backup retention period
    AvailabilityZone string
    Availability zone of the cluster
    AvailabilityZoneRelocationEnabled bool
    Indicates whether the cluster is able to be relocated to another availability zone.
    BucketName string
    Name of the S3 bucket where the log files are to be stored
    ClusterIdentifier string
    Cluster identifier
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    ClusterNodes []GetClusterClusterNode
    Nodes in the cluster. Cluster node blocks are documented below
    ClusterParameterGroupName string
    The name of the parameter group to be associated with this cluster
    ClusterPublicKey string
    Public key for the cluster
    ClusterRevisionNumber string
    The cluster revision number
    ClusterSubnetGroupName string
    The name of a cluster subnet group to be associated with this cluster
    ClusterType string
    Cluster type
    ClusterVersion string
    DatabaseName string
    Name of the default database in the cluster
    DefaultIamRoleArn string
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    ElasticIp string
    Elastic IP of the cluster
    EnableLogging bool
    Whether cluster logging is enabled
    Encrypted bool
    Whether the cluster data is encrypted
    Endpoint string
    Cluster endpoint
    EnhancedVpcRouting bool
    Whether enhanced VPC routing is enabled
    IamRoles []string
    IAM roles associated to the cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    KMS encryption key associated to the cluster
    LogDestinationType string
    The log destination type.
    LogExports []string
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    MaintenanceTrackName string
    The name of the maintenance track for the restored cluster.
    ManualSnapshotRetentionPeriod int
    (Optional) The default number of days to retain a manual snapshot.
    MasterUsername string
    Username for the master DB user
    MultiAz bool
    If the cluster is a Multi-AZ deployment
    NodeType string
    Cluster node type
    NumberOfNodes int
    Number of nodes in the cluster
    Port int
    Port the cluster responds on
    PreferredMaintenanceWindow string
    The maintenance window
    PubliclyAccessible bool
    Whether the cluster is publicly accessible
    S3KeyPrefix string
    Folder inside the S3 bucket where the log files are stored
    Tags map[string]string
    Tags associated to the cluster
    VpcId string
    VPC Id associated with the cluster
    VpcSecurityGroupIds []string
    The VPC security group Ids associated with the cluster
    allowVersionUpgrade Boolean
    Whether major version upgrades can be applied during maintenance period
    aquaConfigurationStatus String
    The value represents how the cluster is configured to use AQUA.
    arn String
    ARN of cluster.
    automatedSnapshotRetentionPeriod Integer
    The backup retention period
    availabilityZone String
    Availability zone of the cluster
    availabilityZoneRelocationEnabled Boolean
    Indicates whether the cluster is able to be relocated to another availability zone.
    bucketName String
    Name of the S3 bucket where the log files are to be stored
    clusterIdentifier String
    Cluster identifier
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the cluster
    clusterNodes List<GetClusterClusterNode>
    Nodes in the cluster. Cluster node blocks are documented below
    clusterParameterGroupName String
    The name of the parameter group to be associated with this cluster
    clusterPublicKey String
    Public key for the cluster
    clusterRevisionNumber String
    The cluster revision number
    clusterSubnetGroupName String
    The name of a cluster subnet group to be associated with this cluster
    clusterType String
    Cluster type
    clusterVersion String
    databaseName String
    Name of the default database in the cluster
    defaultIamRoleArn String
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    elasticIp String
    Elastic IP of the cluster
    enableLogging Boolean
    Whether cluster logging is enabled
    encrypted Boolean
    Whether the cluster data is encrypted
    endpoint String
    Cluster endpoint
    enhancedVpcRouting Boolean
    Whether enhanced VPC routing is enabled
    iamRoles List<String>
    IAM roles associated to the cluster
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    KMS encryption key associated to the cluster
    logDestinationType String
    The log destination type.
    logExports List<String>
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    maintenanceTrackName String
    The name of the maintenance track for the restored cluster.
    manualSnapshotRetentionPeriod Integer
    (Optional) The default number of days to retain a manual snapshot.
    masterUsername String
    Username for the master DB user
    multiAz Boolean
    If the cluster is a Multi-AZ deployment
    nodeType String
    Cluster node type
    numberOfNodes Integer
    Number of nodes in the cluster
    port Integer
    Port the cluster responds on
    preferredMaintenanceWindow String
    The maintenance window
    publiclyAccessible Boolean
    Whether the cluster is publicly accessible
    s3KeyPrefix String
    Folder inside the S3 bucket where the log files are stored
    tags Map<String,String>
    Tags associated to the cluster
    vpcId String
    VPC Id associated with the cluster
    vpcSecurityGroupIds List<String>
    The VPC security group Ids associated with the cluster
    allowVersionUpgrade boolean
    Whether major version upgrades can be applied during maintenance period
    aquaConfigurationStatus string
    The value represents how the cluster is configured to use AQUA.
    arn string
    ARN of cluster.
    automatedSnapshotRetentionPeriod number
    The backup retention period
    availabilityZone string
    Availability zone of the cluster
    availabilityZoneRelocationEnabled boolean
    Indicates whether the cluster is able to be relocated to another availability zone.
    bucketName string
    Name of the S3 bucket where the log files are to be stored
    clusterIdentifier string
    Cluster identifier
    clusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    clusterNodes GetClusterClusterNode[]
    Nodes in the cluster. Cluster node blocks are documented below
    clusterParameterGroupName string
    The name of the parameter group to be associated with this cluster
    clusterPublicKey string
    Public key for the cluster
    clusterRevisionNumber string
    The cluster revision number
    clusterSubnetGroupName string
    The name of a cluster subnet group to be associated with this cluster
    clusterType string
    Cluster type
    clusterVersion string
    databaseName string
    Name of the default database in the cluster
    defaultIamRoleArn string
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    elasticIp string
    Elastic IP of the cluster
    enableLogging boolean
    Whether cluster logging is enabled
    encrypted boolean
    Whether the cluster data is encrypted
    endpoint string
    Cluster endpoint
    enhancedVpcRouting boolean
    Whether enhanced VPC routing is enabled
    iamRoles string[]
    IAM roles associated to the cluster
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    KMS encryption key associated to the cluster
    logDestinationType string
    The log destination type.
    logExports string[]
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    maintenanceTrackName string
    The name of the maintenance track for the restored cluster.
    manualSnapshotRetentionPeriod number
    (Optional) The default number of days to retain a manual snapshot.
    masterUsername string
    Username for the master DB user
    multiAz boolean
    If the cluster is a Multi-AZ deployment
    nodeType string
    Cluster node type
    numberOfNodes number
    Number of nodes in the cluster
    port number
    Port the cluster responds on
    preferredMaintenanceWindow string
    The maintenance window
    publiclyAccessible boolean
    Whether the cluster is publicly accessible
    s3KeyPrefix string
    Folder inside the S3 bucket where the log files are stored
    tags {[key: string]: string}
    Tags associated to the cluster
    vpcId string
    VPC Id associated with the cluster
    vpcSecurityGroupIds string[]
    The VPC security group Ids associated with the cluster
    allow_version_upgrade bool
    Whether major version upgrades can be applied during maintenance period
    aqua_configuration_status str
    The value represents how the cluster is configured to use AQUA.
    arn str
    ARN of cluster.
    automated_snapshot_retention_period int
    The backup retention period
    availability_zone str
    Availability zone of the cluster
    availability_zone_relocation_enabled bool
    Indicates whether the cluster is able to be relocated to another availability zone.
    bucket_name str
    Name of the S3 bucket where the log files are to be stored
    cluster_identifier str
    Cluster identifier
    cluster_namespace_arn str
    The namespace Amazon Resource Name (ARN) of the cluster
    cluster_nodes Sequence[GetClusterClusterNode]
    Nodes in the cluster. Cluster node blocks are documented below
    cluster_parameter_group_name str
    The name of the parameter group to be associated with this cluster
    cluster_public_key str
    Public key for the cluster
    cluster_revision_number str
    The cluster revision number
    cluster_subnet_group_name str
    The name of a cluster subnet group to be associated with this cluster
    cluster_type str
    Cluster type
    cluster_version str
    database_name str
    Name of the default database in the cluster
    default_iam_role_arn str
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    elastic_ip str
    Elastic IP of the cluster
    enable_logging bool
    Whether cluster logging is enabled
    encrypted bool
    Whether the cluster data is encrypted
    endpoint str
    Cluster endpoint
    enhanced_vpc_routing bool
    Whether enhanced VPC routing is enabled
    iam_roles Sequence[str]
    IAM roles associated to the cluster
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    KMS encryption key associated to the cluster
    log_destination_type str
    The log destination type.
    log_exports Sequence[str]
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    maintenance_track_name str
    The name of the maintenance track for the restored cluster.
    manual_snapshot_retention_period int
    (Optional) The default number of days to retain a manual snapshot.
    master_username str
    Username for the master DB user
    multi_az bool
    If the cluster is a Multi-AZ deployment
    node_type str
    Cluster node type
    number_of_nodes int
    Number of nodes in the cluster
    port int
    Port the cluster responds on
    preferred_maintenance_window str
    The maintenance window
    publicly_accessible bool
    Whether the cluster is publicly accessible
    s3_key_prefix str
    Folder inside the S3 bucket where the log files are stored
    tags Mapping[str, str]
    Tags associated to the cluster
    vpc_id str
    VPC Id associated with the cluster
    vpc_security_group_ids Sequence[str]
    The VPC security group Ids associated with the cluster
    allowVersionUpgrade Boolean
    Whether major version upgrades can be applied during maintenance period
    aquaConfigurationStatus String
    The value represents how the cluster is configured to use AQUA.
    arn String
    ARN of cluster.
    automatedSnapshotRetentionPeriod Number
    The backup retention period
    availabilityZone String
    Availability zone of the cluster
    availabilityZoneRelocationEnabled Boolean
    Indicates whether the cluster is able to be relocated to another availability zone.
    bucketName String
    Name of the S3 bucket where the log files are to be stored
    clusterIdentifier String
    Cluster identifier
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the cluster
    clusterNodes List<Property Map>
    Nodes in the cluster. Cluster node blocks are documented below
    clusterParameterGroupName String
    The name of the parameter group to be associated with this cluster
    clusterPublicKey String
    Public key for the cluster
    clusterRevisionNumber String
    The cluster revision number
    clusterSubnetGroupName String
    The name of a cluster subnet group to be associated with this cluster
    clusterType String
    Cluster type
    clusterVersion String
    databaseName String
    Name of the default database in the cluster
    defaultIamRoleArn String
    The ARN for the IAM role that was set as default for the cluster when the cluster was created.
    elasticIp String
    Elastic IP of the cluster
    enableLogging Boolean
    Whether cluster logging is enabled
    encrypted Boolean
    Whether the cluster data is encrypted
    endpoint String
    Cluster endpoint
    enhancedVpcRouting Boolean
    Whether enhanced VPC routing is enabled
    iamRoles List<String>
    IAM roles associated to the cluster
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    KMS encryption key associated to the cluster
    logDestinationType String
    The log destination type.
    logExports List<String>
    Collection of exported log types. Log types include the connection log, user log and user activity log.
    maintenanceTrackName String
    The name of the maintenance track for the restored cluster.
    manualSnapshotRetentionPeriod Number
    (Optional) The default number of days to retain a manual snapshot.
    masterUsername String
    Username for the master DB user
    multiAz Boolean
    If the cluster is a Multi-AZ deployment
    nodeType String
    Cluster node type
    numberOfNodes Number
    Number of nodes in the cluster
    port Number
    Port the cluster responds on
    preferredMaintenanceWindow String
    The maintenance window
    publiclyAccessible Boolean
    Whether the cluster is publicly accessible
    s3KeyPrefix String
    Folder inside the S3 bucket where the log files are stored
    tags Map<String>
    Tags associated to the cluster
    vpcId String
    VPC Id associated with the cluster
    vpcSecurityGroupIds List<String>
    The VPC security group Ids associated with the cluster

    Supporting Types

    GetClusterClusterNode

    NodeRole string
    Whether the node is a leader node or a compute node
    PrivateIpAddress string
    Private IP address of a node within a cluster
    PublicIpAddress string
    Public IP address of a node within a cluster
    NodeRole string
    Whether the node is a leader node or a compute node
    PrivateIpAddress string
    Private IP address of a node within a cluster
    PublicIpAddress string
    Public IP address of a node within a cluster
    nodeRole String
    Whether the node is a leader node or a compute node
    privateIpAddress String
    Private IP address of a node within a cluster
    publicIpAddress String
    Public IP address of a node within a cluster
    nodeRole string
    Whether the node is a leader node or a compute node
    privateIpAddress string
    Private IP address of a node within a cluster
    publicIpAddress string
    Public IP address of a node within a cluster
    node_role str
    Whether the node is a leader node or a compute node
    private_ip_address str
    Private IP address of a node within a cluster
    public_ip_address str
    Public IP address of a node within a cluster
    nodeRole String
    Whether the node is a leader node or a compute node
    privateIpAddress String
    Private IP address of a node within a cluster
    publicIpAddress String
    Public IP address of a node within a cluster

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws