GlobalClusterState class
Input properties used for looking up and filtering GlobalCluster resources.
Constructors
-
GlobalClusterState({Input<
String?> ? arn, Input<String?> ? databaseName, Input<bool?> ? deletionProtection, Input<String?> ? endpoint, Input<String?> ? engine, Input<String?> ? engineLifecycleSupport, Input<String?> ? engineVersion, Input<String?> ? engineVersionActual, Input<bool?> ? forceDestroy, Input<String?> ? globalClusterIdentifier, Input<List< ? globalClusterMembers, Input<GlobalClusterGlobalClusterMember> ?>String?> ? globalClusterResourceId, Input<String?> ? region, Input<String?> ? sourceDbClusterIdentifier, Input<bool?> ? storageEncrypted, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll})String, String> ?> -
Creates a new GlobalClusterState.
arnRDS Global Cluster ARN.databaseNameName for an automatically created database on cluster creation. Pulumi will only perform drift detection if a configuration value is provided.deletionProtectionIf the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set totrue. The default isfalse.endpointWriter endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.engineName 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 toaurora. Conflicts withsourceDbClusterIdentifier.engineLifecycleSupportThe life cycle type for this DB instance. This setting applies only to Aurora PostgreSQL-based global databases. Valid values areopen-source-rds-extended-support,open-source-rds-extended-support-disabled. Default value isopen-source-rds-extended-support.Using Amazon RDS Extended Support: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.htmlengineVersionEngine version of the Aurora global database. Theengine,engineVersion, andinstanceClass(on theaws.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 aninconsistent final planerror while upgrading, use thelifecycleignoreChangesforengineVersionmeta argument on the associatedaws.rds.Clusterresource as shown above in Upgrading Engine Versions example.engineVersionActualOptional.forceDestroyEnable to remove DB Cluster members from Global Cluster on destroy. Required withsourceDbClusterIdentifier.globalClusterIdentifierGlobal cluster identifier.globalClusterMembersSet of objects containing Global Cluster members.globalClusterResourceIdAWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sourceDbClusterIdentifierARN 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 withengineandengineVersion. This allows upgrading the engine version of the Global Cluster.storageEncryptedSpecifies whether the DB cluster is encrypted. The default isfalseunlesssourceDbClusterIdentifieris specified and encrypted. The provider will only perform drift detection if a configuration value is provided.tagsA map of tags to assign to the DB cluster. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.const -
GlobalClusterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
RDS Global Cluster ARN.
final
-
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 isfalse.final -
endpoint
→ Input<
String?> ? -
Writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
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 toaurora. Conflicts withsourceDbClusterIdentifier.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 isopen-source-rds-extended-support.Using Amazon RDS Extended Support: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.htmlfinal -
engineVersion
→ Input<
String?> ? -
Engine version of the Aurora global database. The
engine,engineVersion, andinstanceClass(on theaws.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 aninconsistent final planerror while upgrading, use thelifecycleignoreChangesforengineVersionmeta argument on the associatedaws.rds.Clusterresource as shown above in Upgrading Engine Versions example.final -
engineVersionActual
→ Input<
String?> ? -
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
-
globalClusterMembers
→ Input<
List< ?GlobalClusterGlobalClusterMember> ?> -
Set of objects containing Global Cluster members.
final
-
globalClusterResourceId
→ Input<
String?> ? -
AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
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
engineandengineVersion. This allows upgrading the engine version of the Global Cluster.final -
storageEncrypted
→ Input<
bool?> ? -
Specifies whether the DB cluster is encrypted. The default is
falseunlesssourceDbClusterIdentifieris specified and encrypted. The provider will only perform drift detection if a configuration value is provided.final -
A map of tags to assign to the DB cluster. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.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