We recommend new projects start with resources from the AWS provider.
aws-native.rds.GlobalCluster
We recommend new projects start with resources from the AWS provider.
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,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.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.
- EngineLifecycle stringSupport 
- The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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.
- GlobalCluster stringIdentifier 
- The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- SourceDb 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.
- 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.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- An array of key-value pairs to apply to this resource.
- DeletionProtection bool
- The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- Engine
GlobalCluster 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.
- EngineLifecycle stringSupport 
- The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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.
- GlobalCluster stringIdentifier 
- The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- SourceDb 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.
- 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.
- 
TagArgs 
- An array of key-value pairs to apply to this resource.
- deletionProtection Boolean
- The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- engine
GlobalCluster 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.
- engineLifecycle StringSupport 
- The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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.
- globalCluster StringIdentifier 
- The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- sourceDb 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.
- 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.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- deletionProtection boolean
- The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
- engine
GlobalCluster 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.
- engineLifecycle stringSupport 
- The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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.
- globalCluster stringIdentifier 
- The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- sourceDb 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.
- 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.
- Tag[]
- An array of key-value pairs to apply to this resource.
- 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
GlobalCluster 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.
- 
Sequence[TagArgs] 
- An array of key-value pairs to apply to this resource.
- 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.
- engineLifecycle StringSupport 
- The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
- 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.
- globalCluster StringIdentifier 
- The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
- sourceDb 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.
- 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.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlobalCluster resource produces the following output properties:
- GlobalEndpoint Pulumi.Aws Native. Rds. Outputs. Global Cluster Global Endpoint 
- Id string
- The provider-assigned unique ID for this managed resource.
- GlobalEndpoint GlobalCluster Global Endpoint 
- Id string
- The provider-assigned unique ID for this managed resource.
- globalEndpoint GlobalCluster Global Endpoint 
- id String
- The provider-assigned unique ID for this managed resource.
- globalEndpoint GlobalCluster Global Endpoint 
- id string
- The provider-assigned unique ID for this managed resource.
- global_endpoint GlobalCluster Global Endpoint 
- id str
- The provider-assigned unique ID for this managed resource.
- globalEndpoint Property Map
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
GlobalClusterEngine, GlobalClusterEngineArgs      
- Aurora
- aurora
- AuroraMysql 
- aurora-mysql
- AuroraPostgresql 
- aurora-postgresql
- GlobalCluster Engine Aurora 
- aurora
- GlobalCluster Engine Aurora Mysql 
- aurora-mysql
- GlobalCluster Engine Aurora Postgresql 
- 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
GlobalClusterGlobalEndpoint, GlobalClusterGlobalEndpointArgs        
- Address string
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- Address string
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- address String
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- address string
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- address str
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
- address String
- The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
Tag, TagArgs  
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
