InstanceArgs constructor

const InstanceArgs({
  1. Input<int?>? allocatedStorage,
  2. Input<bool?>? allowMajorVersionUpgrade,
  3. Input<bool?>? applyImmediately,
  4. Input<bool?>? autoMinorVersionUpgrade,
  5. Input<String?>? availabilityZone,
  6. Input<int?>? backupRetentionPeriod,
  7. Input<String?>? backupTarget,
  8. Input<String?>? backupWindow,
  9. Input<InstanceBlueGreenUpdate?>? blueGreenUpdate,
  10. Input<String?>? caCertIdentifier,
  11. Input<String?>? characterSetName,
  12. Input<bool?>? copyTagsToSnapshot,
  13. Input<String?>? customIamInstanceProfile,
  14. Input<bool?>? customerOwnedIpEnabled,
  15. Input<String?>? databaseInsightsMode,
  16. Input<String?>? dbName,
  17. Input<String?>? dbSubnetGroupName,
  18. Input<bool?>? dedicatedLogVolume,
  19. Input<bool?>? deleteAutomatedBackups,
  20. Input<bool?>? deletionProtection,
  21. Input<String?>? domain,
  22. Input<String?>? domainAuthSecretArn,
  23. Input<List<String>?>? domainDnsIps,
  24. Input<String?>? domainFqdn,
  25. Input<String?>? domainIamRoleName,
  26. Input<String?>? domainOu,
  27. Input<List<String>?>? enabledCloudwatchLogsExports,
  28. Input<String?>? engine,
  29. Input<String?>? engineLifecycleSupport,
  30. Input<String?>? engineVersion,
  31. Input<String?>? finalSnapshotIdentifier,
  32. Input<bool?>? iamDatabaseAuthenticationEnabled,
  33. Input<String?>? identifier,
  34. Input<String?>? identifierPrefix,
  35. required Input instanceClass,
  36. Input<int?>? iops,
  37. Input<String?>? kmsKeyId,
  38. Input<String?>? licenseModel,
  39. Input<String?>? maintenanceWindow,
  40. Input<bool?>? manageMasterUserPassword,
  41. Input<String?>? masterUserSecretKmsKeyId,
  42. Input<int?>? maxAllocatedStorage,
  43. Input<int?>? monitoringInterval,
  44. Input<String?>? monitoringRoleArn,
  45. Input<bool?>? multiAz,
  46. Input<String?>? ncharCharacterSetName,
  47. Input<String?>? networkType,
  48. Input<String?>? optionGroupName,
  49. Input<String?>? parameterGroupName,
  50. Input<String?>? password,
  51. Input<String?>? passwordWo,
  52. Input<int?>? passwordWoVersion,
  53. Input<bool?>? performanceInsightsEnabled,
  54. Input<String?>? performanceInsightsKmsKeyId,
  55. Input<int?>? performanceInsightsRetentionPeriod,
  56. Input<int?>? port,
  57. Input<bool?>? publiclyAccessible,
  58. Input<String?>? region,
  59. Input<String?>? replicaMode,
  60. Input<String?>? replicateSourceDb,
  61. Input<InstanceRestoreToPointInTime?>? restoreToPointInTime,
  62. Input<InstanceS3Import?>? s3Import,
  63. Input<bool?>? skipFinalSnapshot,
  64. Input<String?>? snapshotIdentifier,
  65. Input<bool?>? storageEncrypted,
  66. Input<int?>? storageThroughput,
  67. Input? storageType,
  68. Input<Map<String, String>?>? tags,
  69. Input<String?>? timezone,
  70. Input<bool?>? upgradeStorageConfig,
  71. Input<String?>? username,
  72. Input<List<String>?>? vpcSecurityGroupIds,
})

