@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Describes a database on the Redis Enterprise cluster
*
* Uses Azure REST API version 2025-05-01-preview.
*
* Other available API versions: 2020-10-01-preview, 2021-02-01-preview, 2021-03-01, 2021-08-01, 2022-01-01, 2022-11-01-preview, 2023-03-01-preview, 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01, 2024-02-01, 2024-03-01-preview, 2024-06-01-preview, 2024-09-01-preview, 2024-10-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native redisenterprise [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Database extends pulumi.CustomResource {
/**
* Get an existing Database resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Database;
/**
* Returns true if the given object is an instance of Database. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Database;
/**
* This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.
*/
readonly accessKeysAuthentication: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
*/
readonly clientProtocol: pulumi.Output<string | undefined>;
/**
* Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.
*/
readonly clusteringPolicy: pulumi.Output<string | undefined>;
/**
* Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
*/
readonly deferUpgrade: pulumi.Output<string | undefined>;
/**
* Redis eviction policy - default is VolatileLRU
*/
readonly evictionPolicy: pulumi.Output<string | undefined>;
/**
* Optional set of properties to configure geo replication for this database.
*/
readonly geoReplication: pulumi.Output<outputs.redisenterprise.DatabasePropertiesResponseGeoReplication | undefined>;
/**
* Optional set of redis modules to enable in this database - modules can only be added at creation time.
*/
readonly modules: pulumi.Output<outputs.redisenterprise.ModuleResponse[] | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Persistence settings
*/
readonly persistence: pulumi.Output<outputs.redisenterprise.PersistenceResponse | undefined>;
/**
* TCP port of the database endpoint. Specified at create time. Defaults to an available port.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* Current provisioning status of the database
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Version of Redis the database is running on, e.g. '6.0'
*/
readonly redisVersion: pulumi.Output<string>;
/**
* Current resource status of the database
*/
readonly resourceState: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.redisenterprise.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a Database resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Database resource.
*/
export interface DatabaseArgs {
/**
* This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.
*/
accessKeysAuthentication?: pulumi.Input<string | enums.redisenterprise.AccessKeysAuthentication>;
/**
* Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
*/
clientProtocol?: pulumi.Input<string | enums.redisenterprise.Protocol>;
/**
* The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
*/
clusterName: pulumi.Input<string>;
/**
* Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.
*/
clusteringPolicy?: pulumi.Input<string | enums.redisenterprise.ClusteringPolicy>;
/**
* The name of the Redis Enterprise database.
*/
databaseName?: pulumi.Input<string>;
/**
* Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade
*/
deferUpgrade?: pulumi.Input<string | enums.redisenterprise.DeferUpgradeSetting>;
/**
* Redis eviction policy - default is VolatileLRU
*/
evictionPolicy?: pulumi.Input<string | enums.redisenterprise.EvictionPolicy>;
/**
* Optional set of properties to configure geo replication for this database.
*/
geoReplication?: pulumi.Input<inputs.redisenterprise.DatabasePropertiesGeoReplicationArgs>;
/**
* Optional set of redis modules to enable in this database - modules can only be added at creation time.
*/
modules?: pulumi.Input<pulumi.Input<inputs.redisenterprise.ModuleArgs>[]>;
/**
* Persistence settings
*/
persistence?: pulumi.Input<inputs.redisenterprise.PersistenceArgs>;
/**
* TCP port of the database endpoint. Specified at create time. Defaults to an available port.
*/
port?: pulumi.Input<number>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}