ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<int?>? allocatedStorage, Input<bool?>? allowMajorVersionUpgrade, Input<bool?>? applyImmediately, Input<String?>? arn, Input<bool?>? autoMinorVersionUpgrade, Input<List<String>?>? availabilityZones, Input<int?>? backtrackWindow, Input<int?>? backupRetentionPeriod, Input<String?>? caCertificateIdentifier, Input<String?>? caCertificateValidTill, Input<String?>? clusterIdentifier, Input<String?>? clusterIdentifierPrefix, Input<List<String>?>? clusterMembers, Input<String?>? clusterResourceId, Input<String?>? clusterScalabilityType, Input<bool?>? copyTagsToSnapshot, Input<String?>? databaseInsightsMode, Input<String?>? databaseName, Input<String?>? dbClusterInstanceClass, Input<String?>? dbClusterParameterGroupName, Input<String?>? dbInstanceParameterGroupName, Input<String?>? dbSubnetGroupName, Input<String?>? dbSystemId, Input<bool?>? deleteAutomatedBackups, Input<bool?>? deletionProtection, Input<String?>? domain, Input<String?>? domainIamRoleName, Input<bool?>? enableGlobalWriteForwarding, Input<bool?>? enableHttpEndpoint, Input<bool?>? enableLocalWriteForwarding, Input<List<String>?>? enabledCloudwatchLogsExports, Input<String?>? endpoint, Input? engine, Input<String?>? engineLifecycleSupport, Input? engineMode, Input<String?>? engineVersion, Input<String?>? engineVersionActual, Input<String?>? finalSnapshotIdentifier, Input<String?>? globalClusterIdentifier, Input<String?>? hostedZoneId, Input<bool?>? iamDatabaseAuthenticationEnabled, Input<List<String>?>? iamRoles, Input<int?>? iops, Input<String?>? kmsKeyId, Input<bool?>? manageMasterUserPassword, Input<String?>? masterPassword, Input<String?>? masterPasswordWo, Input<int?>? masterPasswordWoVersion, Input<String?>? masterUserSecretKmsKeyId, Input<List<ClusterMasterUserSecret>?>? masterUserSecrets, Input<String?>? masterUsername, Input<int?>? monitoringInterval, Input<String?>? monitoringRoleArn, Input<String?>? networkType, Input<bool?>? performanceInsightsEnabled, Input<String?>? performanceInsightsKmsKeyId, Input<int?>? performanceInsightsRetentionPeriod, Input<int?>? port, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<String?>? readerEndpoint, Input<String?>? region, Input<String?>? replicationSourceIdentifier, Input<ClusterRestoreToPointInTime?>? restoreToPointInTime, Input<ClusterS3Import?>? s3Import, Input<ClusterScalingConfiguration?>? scalingConfiguration, Input<ClusterServerlessv2ScalingConfiguration?>? serverlessv2ScalingConfiguration, Input<bool?>? skipFinalSnapshot, Input<String?>? snapshotIdentifier, Input<String?>? sourceRegion, Input<bool?>? storageEncrypted, Input<String?>? storageType, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? upgradeRolloutOrder, Input<List<String>?>? vpcSecurityGroupIds})
Creates a new ClusterState. allocatedStorage The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. allowMajorVersionUpgrade Enable to allow major engine version upgrades when changing engine versions. Defaults to false. applyImmediately Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information. arn ARN of cluster autoMinorVersionUpgrade Whether to apply minor engine upgrades automatically to the DB cluster during the maintenance window. Defaults to true. availabilityZones List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. backtrackWindow Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours) backupRetentionPeriod Days to retain backups for. Default 1 caCertificateIdentifier The CA certificate identifier to use for the DB cluster's server certificate. caCertificateValidTill Expiration date of the DB instance’s server certificate clusterIdentifier The cluster identifier. If omitted, this provider will assign a random, unique identifier. clusterIdentifierPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier. clusterMembers List of RDS Instances that are a part of this cluster clusterResourceId RDS Cluster Resource ID clusterScalabilityType Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation. Valid values: limitless, standard. copyTagsToSnapshot Copy all Cluster tags to snapshots. Default is false. databaseInsightsMode The mode of Database Insights to enable for the DB cluster. Valid values: standard, advanced. databaseName Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints dbClusterInstanceClass The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide. dbClusterParameterGroupName A cluster parameter group to associate with the cluster. dbInstanceParameterGroupName Instance parameter group to associate with all instances of the DB cluster. The dbInstanceParameterGroupName parameter is only valid in combination with the allowMajorVersionUpgrade parameter. dbSubnetGroupName DB subnet group to associate with this DB cluster. dbSystemId For use with RDS Custom. deleteAutomatedBackups Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true. deletionProtection If the DB cluster should have deletion protection enabled. domain The ID of the Directory Service Active Directory domain to create the cluster in. domainIamRoleName The name of the IAM role to be used when making API calls to the Directory Service. enableGlobalWriteForwarding Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information. enableHttpEndpoint Enable HTTP endpoint (data API). Only valid for some combinations of engineMode, engine and engineVersion and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshotIdentifier, replicationSourceIdentifier, s3Import. enableLocalWriteForwarding Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher. enabledCloudwatchLogsExports Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, iam-db-auth-error, instance, postgresql (PostgreSQL), slowquery. endpoint DNS address of the RDS instance engine Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters). engineLifecycleSupport The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. 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 engineMode Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. Specify an empty value ("") for no engine mode. See the RDS User Guide for limitations when using serverless. engineVersion Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engineVersionActual, see Attribute Reference below. engineVersionActual Running version of the database. finalSnapshotIdentifier Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made. globalClusterIdentifier Global cluster identifier specified on aws.rds.GlobalCluster. hostedZoneId Route53 Hosted Zone ID of the endpoint iamDatabaseAuthenticationEnabled Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations. iamRoles List of ARNs for the IAM roles to associate to the RDS Cluster. iops Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster. kmsKeyId ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true. manageMasterUserPassword Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if masterPassword is provided. masterPassword Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manageMasterUserPassword is set to true. masterPasswordWo NOTE: This field is write-only and its value will not be updated in state as part of read operations. masterPasswordWoVersion Used together with masterPasswordWo to trigger an update. Increment this value when an update to the masterPasswordWo is required. masterUserSecretKmsKeyId Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used. masterUserSecrets Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below. masterUsername Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot. monitoringInterval Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. monitoringRoleArn ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Clusters. networkType Network type of the cluster. Valid values: IPV4, DUAL. performanceInsightsEnabled Enables Performance Insights. performanceInsightsKmsKeyId Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds). performanceInsightsRetentionPeriod Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods. port Port on which the DB accepts connections. preferredBackupWindow Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00. preferredMaintenanceWindow Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 readerEndpoint Read-only endpoint for the Aurora cluster, automatically region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicationSourceIdentifier ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. Note: Removing this attribute after creation will promote the read replica to a standalone cluster. If DB Cluster is part of a Global Cluster, use the ignoreChanges resource option to prevent Pulumi from showing differences for this argument instead of configuring this value. restoreToPointInTime Nested attribute for point in time restore. More details below. s3Import Optional. scalingConfiguration Nested attribute with scaling properties. Only valid when engineMode is set to serverless. More details below. serverlessv2ScalingConfiguration Nested attribute with scaling properties for ServerlessV2. Only valid when engineMode is set to provisioned. More details below. skipFinalSnapshot Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false. snapshotIdentifier Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with globalClusterIdentifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot. sourceRegion The source region for an encrypted replica DB cluster. storageEncrypted Specifies whether the DB cluster is encrypted. The default is false for provisioned engineMode and true for serverless engineMode. When restoring an unencrypted snapshotIdentifier, the kmsKeyId argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided. storageType (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storageType modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2, gp3 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters). 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. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. upgradeRolloutOrder Order in which the clusters are upgraded (first, second, last). See the AWS documentation for details. vpcSecurityGroupIds List of VPC security groups to associate with the Cluster
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