Creates a new InstanceArgs. allocatedStorage The allocated storage in gibibytes. If maxAllocatedStorage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicateSourceDb is set, the value is ignored during the creation of the instance. allowMajorVersionUpgrade Indicates that major version applyImmediately Specifies whether any database modifications autoMinorVersionUpgrade Indicates that minor engine upgrades availabilityZone The AZ for the RDS instance. backupRetentionPeriod The days to retain backups for. backupTarget Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information. backupWindow The daily time range (in UTC) during which automated backups are created if they are enabled. blueGreenUpdate Enables low-downtime updates using blue-green. caCertIdentifier The identifier of the CA certificate for the DB instance. characterSetName The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). copyTagsToSnapshot Copy all Instance tags to snapshots. Default is false. customIamInstanceProfile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. customerOwnedIpEnabled 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. databaseInsightsMode The mode of Database Insights that is enabled for the instance. Valid values: standard, advanced . dbName 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. dbSubnetGroupName Name of DB subnet group. dedicatedLogVolume Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details. deleteAutomatedBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true. deletionProtection If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. domain The ID of the Directory Service Active Directory domain to create the instance in. Conflicts with domainFqdn, domainOu, domainAuthSecretArn and a domainDnsIps. domainAuthSecretArn The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with domain and domainIamRoleName. domainDnsIps 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 domain and domainIamRoleName. domainFqdn The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with domain and domainIamRoleName. domainIamRoleName The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with domainFqdn, domainOu, domainAuthSecretArn and a domainDnsIps. domainOu The self managed Active Directory organizational unit for your DB instance to join. Conflicts with domain and domainIamRoleName. enabledCloudwatchLogsExports 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. engine 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. engineLifecycleSupport 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 is open-source-rds-extended-support. Using Amazon RDS Extended Support: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html engineVersion The engine version to use. If autoMinorVersionUpgrade is enabled, you can provide a prefix of the version such as 8.0 (for 8.0.36). The actual engine version used is returned in the attribute engineVersionActual, 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'. finalSnapshotIdentifier The name of your final DB snapshot iamDatabaseAuthenticationEnabled Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database identifier The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restoreToPointInTime is specified. identifierPrefix Creates a unique identifier beginning with the specified prefix. Conflicts with identifier. instanceClass The instance type of the RDS instance. iops The amount of provisioned IOPS. Setting this implies a kmsKeyId The ARN for the KMS encryption key. If creating an licenseModel License model information for this DB instance. Valid values for this field are as follows: maintenanceWindow The window to perform maintenance in. manageMasterUserPassword Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password or passwordWo is provided. masterUserSecretKmsKeyId 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. maxAllocatedStorage 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 maxAllocatedStorage to greater than or equal to allocatedStorage. Setting maxAllocatedStorage to 0 explicitly disables Storage Autoscaling. When configured, changes to allocatedStorage will be automatically ignored as the storage can dynamically scale. monitoringInterval The interval, in seconds, between points monitoringRoleArn The ARN for the IAM role that permits RDS multiAz Specifies if the RDS instance is multi-AZ ncharCharacterSetName 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 networkType The network type of the DB instance. Valid values: IPV4, DUAL. optionGroupName Name of the DB option group to associate. parameterGroupName Name of the DB parameter group to associate. password 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 manageMasterUserPassword is set to true. passwordWo NOTE: This field is write-only and its value will not be updated in state as part of read operations. passwordWoVersion Used together with passwordWo to trigger an update. Increment this value when an update to passwordWo is required. performanceInsightsEnabled Specifies whether Performance Insights are enabled. Defaults to false. performanceInsightsKmsKeyId The ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true. Once KMS key is set, it can never be changed. performanceInsightsRetentionPeriod Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performanceInsightsRetentionPeriod, performanceInsightsEnabled needs to be set to true. Defaults to '7'. port The port on which the DB accepts connections. publiclyAccessible Bool to control if instance is publicly region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replicaMode Specifies whether the replica is in either mounted or open-read-only mode. This attribute replicateSourceDb Specifies that this resource is a Replica database, and to use this value as the source database. restoreToPointInTime A configuration block for restoring a DB instance to an arbitrary point in time. s3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance skipFinalSnapshot Determines whether a final DB snapshot is snapshotIdentifier Specifies whether or not to create this database from a snapshot. storageEncrypted Specifies whether the DB instance is storageThroughput The storage throughput value for the DB instance. Can only be set when storageType is "gp3". Cannot be specified if the allocatedStorage value is below a per-engine threshold. See the RDS User Guide for details. storageType One of "standard" (magnetic), "gp2" (general tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. timezone Time zone of the DB instance. timezone is currently upgradeStorageConfig Whether to upgrade the storage file system configuration on the read replica. username (Required unless a snapshotIdentifier or replicateSourceDb vpcSecurityGroupIds List of VPC security groups to

Implementation

const InstanceArgs({
  this.allocatedStorage,
  this.allowMajorVersionUpgrade,
  this.applyImmediately,
  this.autoMinorVersionUpgrade,
  this.availabilityZone,
  this.backupRetentionPeriod,
  this.backupTarget,
  this.backupWindow,
  this.blueGreenUpdate,
  this.caCertIdentifier,
  this.characterSetName,
  this.copyTagsToSnapshot,
  this.customIamInstanceProfile,
  this.customerOwnedIpEnabled,
  this.databaseInsightsMode,
  this.dbName,
  this.dbSubnetGroupName,
  this.dedicatedLogVolume,
  this.deleteAutomatedBackups,
  this.deletionProtection,
  this.domain,
  this.domainAuthSecretArn,
  this.domainDnsIps,
  this.domainFqdn,
  this.domainIamRoleName,
  this.domainOu,
  this.enabledCloudwatchLogsExports,
  this.engine,
  this.engineLifecycleSupport,
  this.engineVersion,
  this.finalSnapshotIdentifier,
  this.iamDatabaseAuthenticationEnabled,
  this.identifier,
  this.identifierPrefix,
  required this.instanceClass,
  this.iops,
  this.kmsKeyId,
  this.licenseModel,
  this.maintenanceWindow,
  this.manageMasterUserPassword,
  this.masterUserSecretKmsKeyId,
  this.maxAllocatedStorage,
  this.monitoringInterval,
  this.monitoringRoleArn,
  this.multiAz,
  this.ncharCharacterSetName,
  this.networkType,
  this.optionGroupName,
  this.parameterGroupName,
  this.password,
  this.passwordWo,
  this.passwordWoVersion,
  this.performanceInsightsEnabled,
  this.performanceInsightsKmsKeyId,
  this.performanceInsightsRetentionPeriod,
  this.port,
  this.publiclyAccessible,
  this.region,
  this.replicaMode,
  this.replicateSourceDb,
  this.restoreToPointInTime,
  this.s3Import,
  this.skipFinalSnapshot,
  this.snapshotIdentifier,
  this.storageEncrypted,
  this.storageThroughput,
  this.storageType,
  this.tags,
  this.timezone,
  this.upgradeStorageConfig,
  this.username,
  this.vpcSecurityGroupIds,
});