@pulumi/aws-native
Version:
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)
106 lines (105 loc) • 5.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::RDS::GlobalCluster
*/
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;
/**
* The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
*/
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).
* If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
readonly engine: pulumi.Output<enums.rds.GlobalClusterEngine | undefined>;
/**
* The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
*/
readonly engineLifecycleSupport: pulumi.Output<string | undefined>;
/**
* The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
readonly engineVersion: pulumi.Output<string | undefined>;
/**
* The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
*/
readonly globalClusterIdentifier: pulumi.Output<string | undefined>;
readonly globalEndpoint: pulumi.Output<outputs.rds.GlobalClusterGlobalEndpoint>;
/**
* The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
*/
readonly sourceDbClusterIdentifier: pulumi.Output<string | undefined>;
/**
* The storage encryption setting for the new global database cluster.
* If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
readonly storageEncrypted: pulumi.Output<boolean | undefined>;
/**
* An array of key-value pairs to apply to this 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 {
/**
* The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).
* If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
engine?: pulumi.Input<enums.rds.GlobalClusterEngine>;
/**
* The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
*/
engineLifecycleSupport?: pulumi.Input<string>;
/**
* The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
engineVersion?: pulumi.Input<string>;
/**
* The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
*/
globalClusterIdentifier?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
*/
sourceDbClusterIdentifier?: pulumi.Input<string>;
/**
* The storage encryption setting for the new global database cluster.
* If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
*/
storageEncrypted?: pulumi.Input<boolean>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}