Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. GlobalCluster

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.GlobalCluster

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::RDS::GlobalCluster

    Create GlobalCluster Resource

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

    Constructor syntax

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

@overload
def GlobalCluster(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  deletion_protection: Optional[bool] = None,
                  engine: Optional[GlobalClusterEngine] = None,
                  engine_version: Optional[str] = None,
                  global_cluster_identifier: Optional[str] = None,
                  source_db_cluster_identifier: Optional[str] = None,
                  storage_encrypted: Optional[bool] = None)
    func NewGlobalCluster(ctx *Context, name string, args *GlobalClusterArgs, opts ...ResourceOption) (*GlobalCluster, error)
    public GlobalCluster(string name, GlobalClusterArgs? args = null, CustomResourceOptions? opts = null)
    public GlobalCluster(String name, GlobalClusterArgs args)
public GlobalCluster(String name, GlobalClusterArgs args, CustomResourceOptions options)

    type: aws-native:rds:GlobalCluster
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 GlobalClusterArgs
    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 GlobalClusterArgs
    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 GlobalClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const globalClusterResource = new aws_native.rds.GlobalCluster("globalClusterResource", {
    deletionProtection: false,
    engine: aws_native.rds.GlobalClusterEngine.Aurora,
    engineVersion: "string",
    globalClusterIdentifier: "string",
    sourceDbClusterIdentifier: "string",
    storageEncrypted: false,
});

    Coming soon!

    GlobalCluster Resource Properties

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

    Inputs

    The GlobalCluster resource accepts the following input properties:

    DeletionProtection bool
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    Engine Pulumi.AwsNative.Rds.GlobalClusterEngine
    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.
    EngineVersion 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.
    GlobalClusterIdentifier string
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    SourceDbClusterIdentifier 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.
    StorageEncrypted bool
    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.
    DeletionProtection bool
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    Engine GlobalClusterEngine
    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.
    EngineVersion 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.
    GlobalClusterIdentifier string
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    SourceDbClusterIdentifier 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.
    StorageEncrypted bool
    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.
    deletionProtection Boolean
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    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.
    engineVersion 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.
    globalClusterIdentifier String
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    sourceDbClusterIdentifier 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.
    storageEncrypted Boolean
    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.
    deletionProtection boolean
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    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.
    engineVersion 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.
    globalClusterIdentifier string
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    sourceDbClusterIdentifier 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.
    storageEncrypted boolean
    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.
    deletion_protection bool
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    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_version str
    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.
    global_cluster_identifier str
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    source_db_cluster_identifier str
    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.
    storage_encrypted bool
    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.
    deletionProtection Boolean
    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
    engine "aurora" | "aurora-mysql" | "aurora-postgresql"
    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.
    engineVersion 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.
    globalClusterIdentifier String
    The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
    sourceDbClusterIdentifier 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.
    storageEncrypted Boolean
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GlobalClusterEngine, GlobalClusterEngineArgs

    Aurora
    aurora
    AuroraMysql
    aurora-mysql
    AuroraPostgresql
    aurora-postgresql
    GlobalClusterEngineAurora
    aurora
    GlobalClusterEngineAuroraMysql
    aurora-mysql
    GlobalClusterEngineAuroraPostgresql
    aurora-postgresql
    Aurora
    aurora
    AuroraMysql
    aurora-mysql
    AuroraPostgresql
    aurora-postgresql
    Aurora
    aurora
    AuroraMysql
    aurora-mysql
    AuroraPostgresql
    aurora-postgresql
    AURORA
    aurora
    AURORA_MYSQL
    aurora-mysql
    AURORA_POSTGRESQL
    aurora-postgresql
    "aurora"
    aurora
    "aurora-mysql"
    aurora-mysql
    "aurora-postgresql"
    aurora-postgresql

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native