Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. memorydb
  5. MultiRegionCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.memorydb.MultiRegionCluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.

    Create MultiRegionCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MultiRegionCluster(name: string, args: MultiRegionClusterArgs, opts?: CustomResourceOptions);
    @overload
def MultiRegionCluster(resource_name: str,
                       args: MultiRegionClusterArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def MultiRegionCluster(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       node_type: Optional[str] = None,
                       description: Optional[str] = None,
                       engine: Optional[str] = None,
                       engine_version: Optional[str] = None,
                       multi_region_cluster_name_suffix: Optional[str] = None,
                       multi_region_parameter_group_name: Optional[str] = None,
                       num_shards: Optional[int] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                       tls_enabled: Optional[bool] = None,
                       update_strategy: Optional[MultiRegionClusterUpdateStrategy] = None)
    func NewMultiRegionCluster(ctx *Context, name string, args MultiRegionClusterArgs, opts ...ResourceOption) (*MultiRegionCluster, error)
    public MultiRegionCluster(string name, MultiRegionClusterArgs args, CustomResourceOptions? opts = null)
    public MultiRegionCluster(String name, MultiRegionClusterArgs args)
public MultiRegionCluster(String name, MultiRegionClusterArgs args, CustomResourceOptions options)

    type: aws-native:memorydb:MultiRegionCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MultiRegionClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MultiRegionClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MultiRegionClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MultiRegionClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MultiRegionClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    MultiRegionCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MultiRegionCluster resource accepts the following input properties:

    NodeType string
    The compute and memory capacity of the nodes in the multi region cluster.
    Description string
    Description of the multi region cluster.
    Engine string
    The engine type used by the multi region cluster.
    EngineVersion string
    The Redis engine version used by the multi region cluster.
    MultiRegionClusterNameSuffix string
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    MultiRegionParameterGroupName string
    The name of the parameter group associated with the multi region cluster.
    NumShards int
    The number of shards the multi region cluster will contain.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this multi region cluster.
    TlsEnabled bool

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    UpdateStrategy Pulumi.AwsNative.MemoryDb.MultiRegionClusterUpdateStrategy
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
    NodeType string
    The compute and memory capacity of the nodes in the multi region cluster.
    Description string
    Description of the multi region cluster.
    Engine string
    The engine type used by the multi region cluster.
    EngineVersion string
    The Redis engine version used by the multi region cluster.
    MultiRegionClusterNameSuffix string
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    MultiRegionParameterGroupName string
    The name of the parameter group associated with the multi region cluster.
    NumShards int
    The number of shards the multi region cluster will contain.
    Tags TagArgs
    An array of key-value pairs to apply to this multi region cluster.
    TlsEnabled bool

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    UpdateStrategy MultiRegionClusterUpdateStrategy
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
    nodeType String
    The compute and memory capacity of the nodes in the multi region cluster.
    description String
    Description of the multi region cluster.
    engine String
    The engine type used by the multi region cluster.
    engineVersion String
    The Redis engine version used by the multi region cluster.
    multiRegionClusterNameSuffix String
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    multiRegionParameterGroupName String
    The name of the parameter group associated with the multi region cluster.
    numShards Integer
    The number of shards the multi region cluster will contain.
    tags List<Tag>
    An array of key-value pairs to apply to this multi region cluster.
    tlsEnabled Boolean

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    updateStrategy MultiRegionClusterUpdateStrategy
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
    nodeType string
    The compute and memory capacity of the nodes in the multi region cluster.
    description string
    Description of the multi region cluster.
    engine string
    The engine type used by the multi region cluster.
    engineVersion string
    The Redis engine version used by the multi region cluster.
    multiRegionClusterNameSuffix string
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    multiRegionParameterGroupName string
    The name of the parameter group associated with the multi region cluster.
    numShards number
    The number of shards the multi region cluster will contain.
    tags Tag[]
    An array of key-value pairs to apply to this multi region cluster.
    tlsEnabled boolean

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    updateStrategy MultiRegionClusterUpdateStrategy
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
    node_type str
    The compute and memory capacity of the nodes in the multi region cluster.
    description str
    Description of the multi region cluster.
    engine str
    The engine type used by the multi region cluster.
    engine_version str
    The Redis engine version used by the multi region cluster.
    multi_region_cluster_name_suffix str
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    multi_region_parameter_group_name str
    The name of the parameter group associated with the multi region cluster.
    num_shards int
    The number of shards the multi region cluster will contain.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this multi region cluster.
    tls_enabled bool

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    update_strategy MultiRegionClusterUpdateStrategy
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
    nodeType String
    The compute and memory capacity of the nodes in the multi region cluster.
    description String
    Description of the multi region cluster.
    engine String
    The engine type used by the multi region cluster.
    engineVersion String
    The Redis engine version used by the multi region cluster.
    multiRegionClusterNameSuffix String
    The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
    multiRegionParameterGroupName String
    The name of the parameter group associated with the multi region cluster.
    numShards Number
    The number of shards the multi region cluster will contain.
    tags List<Property Map>
    An array of key-value pairs to apply to this multi region cluster.
    tlsEnabled Boolean

    A flag that enables in-transit encryption when set to true.

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    updateStrategy "COORDINATED" | "UNCOORDINATED"
    An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MultiRegionCluster resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the multi region cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    MultiRegionClusterName string
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    Status string
    The status of the multi region cluster. For example, Available, Updating, Creating.
    Arn string
    The Amazon Resource Name (ARN) of the multi region cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    MultiRegionClusterName string
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    Status string
    The status of the multi region cluster. For example, Available, Updating, Creating.
    arn String
    The Amazon Resource Name (ARN) of the multi region cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    multiRegionClusterName String
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    status String
    The status of the multi region cluster. For example, Available, Updating, Creating.
    arn string
    The Amazon Resource Name (ARN) of the multi region cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    multiRegionClusterName string
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    status string
    The status of the multi region cluster. For example, Available, Updating, Creating.
    arn str
    The Amazon Resource Name (ARN) of the multi region cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    multi_region_cluster_name str
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    status str
    The status of the multi region cluster. For example, Available, Updating, Creating.
    arn String
    The Amazon Resource Name (ARN) of the multi region cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    multiRegionClusterName String
    The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
    status String
    The status of the multi region cluster. For example, Available, Updating, Creating.

    Supporting Types

    MultiRegionClusterUpdateStrategy, MultiRegionClusterUpdateStrategyArgs

    Coordinated
    COORDINATED
    Uncoordinated
    UNCOORDINATED
    MultiRegionClusterUpdateStrategyCoordinated
    COORDINATED
    MultiRegionClusterUpdateStrategyUncoordinated
    UNCOORDINATED
    Coordinated
    COORDINATED
    Uncoordinated
    UNCOORDINATED
    Coordinated
    COORDINATED
    Uncoordinated
    UNCOORDINATED
    COORDINATED
    COORDINATED
    UNCOORDINATED
    UNCOORDINATED
    "COORDINATED"
    COORDINATED
    "UNCOORDINATED"
    UNCOORDINATED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native