Package com.pulumi.aws.memorydb

Class MultiRegionCluster

  • public class MultiRegionCluster
extends com.pulumi.resources.CustomResource
    Provides a MemoryDB Multi Region Cluster. More information about MemoryDB can be found in the [Developer Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/what-is-memorydb-for-redis.html). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.memorydb.MultiRegionCluster;
 import com.pulumi.aws.memorydb.MultiRegionClusterArgs;
 import com.pulumi.aws.memorydb.Cluster;
 import com.pulumi.aws.memorydb.ClusterArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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 example = new MultiRegionCluster("example", MultiRegionClusterArgs.builder()
             .multiRegionClusterNameSuffix("example")
             .nodeType("db.r7g.xlarge")
             .build());
 
         var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
             .aclName(exampleAwsMemorydbAcl.id())
             .autoMinorVersionUpgrade(false)
             .name("example")
             .nodeType("db.t4g.small")
             .numShards(2)
             .securityGroupIds(exampleAwsSecurityGroup.id())
             .snapshotRetentionLimit(7)
             .subnetGroupName(exampleAwsMemorydbSubnetGroup.id())
             .multiRegionClusterName(example.multiRegionClusterName())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a cluster using the `multiRegionClusterName`. For example: ```sh $ pulumi import aws:memorydb/multiRegionCluster:MultiRegionCluster example virxk-example ```

    • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> engine()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      static MultiRegionCluster get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MultiRegionClusterState state, 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.lang.String> multiRegionClusterName()  
      com.pulumi.core.Output<java.lang.String> multiRegionClusterNameSuffix()  
      com.pulumi.core.Output<java.lang.String> multiRegionParameterGroupName()  
      com.pulumi.core.Output<java.lang.String> nodeType()  
      com.pulumi.core.Output<java.lang.Integer> numShards()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<MultiRegionClusterTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.Boolean> tlsEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> updateStrategy()  

      • 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

      • MultiRegionCluster

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

      • MultiRegionCluster

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

      • MultiRegionCluster

        public MultiRegionCluster​(java.lang.String name,
                          MultiRegionClusterArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the multi-region cluster.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the multi-region cluster.

      • engine

        public com.pulumi.core.Output<java.lang.String> engine()
        Returns:
        Name of the engine to be used for the multi-region cluster. Valid values are `redis` and `valkey`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Version of the engine to be used for the multi-region cluster. Downgrades are not supported.

      • multiRegionClusterName

        public com.pulumi.core.Output<java.lang.String> multiRegionClusterName()
        Returns:
        Name of the multi-region cluster.

      • multiRegionClusterNameSuffix

        public com.pulumi.core.Output<java.lang.String> multiRegionClusterNameSuffix()
        Returns:
        Suffix to be added to the multi-region cluster name. An AWS generated prefix is automatically applied to the multi-region cluster name when it is created.

      • multiRegionParameterGroupName

        public com.pulumi.core.Output<java.lang.String> multiRegionParameterGroupName()
        Returns:
        Name of the multi-region parameter group to be associated with the cluster.

      • nodeType

        public com.pulumi.core.Output<java.lang.String> nodeType()
        Returns:
        Node type to be used for the multi-region cluster. The following arguments are optional:

      • numShards

        public com.pulumi.core.Output<java.lang.Integer> numShards()
        Returns:
        Number of shards for the multi-region cluster.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the multi-region cluster.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • tlsEnabled

        public com.pulumi.core.Output<java.lang.Boolean> tlsEnabled()
        Returns:
        Whether to enable in-transit encryption on the cluster.

      • updateStrategy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> updateStrategy()
        Returns:
        Strategy to use for the multi-region cluster update. Valid values are `coordinated` and `uncoordinated`.

      • get

        public static MultiRegionCluster get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     MultiRegionClusterState state,
                                     @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.
        state -
        options - Optional settings to control the behavior of the CustomResource.