allocatedStorage → Input<int?>?
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
final
allowMajorVersionUpgrade → Input<bool?>?
Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
final
applyImmediately → Input<bool?>?
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
final
arn → Input<String?>?
ARN of cluster
final
autoMinorVersionUpgrade → Input<bool?>?
Whether to apply minor engine upgrades automatically to the DB cluster during the maintenance window. Defaults to true.
final
availabilityZones → Input<List<String>?>?
List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignoreChanges argument if necessary. A maximum of 3 AZs can be configured. Note: Multi-AZ DB clusters require exactly 3 Availability Zones in the DB subnet group. Aurora DB clusters can operate with fewer AZs, but RDS will still automatically assign 3 AZs as described above.
final
backtrackWindow → Input<int?>?
Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
final
backupRetentionPeriod → Input<int?>?
Days to retain backups for. Default 1
final
caCertificateIdentifier → Input<String?>?
The CA certificate identifier to use for the DB cluster's server certificate.
final
caCertificateValidTill → Input<String?>?
Expiration date of the DB instance’s server certificate
final
clusterIdentifier → Input<String?>?
The cluster identifier. If omitted, this provider will assign a random, unique identifier.
final
clusterIdentifierPrefix → Input<String?>?
Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier.
final
clusterMembers → Input<List<String>?>?
List of RDS Instances that are a part of this cluster
final
clusterResourceId → Input<String?>?
RDS Cluster Resource ID
final
clusterScalabilityType → Input<String?>?
Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation. Valid values: limitless, standard.
final
copyTagsToSnapshot → Input<bool?>?
Copy all Cluster tags to snapshots. Default is false.
final
databaseInsightsMode → Input<String?>?
The mode of Database Insights to enable for the DB cluster. Valid values: standard, advanced.
final
databaseName → Input<String?>?
Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
final
dbClusterInstanceClass → Input<String?>?
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
final
dbClusterParameterGroupName → Input<String?>?
A cluster parameter group to associate with the cluster.
final
dbInstanceParameterGroupName → Input<String?>?
Instance parameter group to associate with all instances of the DB cluster. The dbInstanceParameterGroupName parameter is only valid in combination with the allowMajorVersionUpgrade parameter.
final
dbSubnetGroupName → Input<String?>?
DB subnet group to associate with this DB cluster. NOTE: This must match the dbSubnetGroupName specified on every aws.rds.ClusterInstance in the cluster.
final
dbSystemId → Input<String?>?
For use with RDS Custom.
final
deleteAutomatedBackups → Input<bool?>?
Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
final
deletionProtection → Input<bool?>?
If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
final
domain → Input<String?>?
The ID of the Directory Service Active Directory domain to create the cluster in.
final
domainIamRoleName → Input<String?>?
The name of the IAM role to be used when making API calls to the Directory Service.
final
enabledCloudwatchLogsExports → Input<List<String>?>?
Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, iam-db-auth-error, instance, postgresql (PostgreSQL), slowquery.
final
enableGlobalWriteForwarding → Input<bool?>?
Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
final
enableHttpEndpoint → Input<bool?>?
Enable HTTP endpoint (data API). Only valid for some combinations of engineMode, engine and engineVersion and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshotIdentifier, replicationSourceIdentifier, s3Import.
final
enableLocalWriteForwarding → Input<bool?>?
Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
final
endpoint → Input<String?>?
DNS address of the RDS instance
final
engine → Input?
Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
final
engineLifecycleSupport → Input<String?>?
The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. 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
engineMode → Input?
Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. Specify an empty value ("") for no engine mode. See the RDS User Guide for limitations when using serverless.
final
engineVersion → Input<String?>?
Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engineVersionActual, see Attribute Reference below.
final
engineVersionActual → Input<String?>?
Running version of the database.
final
finalSnapshotIdentifier → Input<String?>?
Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
final
globalClusterIdentifier → Input<String?>?
Global cluster identifier specified on aws.rds.GlobalCluster.
final
hashCode → int
The hash code for this object.
no setterinherited
hostedZoneId → Input<String?>?
Route53 Hosted Zone ID of the endpoint
final
iamDatabaseAuthenticationEnabled → Input<bool?>?
Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
final
iamRoles → Input<List<String>?>?
List of ARNs for the IAM roles to associate to the RDS Cluster.
final
iops → Input<int?>?
Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
final
kmsKeyId → Input<String?>?
ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.
final
manageMasterUserPassword → Input<bool?>?
Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if masterPassword is provided.
final
masterPassword → Input<String?>?
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manageMasterUserPassword is set to true.
final
masterPasswordWo → Input<String?>?
NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the master DB user. Note that this may show up in logs. Please refer to the RDS Naming Constraints. Cannot be set if manageMasterUserPassword is set to true.
final
masterPasswordWoVersion → Input<int?>?
Used together with masterPasswordWo to trigger an update. Increment this value when an update to the masterPasswordWo is required.
final
masterUsername → Input<String?>?
Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
final
masterUserSecretKmsKeyId → Input<String?>?
Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
final
masterUserSecrets → Input<List<ClusterMasterUserSecret>?>?
Block that specifies the master user secret. Only available when manageMasterUserPassword is set to true. Documented below.
final
monitoringInterval → Input<int?>?
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
final
monitoringRoleArn → Input<String?>?
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Clusters.
final
networkType → Input<String?>?
Network type of the cluster. Valid values: IPV4, DUAL.
final
performanceInsightsEnabled → Input<bool?>?
Enables Performance Insights.
final
performanceInsightsKmsKeyId → Input<String?>?
Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
final
performanceInsightsRetentionPeriod → Input<int?>?
Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
final
port → Input<int?>?
Port on which the DB accepts connections.
final
preferredBackupWindow → Input<String?>?
Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
final
preferredMaintenanceWindow → Input<String?>?
Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
final
readerEndpoint → Input<String?>?
Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicationSourceIdentifier → Input<String?>?
ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. Note: Removing this attribute after creation will promote the read replica to a standalone cluster. If DB Cluster is part of a Global Cluster, use the ignoreChanges resource option to prevent Pulumi from showing differences for this argument instead of configuring this value.
final
restoreToPointInTime → Input<ClusterRestoreToPointInTime?>?
Nested attribute for point in time restore. More details below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3Import → Input<ClusterS3Import?>?
final
scalingConfiguration → Input<ClusterScalingConfiguration?>?
Nested attribute with scaling properties. Only valid when engineMode is set to serverless. More details below.
final
serverlessv2ScalingConfiguration → Input<ClusterServerlessv2ScalingConfiguration?>?
Nested attribute with scaling properties for ServerlessV2. Only valid when engineMode is set to provisioned. More details below.
final
skipFinalSnapshot → Input<bool?>?
Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.
final
snapshotIdentifier → Input<String?>?
Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with globalClusterIdentifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
final
sourceRegion → Input<String?>?
The source region for an encrypted replica DB cluster.
final
storageEncrypted → Input<bool?>?
Specifies whether the DB cluster is encrypted. The default is false for provisioned engineMode and true for serverless engineMode. When restoring an unencrypted snapshotIdentifier, the kmsKeyId argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
final
storageType → Input<String?>?
(Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storageType modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2, gp3 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
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
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
upgradeRolloutOrder → Input<String?>?
Order in which the clusters are upgraded (first, second, last). See the AWS documentation for details.
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security groups to associate with the Cluster
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