@pulumi/aws-native/memorydb/multiRegionCluster.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * The AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.
 */
export declare class MultiRegionCluster extends pulumi.CustomResource {
    /**
     * Get an existing MultiRegionCluster 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): MultiRegionCluster;
    /**
     * Returns true if the given object is an instance of MultiRegionCluster.  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 MultiRegionCluster;
    /**
     * The Amazon Resource Name (ARN) of the multi region cluster.
     */
    readonly arn: pulumi.Output<string>;
    /**
     * Description of the multi region cluster.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The engine type used by the multi region cluster.
     */
    readonly engine: pulumi.Output<string | undefined>;
    /**
     * The Redis engine version used by the multi region cluster.
     */
    readonly engineVersion: pulumi.Output<string | undefined>;
    /**
     * The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
     */
    readonly multiRegionClusterName: pulumi.Output<string>;
    /**
     * The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
     */
    readonly multiRegionClusterNameSuffix: pulumi.Output<string | undefined>;
    /**
     * The name of the parameter group associated with the multi region cluster.
     */
    readonly multiRegionParameterGroupName: pulumi.Output<string | undefined>;
    /**
     * The compute and memory capacity of the nodes in the multi region cluster.
     */
    readonly nodeType: pulumi.Output<string>;
    /**
     * The number of shards the multi region cluster will contain.
     */
    readonly numShards: pulumi.Output<number | undefined>;
    /**
     * The status of the multi region cluster. For example, Available, Updating, Creating.
     */
    readonly status: pulumi.Output<string>;
    /**
     * An array of key-value pairs to apply to this multi region cluster.
     */
    readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
    /**
     * 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.
     */
    readonly tlsEnabled: pulumi.Output<boolean | undefined>;
    /**
     * An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
     */
    readonly updateStrategy: pulumi.Output<enums.memorydb.MultiRegionClusterUpdateStrategy | undefined>;
    /**
     * Create a MultiRegionCluster 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: MultiRegionClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a MultiRegionCluster resource.
 */
export interface MultiRegionClusterArgs {
    /**
     * Description of the multi region cluster.
     */
    description?: pulumi.Input<string>;
    /**
     * The engine type used by the multi region cluster.
     */
    engine?: pulumi.Input<string>;
    /**
     * The Redis engine version used by the multi region cluster.
     */
    engineVersion?: pulumi.Input<string>;
    /**
     * The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
     */
    multiRegionClusterNameSuffix?: pulumi.Input<string>;
    /**
     * The name of the parameter group associated with the multi region cluster.
     */
    multiRegionParameterGroupName?: pulumi.Input<string>;
    /**
     * The compute and memory capacity of the nodes in the multi region cluster.
     */
    nodeType: pulumi.Input<string>;
    /**
     * The number of shards the multi region cluster will contain.
     */
    numShards?: pulumi.Input<number>;
    /**
     * An array of key-value pairs to apply to this multi region cluster.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
    /**
     * 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.
     */
    tlsEnabled?: pulumi.Input<boolean>;
    /**
     * An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
     */
    updateStrategy?: pulumi.Input<enums.memorydb.MultiRegionClusterUpdateStrategy>;
}