import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Redis Cluster resource in Oracle Cloud Infrastructure Redis service. * * Retrieves the specified Oracle Cloud Infrastructure Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](https://docs.cloud.oracle.com/iaas/Content/ocicache/home.htm). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testRedisCluster = oci.redis.getRedisCluster({ * redisClusterId: testRedisClusterOciRedisRedisCluster.id, * }); * ``` */ export declare function getRedisCluster(args: GetRedisClusterArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getRedisCluster. */ export interface GetRedisClusterArgs { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ redisClusterId: string; } /** * A collection of values returned by getRedisCluster. */ export interface GetRedisClusterResult { /** * The ID of the Oracle Cloud Infrastructure Cache Backup from which this cluster was created. */ readonly backupId: string; /** * Specifies whether the cluster is sharded or non-sharded. */ readonly clusterMode: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. */ readonly compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: { [key: string]: string; }; /** * The private IP address of the API endpoint for sharded cluster discovery. */ readonly discoveryEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery. */ readonly discoveryFqdn: string; /** * A user-friendly name of a cluster node. */ readonly displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ readonly id: string; /** * Details for importing Oracle Cloud Infrastructure Cache data from Object Storage RDB file(s) during cluster creation. */ readonly importFromObjectStorageDetails: outputs.Redis.GetRedisClusterImportFromObjectStorageDetail[]; /** * A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state. */ readonly lifecycleDetails: string; /** * The collection of cluster nodes. */ readonly nodeCollections: outputs.Redis.GetRedisClusterNodeCollection[]; /** * The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. */ readonly nodeCount: number; /** * The amount of memory allocated to the cluster's nodes, in gigabytes. */ readonly nodeMemoryInGbs: number; /** * A list of Network Security Group (NSG) [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](https://docs.cloud.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). */ readonly nsgIds: string[]; /** * The ID of the corresponding Oracle Cloud Infrastructure Cache Config Set for the cluster. */ readonly ociCacheConfigSetId: string; /** * The private IP address of the API endpoint for the cluster's primary node. */ readonly primaryEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node. */ readonly primaryFqdn: string; readonly redisClusterId: string; /** * The private IP address of the API endpoint for the cluster's replica nodes. */ readonly replicasEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes. */ readonly replicasFqdn: string; /** * Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` */ readonly securityAttributes: { [key: string]: string; }; /** * The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. */ readonly shardCount: number; /** * The Oracle Cloud Infrastructure Cache engine version that the cluster is running. */ readonly softwareVersion: string; /** * The current state of the cluster. */ readonly state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. */ readonly subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: { [key: string]: string; }; /** * The date and time the cluster was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ readonly timeCreated: string; /** * The date and time the cluster was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ readonly timeUpdated: string; } /** * This data source provides details about a specific Redis Cluster resource in Oracle Cloud Infrastructure Redis service. * * Retrieves the specified Oracle Cloud Infrastructure Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](https://docs.cloud.oracle.com/iaas/Content/ocicache/home.htm). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testRedisCluster = oci.redis.getRedisCluster({ * redisClusterId: testRedisClusterOciRedisRedisCluster.id, * }); * ``` */ export declare function getRedisClusterOutput(args: GetRedisClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getRedisCluster. */ export interface GetRedisClusterOutputArgs { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ redisClusterId: pulumi.Input; } //# sourceMappingURL=getRedisCluster.d.ts.map