@pulumi/aws-native/docdb/globalCluster.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::DocDB::GlobalCluster resource represents an Amazon DocumentDB Global Cluster.
 */
export declare class GlobalCluster extends pulumi.CustomResource {
    /**
     * Get an existing GlobalCluster 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): GlobalCluster;
    /**
     * Returns true if the given object is an instance of GlobalCluster.  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 GlobalCluster;
    /**
     * Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
     */
    readonly deletionProtection: pulumi.Output<boolean | undefined>;
    /**
     * The database engine to use for this global cluster.
     */
    readonly engine: pulumi.Output<enums.docdb.GlobalClusterEngine | undefined>;
    /**
     * The engine version to use for this global cluster.
     */
    readonly engineVersion: pulumi.Output<string | undefined>;
    /**
     * The Amazon Resource Name (ARN) for the global cluster.
     */
    readonly globalClusterArn: pulumi.Output<string>;
    /**
     * The cluster identifier of the global cluster.
     */
    readonly globalClusterIdentifier: pulumi.Output<string>;
    /**
     * The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
     */
    readonly globalClusterResourceId: pulumi.Output<string>;
    /**
     * The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
     */
    readonly sourceDbClusterIdentifier: pulumi.Output<string | undefined>;
    /**
     * Indicates whether the global cluster has storage encryption enabled.
     */
    readonly storageEncrypted: pulumi.Output<boolean | undefined>;
    /**
     * The tags to be assigned to the Amazon DocumentDB resource.
     */
    readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
    /**
     * Create a GlobalCluster 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: GlobalClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a GlobalCluster resource.
 */
export interface GlobalClusterArgs {
    /**
     * Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
     */
    deletionProtection?: pulumi.Input<boolean>;
    /**
     * The database engine to use for this global cluster.
     */
    engine?: pulumi.Input<enums.docdb.GlobalClusterEngine>;
    /**
     * The engine version to use for this global cluster.
     */
    engineVersion?: pulumi.Input<string>;
    /**
     * The cluster identifier of the global cluster.
     */
    globalClusterIdentifier: pulumi.Input<string>;
    /**
     * The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
     */
    sourceDbClusterIdentifier?: pulumi.Input<string>;
    /**
     * Indicates whether the global cluster has storage encryption enabled.
     */
    storageEncrypted?: pulumi.Input<boolean>;
    /**
     * The tags to be assigned to the Amazon DocumentDB resource.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}