AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws-native.rds.GlobalCluster
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
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_lifecycle_support: Optional[str] = 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.
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:
- 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
Pulumi.
Aws Native. Rds. Global Cluster Engine - 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
Lifecycle stringSupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- Engine
Version 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.
- Global
Cluster stringIdentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- Source
Db stringCluster Identifier - 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.
- 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
Global
Cluster Engine - 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
Lifecycle stringSupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- Engine
Version 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.
- Global
Cluster stringIdentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- Source
Db stringCluster Identifier - 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.
- deletion
Protection Boolean - The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- engine
Global
Cluster Engine - 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
Lifecycle StringSupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- engine
Version 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.
- global
Cluster StringIdentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- source
Db StringCluster Identifier - 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 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 boolean - The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- engine
Global
Cluster Engine - 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
Lifecycle stringSupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- engine
Version 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.
- global
Cluster stringIdentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- source
Db stringCluster Identifier - 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 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
Global
Cluster Engine - 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_
lifecycle_ strsupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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_ stridentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- source_
db_ strcluster_ identifier - 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.
- deletion
Protection 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.
- engine
Lifecycle StringSupport - The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- engine
Version 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.
- global
Cluster StringIdentifier - The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- source
Db StringCluster Identifier - 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 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
- Aurora
Mysql - aurora-mysql
- Aurora
Postgresql - aurora-postgresql
- Global
Cluster Engine Aurora - aurora
- Global
Cluster Engine Aurora Mysql - aurora-mysql
- Global
Cluster Engine Aurora Postgresql - aurora-postgresql
- Aurora
- aurora
- Aurora
Mysql - aurora-mysql
- Aurora
Postgresql - aurora-postgresql
- Aurora
- aurora
- Aurora
Mysql - aurora-mysql
- Aurora
Postgresql - 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 is in preview. AWS Classic is fully supported.
AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi