GlobalClusterArgs class

The set of arguments for GlobalCluster. The set of arguments for GlobalCluster.

Constructors

GlobalClusterArgs({Input<String?>? databaseName, Input<bool?>? deletionProtection, Input<String?>? engine, Input<String?>? engineLifecycleSupport, Input<String?>? engineVersion, Input<bool?>? forceDestroy, required Input<String> globalClusterIdentifier, Input<String?>? region, Input<String?>? sourceDbClusterIdentifier, Input<bool?>? storageEncrypted, Input<Map<String, String>?>? tags})
Creates a new GlobalClusterArgs. databaseName Name for an automatically created database on cluster creation. Pulumi will only perform drift detection if a configuration value is provided. deletionProtection If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. engine Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora. Conflicts with sourceDbClusterIdentifier. engineLifecycleSupport The life cycle type for this DB instance. This setting applies only to Aurora PostgreSQL-based global databases. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. Using Amazon RDS Extended Support: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html engineVersion Engine version of the Aurora global database. The engine, engineVersion, and instanceClass (on the aws.rds.ClusterInstance) must together support global databases. See Using Amazon Aurora global databases for more information. By upgrading the engine version, the provider will upgrade cluster members. NOTE: To avoid an inconsistent final plan error while upgrading, use the lifecycle ignoreChanges for engineVersion meta argument on the associated aws.rds.Cluster resource as shown above in Upgrading Engine Versions example. forceDestroy Enable to remove DB Cluster members from Global Cluster on destroy. Required with sourceDbClusterIdentifier. globalClusterIdentifier Global cluster identifier. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. sourceDbClusterIdentifier ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value. NOTE: After initial creation, this argument can be removed and replaced with engine and engineVersion. This allows upgrading the engine version of the Global Cluster. storageEncrypted Specifies whether the DB cluster is encrypted. The default is false unless sourceDbClusterIdentifier is specified and encrypted. The provider will only perform drift detection if a configuration value is provided. tags A map of tags to assign to the DB cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
GlobalClusterArgs.fromMap(Map<String, dynamic> map)
factory

Properties

databaseName → Input<String?>?
Name for an automatically created database on cluster creation. Pulumi will only perform drift detection if a configuration value is provided.
final
deletionProtection → Input<bool?>?
If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
final
engine → Input<String?>?
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora. Conflicts with sourceDbClusterIdentifier.
final
engineLifecycleSupport → Input<String?>?
The life cycle type for this DB instance. This setting applies only to Aurora PostgreSQL-based global databases. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. Using Amazon RDS Extended Support: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
final
engineVersion → Input<String?>?
Engine version of the Aurora global database. The engine, engineVersion, and instanceClass (on the aws.rds.ClusterInstance) must together support global databases. See Using Amazon Aurora global databases for more information. By upgrading the engine version, the provider will upgrade cluster members. NOTE: To avoid an inconsistent final plan error while upgrading, use the lifecycle ignoreChanges for engineVersion meta argument on the associated aws.rds.Cluster resource as shown above in Upgrading Engine Versions example.
final
forceDestroy → Input<bool?>?
Enable to remove DB Cluster members from Global Cluster on destroy. Required with sourceDbClusterIdentifier.
final
globalClusterIdentifier → Input<String>
Global cluster identifier.
final
hashCode → int
The hash code for this object.
no setterinherited
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceDbClusterIdentifier → Input<String?>?
ARN to use as the primary DB Cluster of the Global Cluster on creation. Pulumi cannot perform drift detection of this value. NOTE: After initial creation, this argument can be removed and replaced with engine and engineVersion. This allows upgrading the engine version of the Global Cluster.
final
storageEncrypted → Input<bool?>?
Specifies whether the DB cluster is encrypted. The default is false unless sourceDbClusterIdentifier is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the DB cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited