@pulumiverse/scaleway/redis/getCluster.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets information about a Redis™ cluster.
 *
 * For further information refer to the Managed Database for Redis™ [API documentation](https://developers.scaleway.com/en/products/redis/api/v1alpha1/#clusters-a85816).
 */
export declare function getCluster(args?: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>;
/**
 * A collection of arguments for invoking getCluster.
 */
export interface GetClusterArgs {
    /**
     * The Redis cluster ID.
     *
     * > **Note** You must specify at least one: `name` and/or `clusterId`.
     */
    clusterId?: string;
    /**
     * The name of the Redis cluster.
     */
    name?: string;
    /**
     * The ID of the project the Redis cluster is associated with.
     */
    projectId?: string;
    /**
     * `region`) The zone in which the server exists.
     */
    zone?: string;
}
/**
 * A collection of values returned by getCluster.
 */
export interface GetClusterResult {
    /**
     * List of acl rules.
     */
    readonly acls: outputs.redis.GetClusterAcl[];
    /**
     * The PEM of the certificate used by redis, only when `tlsEnabled` is true.
     */
    readonly certificate: string;
    readonly clusterId?: string;
    /**
     * The number of nodes in the Redis Cluster.
     */
    readonly clusterSize: number;
    readonly connectionString: string;
    /**
     * The date and time of creation of the Redis Cluster.
     */
    readonly createdAt: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name?: string;
    /**
     * The type of Redis Cluster (e.g. `RED1-M`).
     */
    readonly nodeType: string;
    /**
     * Password of the first user of the Redis Cluster.
     */
    readonly password: string;
    readonly passwordWo: string;
    readonly passwordWoVersion: number;
    readonly privateIps: outputs.redis.GetClusterPrivateIp[];
    /**
     * List of private networks endpoints of the Redis Cluster.
     */
    readonly privateNetworks: outputs.redis.GetClusterPrivateNetwork[];
    readonly projectId?: string;
    /**
     * Public network details.
     */
    readonly publicNetworks: outputs.redis.GetClusterPublicNetwork[];
    /**
     * Map of settings for redis cluster.
     */
    readonly settings: {
        [key: string]: string;
    };
    /**
     * The tags associated with the Redis Cluster.
     */
    readonly tags: string[];
    /**
     * Whether TLS is enabled or not.
     */
    readonly tlsEnabled: boolean;
    /**
     * The date and time of the last update of the Redis Cluster.
     */
    readonly updatedAt: string;
    /**
     * The first user of the Redis Cluster.
     */
    readonly userName: string;
    /**
     * Redis's Cluster version (e.g. `6.2.7`).
     */
    readonly version: string;
    readonly zone?: string;
}
/**
 * Gets information about a Redis™ cluster.
 *
 * For further information refer to the Managed Database for Redis™ [API documentation](https://developers.scaleway.com/en/products/redis/api/v1alpha1/#clusters-a85816).
 */
export declare function getClusterOutput(args?: GetClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterResult>;
/**
 * A collection of arguments for invoking getCluster.
 */
export interface GetClusterOutputArgs {
    /**
     * The Redis cluster ID.
     *
     * > **Note** You must specify at least one: `name` and/or `clusterId`.
     */
    clusterId?: pulumi.Input<string | undefined>;
    /**
     * The name of the Redis cluster.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project the Redis cluster is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The zone in which the server exists.
     */
    zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getCluster.d.ts.map