InstanceArgs class
The set of arguments for Instance. The set of arguments for Instance.
Constructors
-
InstanceArgs({Input<
int?> ? allocatedStorage, Input<bool?> ? allowMajorVersionUpgrade, Input<bool?> ? applyImmediately, Input<bool?> ? autoMinorVersionUpgrade, Input<String?> ? availabilityZone, Input<int?> ? backupRetentionPeriod, Input<String?> ? backupTarget, Input<String?> ? backupWindow, Input<InstanceBlueGreenUpdate?> ? blueGreenUpdate, Input<String?> ? caCertIdentifier, Input<String?> ? characterSetName, Input<bool?> ? copyTagsToSnapshot, Input<String?> ? customIamInstanceProfile, Input<bool?> ? customerOwnedIpEnabled, Input<String?> ? databaseInsightsMode, Input<String?> ? dbName, Input<String?> ? dbSubnetGroupName, Input<bool?> ? dedicatedLogVolume, Input<bool?> ? deleteAutomatedBackups, Input<bool?> ? deletionProtection, Input<String?> ? domain, Input<String?> ? domainAuthSecretArn, Input<List< ? domainDnsIps, Input<String> ?>String?> ? domainFqdn, Input<String?> ? domainIamRoleName, Input<String?> ? domainOu, Input<List< ? enabledCloudwatchLogsExports, Input<String> ?>String?> ? engine, Input<String?> ? engineLifecycleSupport, Input<String?> ? engineVersion, Input<String?> ? finalSnapshotIdentifier, Input<bool?> ? iamDatabaseAuthenticationEnabled, Input<String?> ? identifier, Input<String?> ? identifierPrefix, required Input instanceClass, Input<int?> ? iops, Input<String?> ? kmsKeyId, Input<String?> ? licenseModel, Input<String?> ? maintenanceWindow, Input<bool?> ? manageMasterUserPassword, Input<String?> ? masterUserSecretKmsKeyId, Input<int?> ? maxAllocatedStorage, Input<int?> ? monitoringInterval, Input<String?> ? monitoringRoleArn, Input<bool?> ? multiAz, Input<String?> ? ncharCharacterSetName, Input<String?> ? networkType, Input<String?> ? optionGroupName, Input<String?> ? parameterGroupName, Input<String?> ? password, Input<String?> ? passwordWo, Input<int?> ? passwordWoVersion, Input<bool?> ? performanceInsightsEnabled, Input<String?> ? performanceInsightsKmsKeyId, Input<int?> ? performanceInsightsRetentionPeriod, Input<int?> ? port, Input<bool?> ? publiclyAccessible, Input<String?> ? region, Input<String?> ? replicaMode, Input<String?> ? replicateSourceDb, Input<InstanceRestoreToPointInTime?> ? restoreToPointInTime, Input<InstanceS3Import?> ? s3Import, Input<bool?> ? skipFinalSnapshot, Input<String?> ? snapshotIdentifier, Input<bool?> ? storageEncrypted, Input<int?> ? storageThroughput, Input? storageType, Input<Map< ? tags, Input<String, String> ?>String?> ? timezone, Input<bool?> ? upgradeStorageConfig, Input<String?> ? username, Input<List< ? vpcSecurityGroupIds})String> ?> -
Creates a new InstanceArgs.
allocatedStorageThe allocated storage in gibibytes. IfmaxAllocatedStorageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. IfreplicateSourceDbis set, the value is ignored during the creation of the instance.allowMajorVersionUpgradeIndicates that major versionapplyImmediatelySpecifies whether any database modificationsautoMinorVersionUpgradeIndicates that minor engine upgradesavailabilityZoneThe AZ for the RDS instance.backupRetentionPeriodThe days to retain backups for.backupTargetSpecifies where automated backups and manual snapshots are stored. Possible values areregion(default) andoutposts. See Working with Amazon RDS on AWS Outposts for more information.backupWindowThe daily time range (in UTC) during which automated backups are created if they are enabled.blueGreenUpdateEnables low-downtime updates usingblue-green.caCertIdentifierThe identifier of the CA certificate for the DB instance.characterSetNameThe character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation).copyTagsToSnapshotCopy all Instancetagsto snapshots. Default isfalse.customIamInstanceProfileThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.customerOwnedIpEnabledIndicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.databaseInsightsModeThe mode of Database Insights that is enabled for the instance. Valid values:standard,advanced.dbNameThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.dbSubnetGroupNameName of DB subnet group.dedicatedLogVolumeUse a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.deleteAutomatedBackupsSpecifies whether to remove automated backups immediately after the DB instance is deleted. Default istrue.deletionProtectionIf the DB instance should have deletion protection enabled. The database can't be deleted when this value is set totrue. The default isfalse.domainThe ID of the Directory Service Active Directory domain to create the instance in. Conflicts withdomainFqdn,domainOu,domainAuthSecretArnand adomainDnsIps.domainAuthSecretArnThe ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts withdomainanddomainIamRoleName.domainDnsIpsThe IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts withdomainanddomainIamRoleName.domainFqdnThe fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts withdomainanddomainIamRoleName.domainIamRoleNameThe name of the IAM role to be used when making API calls to the Directory Service. Conflicts withdomainFqdn,domainOu,domainAuthSecretArnand adomainDnsIps.domainOuThe self managed Active Directory organizational unit for your DB instance to join. Conflicts withdomainanddomainIamRoleName.enabledCloudwatchLogsExportsSet of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.engineThe database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.engineLifecycleSupportThe life cycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL. 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.htmlengineVersionThe engine version to use. IfautoMinorVersionUpgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). The actual engine version used is returned in the attributeengineVersionActual, see Attribute Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.finalSnapshotIdentifierThe name of your final DB snapshotiamDatabaseAuthenticationEnabledSpecifies whether mappings of AWS Identity and Access Management (IAM) accounts to databaseidentifierThe name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required ifrestoreToPointInTimeis specified.identifierPrefixCreates a unique identifier beginning with the specified prefix. Conflicts withidentifier.instanceClassThe instance type of the RDS instance.iopsThe amount of provisioned IOPS. Setting this implies akmsKeyIdThe ARN for the KMS encryption key. If creating anlicenseModelLicense model information for this DB instance. Valid values for this field are as follows:maintenanceWindowThe window to perform maintenance in.manageMasterUserPasswordSet to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set ifpasswordorpasswordWois provided.masterUserSecretKmsKeyIdThe 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.maxAllocatedStorageSpecifies the maximum storage (in GiB) that Amazon RDS can automatically scale to for this DB instance. By default, Storage Autoscaling is disabled. To enable Storage Autoscaling, setmaxAllocatedStorageto greater than or equal toallocatedStorage. SettingmaxAllocatedStorageto 0 explicitly disables Storage Autoscaling. When configured, changes toallocatedStoragewill be automatically ignored as the storage can dynamically scale.monitoringIntervalThe interval, in seconds, between pointsmonitoringRoleArnThe ARN for the IAM role that permits RDSmultiAzSpecifies if the RDS instance is multi-AZncharCharacterSetNameThe national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See [Oracle Character SetsnetworkTypeThe network type of the DB instance. Valid values:IPV4,DUAL.optionGroupNameName of the DB option group to associate.parameterGroupNameName of the DB parameter group to associate.passwordPassword for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set ifmanageMasterUserPasswordis set totrue.passwordWoNOTE: This field is write-only and its value will not be updated in state as part of read operations.passwordWoVersionUsed together withpasswordWoto trigger an update. Increment this value when an update topasswordWois required.performanceInsightsEnabledSpecifies whether Performance Insights are enabled. Defaults to false.performanceInsightsKmsKeyIdThe ARN for the KMS key to encrypt Performance Insights data. When specifyingperformanceInsightsKmsKeyId,performanceInsightsEnabledneeds to be set to true. Once KMS key is set, it can never be changed.performanceInsightsRetentionPeriodAmount of time in days to retain Performance Insights data. Valid values are7,731(2 years) or a multiple of31. When specifyingperformanceInsightsRetentionPeriod,performanceInsightsEnabledneeds to be set to true. Defaults to '7'.portThe port on which the DB accepts connections.publiclyAccessibleBool to control if instance is publiclyregionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replicaModeSpecifies whether the replica is in eithermountedoropen-read-onlymode. This attributereplicateSourceDbSpecifies that this resource is a Replica database, and to use this value as the source database.restoreToPointInTimeA configuration block for restoring a DB instance to an arbitrary point in time.s3ImportRestore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB InstanceskipFinalSnapshotDetermines whether a final DB snapshot issnapshotIdentifierSpecifies whether or not to create this database from a snapshot.storageEncryptedSpecifies whether the DB instance isstorageThroughputThe storage throughput value for the DB instance. Can only be set whenstorageTypeis"gp3". Cannot be specified if theallocatedStoragevalue is below a per-enginethreshold. See the RDS User Guide for details.storageTypeOne of "standard" (magnetic), "gp2" (generaltagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.timezoneTime zone of the DB instance.timezoneis currentlyupgradeStorageConfigWhether to upgrade the storage file system configuration on the read replica.username(Required unless asnapshotIdentifierorreplicateSourceDbvpcSecurityGroupIdsList of VPC security groups toconst -
InstanceArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allocatedStorage
→ Input<
int?> ? -
The allocated storage in gibibytes. If
maxAllocatedStorageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. IfreplicateSourceDbis set, the value is ignored during the creation of the instance.final -
allowMajorVersionUpgrade
→ Input<
bool?> ? -
Indicates that major version
upgrades are allowed. Changing this parameter does not result in an outage and
the change is asynchronously applied as soon as possible.
final
-
applyImmediately
→ Input<
bool?> ? -
Specifies whether any database modifications
are applied immediately, or during the next maintenance window. Default is
false. See Amazon RDS Documentation for more information.final -
autoMinorVersionUpgrade
→ Input<
bool?> ? -
Indicates that minor engine upgrades
will be applied automatically to the DB instance during the maintenance window.
Defaults to true.
final
-
availabilityZone
→ Input<
String?> ? -
The AZ for the RDS instance.
final
-
backupRetentionPeriod
→ Input<
int?> ? -
The days to retain backups for.
Must be between
0and35. Default is0. Must be greater than0if the database is used as a source for ainstance-replication, uses low-downtime updates, or will useblue-green.final -
backupTarget
→ Input<
String?> ? -
Specifies where automated backups and manual snapshots are stored. Possible values are
region(default) andoutposts. See Working with Amazon RDS on AWS Outposts for more information.final -
backupWindow
→ Input<
String?> ? -
The daily time range (in UTC) during which automated backups are created if they are enabled.
Example: "09:46-10:16". Must not overlap with
maintenanceWindow.final -
blueGreenUpdate
→ Input<
InstanceBlueGreenUpdate?> ? -
Enables low-downtime updates using
blue-green. SeeblueGreenUpdatebelow.final -
caCertIdentifier
→ Input<
String?> ? -
The identifier of the CA certificate for the DB instance.
final
-
characterSetName
→ Input<
String?> ? -
The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation).
This can't be changed.
See Oracle Character Sets Supported in Amazon RDS or
Server-Level Collation for Microsoft SQL Server for more information.
Cannot be set with
replicateSourceDb,restoreToPointInTime,s3Import, orsnapshotIdentifier.final -
copyTagsToSnapshot
→ Input<
bool?> ? -
Copy all Instance
tagsto snapshots. Default isfalse.final -
customerOwnedIpEnabled
→ Input<
bool?> ? -
Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
final
-
customIamInstanceProfile
→ Input<
String?> ? -
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
final
-
databaseInsightsMode
→ Input<
String?> ? -
The mode of Database Insights that is enabled for the instance. Valid values:
standard,advanced.final -
dbName
→ Input<
String?> ? -
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
final
-
dbSubnetGroupName
→ Input<
String?> ? -
Name of DB subnet group.
DB instance will be created in the VPC associated with the DB subnet group.
If unspecified, will be created in the
defaultSubnet Group. When working with read replicas created in the same region, defaults to the Subnet Group Name of the source DB. When working with read replicas created in a different region, defaults to thedefaultSubnet Group. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica constraints.final -
dedicatedLogVolume
→ Input<
bool?> ? -
Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
final
-
deleteAutomatedBackups
→ Input<
bool?> ? -
Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true.final -
deletionProtection
→ Input<
bool?> ? -
If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to
true. The default isfalse.final -
domain
→ Input<
String?> ? -
The ID of the Directory Service Active Directory domain to create the instance in. Conflicts with
domainFqdn,domainOu,domainAuthSecretArnand adomainDnsIps.final -
domainAuthSecretArn
→ Input<
String?> ? -
The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomainIamRoleName.final -
domainDnsIps
→ Input<
List< ?String> ?> -
The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomainIamRoleName.final -
domainFqdn
→ Input<
String?> ? -
The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomainIamRoleName.final -
domainIamRoleName
→ Input<
String?> ? -
The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domainFqdn,domainOu,domainAuthSecretArnand adomainDnsIps.final -
domainOu
→ Input<
String?> ? -
The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomainIamRoleName.final -
enabledCloudwatchLogsExports
→ Input<
List< ?String> ?> -
Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
final
-
engine
→ Input<
String?> ? -
The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
final
-
engineLifecycleSupport
→ Input<
String?> ? -
The life cycle type for this DB instance. This setting applies only to RDS for MySQL and RDS for PostgreSQL. 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?> ? -
The engine version to use. If
autoMinorVersionUpgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). The actual engine version used is returned in the attributeengineVersionActual, see Attribute Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.final -
finalSnapshotIdentifier
→ Input<
String?> ? -
The name of your final DB snapshot
when this DB instance is deleted. Must be provided if
skipFinalSnapshotis set tofalse. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
iamDatabaseAuthenticationEnabled
→ Input<
bool?> ? -
Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database
accounts is enabled.
final
-
identifier
→ Input<
String?> ? -
The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if
restoreToPointInTimeis specified.final -
identifierPrefix
→ Input<
String?> ? -
Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.final - instanceClass → Input
-
The instance type of the RDS instance.
final
-
iops
→ Input<
int?> ? -
The amount of provisioned IOPS. Setting this implies a
storageType of "io1" or "io2". Can only be set when
storageTypeis"io1","io2or"gp3". Cannot be specified for gp3 storage if theallocatedStoragevalue is below a per-enginethreshold. See the RDS User Guide for details.final -
kmsKeyId
→ Input<
String?> ? -
The ARN for the KMS encryption key. If creating an
encrypted replica, set this to the destination KMS ARN.
final
-
licenseModel
→ Input<
String?> ? -
License model information for this DB instance. Valid values for this field are as follows:
final
-
maintenanceWindow
→ Input<
String?> ? -
The window to perform maintenance in.
Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS
Maintenance Window
docs
for more information.
final
-
manageMasterUserPassword
→ Input<
bool?> ? -
Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
passwordorpasswordWois provided.final -
masterUserSecretKmsKeyId
→ Input<
String?> ? -
The 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
-
maxAllocatedStorage
→ Input<
int?> ? -
Specifies the maximum storage (in GiB) that Amazon RDS can automatically scale to for this DB instance. By default, Storage Autoscaling is disabled. To enable Storage Autoscaling, set
maxAllocatedStorageto greater than or equal toallocatedStorage. SettingmaxAllocatedStorageto 0 explicitly disables Storage Autoscaling. When configured, changes toallocatedStoragewill be automatically ignored as the storage can dynamically scale.final -
monitoringInterval
→ Input<
int?> ? -
The interval, in seconds, between points
when Enhanced Monitoring metrics are collected for the DB instance. To disable
collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid
Values: 0, 1, 5, 10, 15, 30, 60.
final
-
monitoringRoleArn
→ Input<
String?> ? -
The 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 Instances.
final
-
multiAz
→ Input<
bool?> ? -
Specifies if the RDS instance is multi-AZ
final
-
ncharCharacterSetName
→ Input<
String?> ? -
The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets
Supported in Amazon RDS.
final
-
networkType
→ Input<
String?> ? -
The network type of the DB instance. Valid values:
IPV4,DUAL.final -
optionGroupName
→ Input<
String?> ? -
Name of the DB option group to associate.
final
-
parameterGroupName
→ Input<
String?> ? -
Name of the DB parameter group to associate.
final
-
password
→ 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. Cannot be set if
manageMasterUserPasswordis set totrue.final -
passwordWo
→ 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, and it will be stored in the state file. Cannot be set if
manageMasterUserPasswordis set totrue.final -
passwordWoVersion
→ Input<
int?> ? -
Used together with
passwordWoto trigger an update. Increment this value when an update topasswordWois required.final -
performanceInsightsEnabled
→ Input<
bool?> ? -
Specifies whether Performance Insights are enabled. Defaults to false.
final
-
performanceInsightsKmsKeyId
→ Input<
String?> ? -
The ARN for the KMS key to encrypt Performance Insights data. When specifying
performanceInsightsKmsKeyId,performanceInsightsEnabledneeds to be set to true. Once KMS key is set, it can never be changed.final -
performanceInsightsRetentionPeriod
→ Input<
int?> ? -
Amount of time in days to retain Performance Insights data. Valid values are
7,731(2 years) or a multiple of31. When specifyingperformanceInsightsRetentionPeriod,performanceInsightsEnabledneeds to be set to true. Defaults to '7'.final -
port
→ Input<
int?> ? -
The port on which the DB accepts connections.
final
-
publiclyAccessible
→ Input<
bool?> ? -
Bool to control if instance is publicly
accessible. Default is
false.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
replicaMode
→ Input<
String?> ? -
Specifies whether the replica is in either
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode unless otherwise specified. See Working with Oracle Read Replicas for more information.final -
replicateSourceDb
→ Input<
String?> ? -
Specifies that this resource is a Replica database, and to use this value as the source database.
If replicating an Amazon RDS Database Instance in the same region, use the
identifierof the source DB, unless also specifying thedbSubnetGroupName. If specifying thedbSubnetGroupNamein the same region, use thearnof the source DB. If replicating an Instance in a different region, use thearnof the source DB. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify akmsKeyId. Seeinstance-replicationand Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.final -
restoreToPointInTime
→ Input<
InstanceRestoreToPointInTime?> ? -
A configuration block for restoring a DB instance to an arbitrary point in time.
Requires the
identifierargument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3Import
→ Input<
InstanceS3Import?> ? -
Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
final
-
skipFinalSnapshot
→ Input<
bool?> ? -
Determines whether a final DB snapshot is
created before the DB instance is deleted. If true is specified, no DBSnapshot
is created. If false is specified, a DB snapshot is created before the DB
instance is deleted, using the value from
finalSnapshotIdentifier. Default isfalse.final -
snapshotIdentifier
→ Input<
String?> ? -
Specifies whether or not to create this database from a snapshot.
This corresponds to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
final
-
storageEncrypted
→ Input<
bool?> ? -
Specifies whether the DB instance is
encrypted. Note that if you are creating a cross-region read replica this field
is ignored and you should instead declare
kmsKeyIdwith a valid ARN. The default isfalseif not specified.final -
storageThroughput
→ Input<
int?> ? -
The storage throughput value for the DB instance. Can only be set when
storageTypeis"gp3". Cannot be specified if theallocatedStoragevalue is below a per-enginethreshold. See the RDS User Guide for details.final - storageType → Input?
-
One of "standard" (magnetic), "gp2" (general
purpose SSD), "gp3" (general purpose SSD that needs
iopsindependently) "io1" (provisioned IOPS SSD) or "io2" (block express storage provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not.final -
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
timezone
→ Input<
String?> ? -
Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information.final -
upgradeStorageConfig
→ Input<
bool?> ? -
Whether to upgrade the storage file system configuration on the read replica.
Can only be set with
replicateSourceDb.final -
username
→ Input<
String?> ? -
(Required unless a
snapshotIdentifierorreplicateSourceDbis provided) Username for the master DB user. Cannot be specified for a replica.final -
vpcSecurityGroupIds
→ Input<
List< ?String> ?> -
List of VPC security groups to
associate.
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