Package com.pulumi.azurenative.cache

Class Database

  • public class Database
extends com.pulumi.resources.CustomResource
    Describes a database on the RedisEnterprise cluster Azure REST API version: 2023-03-01-preview. Prior API version in Azure Native 1.x: 2021-03-01. Other available API versions: 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01. ## Example Usage ### RedisEnterpriseDatabasesCreate ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azurenative.cache.Database; import com.pulumi.azurenative.cache.DatabaseArgs; 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) { var database = new Database("database", DatabaseArgs.builder() .clientProtocol("Encrypted") .clusterName("cache1") .clusteringPolicy("EnterpriseCluster") .databaseName("default") .evictionPolicy("AllKeysLRU") .modules( Map.ofEntries( Map.entry("args", "ERROR_RATE 0.00 INITIAL_SIZE 400"), Map.entry("name", "RedisBloom") ), Map.ofEntries( Map.entry("args", "RETENTION_POLICY 20"), Map.entry("name", "RedisTimeSeries") ), Map.of("name", "RediSearch")) .persistence(Map.ofEntries( Map.entry("aofEnabled", true), Map.entry("aofFrequency", "1s") )) .port(10000) .resourceGroupName("rg1") .build()); } } ``` ### RedisEnterpriseDatabasesCreate With Active Geo Replication ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.azurenative.cache.Database; import com.pulumi.azurenative.cache.DatabaseArgs; 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) { var database = new Database("database", DatabaseArgs.builder() .clientProtocol("Encrypted") .clusterName("cache1") .clusteringPolicy("EnterpriseCluster") .databaseName("default") .evictionPolicy("NoEviction") .geoReplication(Map.ofEntries( Map.entry("groupNickname", "groupName"), Map.entry("linkedDatabases", Map.of("id", "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"), Map.of("id", "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default")) )) .port(10000) .resourceGroupName("rg1") .build()); } } ``` ## Import An existing resource can be imported using its type token, name, and identifier, e.g. ```sh $ pulumi import azure-native:cache:Database cache1/default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName} ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Database​(java.lang.String name)  
      Database​(java.lang.String name, DatabaseArgs args)  
      Database​(java.lang.String name, DatabaseArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientProtocol()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> clusteringPolicy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> evictionPolicy()  
      com.pulumi.core.Output<java.util.Optional<DatabasePropertiesResponseGeoReplication>> geoReplication()  
      static Database get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<ModuleResponse>>> modules()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<PersistenceResponse>> persistence()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()  
      com.pulumi.core.Output<java.lang.String> provisioningState()  
      com.pulumi.core.Output<java.lang.String> resourceState()  
      com.pulumi.core.Output<SystemDataResponse> systemData()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Database

        public Database​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Database

        public Database​(java.lang.String name,
                DatabaseArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Database

        public Database​(java.lang.String name,
                DatabaseArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • clientProtocol

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientProtocol()
        Returns:
        Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

      • clusteringPolicy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clusteringPolicy()
        Returns:
        Clustering policy - default is OSSCluster. Specified at create time.

      • evictionPolicy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> evictionPolicy()
        Returns:
        Redis eviction policy - default is VolatileLRU

      • geoReplication

        public com.pulumi.core.Output<java.util.Optional<DatabasePropertiesResponseGeoReplication>> geoReplication()
        Returns:
        Optional set of properties to configure geo replication for this database.

      • modules

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ModuleResponse>>> modules()
        Returns:
        Optional set of redis modules to enable in this database - modules can only be added at creation time.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the resource

      • persistence

        public com.pulumi.core.Output<java.util.Optional<PersistenceResponse>> persistence()
        Returns:
        Persistence settings

      • port

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()
        Returns:
        TCP port of the database endpoint. Specified at create time. Defaults to an available port.

      • provisioningState

        public com.pulumi.core.Output<java.lang.String> provisioningState()
        Returns:
        Current provisioning status of the database

      • resourceState

        public com.pulumi.core.Output<java.lang.String> resourceState()
        Returns:
        Current resource status of the database

      • systemData

        public com.pulumi.core.Output<SystemDataResponse> systemData()
        Returns:
        Azure Resource Manager metadata containing createdBy and modifiedBy information.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

      • get

        public static Database get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        options - Optional settings to control the behavior of the CustomResource.