@pulumi/aws/rds/getGlobalCluster.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Data source for managing an AWS RDS (Relational Database) Global Cluster.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.rds.getGlobalCluster({
 *     identifier: test.globalClusterIdentifier,
 * });
 * ```
 */
export declare function getGlobalCluster(args: GetGlobalClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetGlobalClusterResult>;
/**
 * A collection of arguments for invoking getGlobalCluster.
 */
export interface GetGlobalClusterArgs {
    /**
     * The global cluster identifier of the RDS global cluster.
     *
     * The following arguments are optional:
     */
    identifier: string;
    /**
     * 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.
     */
    region?: string;
}
/**
 * A collection of values returned by getGlobalCluster.
 */
export interface GetGlobalClusterResult {
    /**
     * RDS Global Cluster Amazon Resource Name (ARN)
     */
    readonly arn: string;
    /**
     * Name of the automatically created database on cluster creation.
     */
    readonly databaseName: string;
    /**
     * If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`.
     */
    readonly deletionProtection: boolean;
    /**
     * The endpoint for the Global Cluster.
     */
    readonly endpoint: string;
    /**
     * Name of the database engine.
     */
    readonly engine: string;
    /**
     * The current lifecycle support status of the database engine for this Global Cluster.
     */
    readonly engineLifecycleSupport: string;
    /**
     * Version of the database engine for this Global Cluster.
     */
    readonly engineVersion: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly identifier: string;
    /**
     * Set of objects containing Global Cluster members.
     */
    readonly members: outputs.rds.GetGlobalClusterMember[];
    readonly region: string;
    /**
     * AWS Region-unique, immutable identifier for the global database cluster.
     */
    readonly resourceId: string;
    /**
     * Whether the DB cluster is encrypted.
     */
    readonly storageEncrypted: boolean;
    /**
     * A map of tags to assigned to the Global Cluster.
     */
    readonly tags: {
        [key: string]: string;
    };
}
/**
 * Data source for managing an AWS RDS (Relational Database) Global Cluster.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.rds.getGlobalCluster({
 *     identifier: test.globalClusterIdentifier,
 * });
 * ```
 */
export declare function getGlobalClusterOutput(args: GetGlobalClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGlobalClusterResult>;
/**
 * A collection of arguments for invoking getGlobalCluster.
 */
export interface GetGlobalClusterOutputArgs {
    /**
     * The global cluster identifier of the RDS global cluster.
     *
     * The following arguments are optional:
     */
    identifier: pulumi.Input<string>;
    /**
     * 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.
     */
    region?: pulumi.Input<string>;
}