import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Provides an RDS instance resource. A DB instance is an isolated database * environment in the cloud. A DB instance can contain multiple user-created * databases. * * Changes to a DB instance can occur when you manually change a parameter, such as * `allocatedStorage`, and are reflected in the next maintenance window. Because * of this, this provider may report a difference in its planning phase because a * modification has not yet taken place. You can use the `applyImmediately` flag * to instruct the service to apply the change immediately (see documentation * below). * * When upgrading the major version of an engine, `allowMajorVersionUpgrade` must be set to `true`. * * > **Note:** using `applyImmediately` can result in a brief downtime as the server reboots. * See the AWS Docs on [RDS Instance Maintenance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html) for more information. * * > **Note:** All arguments including the username and password will be stored in the raw state as plain-text. * Read more about sensitive data instate. * * Amazon RDS supports instance classes for General-purpose, Memory-optimized, Burstable Performance, and Optimized-reads use cases. For more information see [DB Instance Class Types](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html). * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * dbName: "mydb", * engine: "mysql", * engineVersion: "8.0", * instanceClass: aws.rds.InstanceType.T3_Micro, * username: "foo", * password: "foobarbaz", * parameterGroupName: "default.mysql8.0", * skipFinalSnapshot: true, * }); * ``` * * ### RDS Custom for Oracle Usage with Replica * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * // Lookup the available instance classes for the custom engine for the region being operated in * const custom_oracle = aws.rds.getOrderableDbInstance({ * engine: "custom-oracle-ee", * engineVersion: "19.c.ee.002", * licenseModel: "bring-your-own-license", * storageType: "gp3", * preferredInstanceClasses: [ * "db.r5.xlarge", * "db.r5.2xlarge", * "db.r5.4xlarge", * ], * }); * // The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV. * const byId = aws.kms.getKey({ * keyId: "example-ef278353ceba4a5a97de6784565b9f78", * }); * const _default = new aws.rds.Instance("default", { * allocatedStorage: 50, * autoMinorVersionUpgrade: false, * customIamInstanceProfile: "AWSRDSCustomInstanceProfile", * backupRetentionPeriod: 7, * dbSubnetGroupName: dbSubnetGroupName, * engine: custom_oracle.then(custom_oracle => custom_oracle.engine), * engineVersion: custom_oracle.then(custom_oracle => custom_oracle.engineVersion), * identifier: "ee-instance-demo", * instanceClass: aws.rds.InstanceType[custom_oracle.then(custom_oracle => custom_oracle.instanceClass)], * kmsKeyId: byId.then(byId => byId.arn), * licenseModel: custom_oracle.then(custom_oracle => custom_oracle.licenseModel), * multiAz: false, * password: "avoid-plaintext-passwords", * username: "test", * storageEncrypted: true, * }, { * customTimeouts: { * create: "3h", * "delete": "3h", * update: "3h", * }, * }); * const test_replica = new aws.rds.Instance("test-replica", { * replicateSourceDb: _default.identifier, * replicaMode: "mounted", * autoMinorVersionUpgrade: false, * customIamInstanceProfile: "AWSRDSCustomInstanceProfile", * backupRetentionPeriod: 7, * identifier: "ee-instance-replica", * instanceClass: aws.rds.InstanceType[custom_oracle.then(custom_oracle => custom_oracle.instanceClass)], * kmsKeyId: byId.then(byId => byId.arn), * multiAz: false, * skipFinalSnapshot: true, * storageEncrypted: true, * }, { * customTimeouts: { * create: "3h", * "delete": "3h", * update: "3h", * }, * }); * ``` * * ### RDS Custom for SQL Server * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * // Lookup the available instance classes for the custom engine for the region being operated in * const custom_sqlserver = aws.rds.getOrderableDbInstance({ * engine: "custom-sqlserver-se", * engineVersion: "15.00.4249.2.v1", * storageType: "gp3", * preferredInstanceClasses: [ * "db.r5.xlarge", * "db.r5.2xlarge", * "db.r5.4xlarge", * ], * }); * // The RDS instance resource requires an ARN. Look up the ARN of the KMS key. * const byId = aws.kms.getKey({ * keyId: "example-ef278353ceba4a5a97de6784565b9f78", * }); * const example = new aws.rds.Instance("example", { * allocatedStorage: 500, * autoMinorVersionUpgrade: false, * customIamInstanceProfile: "AWSRDSCustomSQLServerInstanceProfile", * backupRetentionPeriod: 7, * dbSubnetGroupName: dbSubnetGroupName, * engine: custom_sqlserver.then(custom_sqlserver => custom_sqlserver.engine), * engineVersion: custom_sqlserver.then(custom_sqlserver => custom_sqlserver.engineVersion), * identifier: "sql-instance-demo", * instanceClass: aws.rds.InstanceType[custom_sqlserver.then(custom_sqlserver => custom_sqlserver.instanceClass)], * kmsKeyId: byId.then(byId => byId.arn), * multiAz: false, * password: "avoid-plaintext-passwords", * storageEncrypted: true, * username: "test", * }, { * customTimeouts: { * create: "3h", * "delete": "3h", * update: "3h", * }, * }); * ``` * * ### RDS Db2 Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * // Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`. * const _default = aws.rds.getEngineVersion({ * engine: "db2-se", * }); * // Lookup the available instance classes for the engine in the region being operated in * const example = _default.then(_default => aws.rds.getOrderableDbInstance({ * engine: _default.engine, * engineVersion: _default.version, * licenseModel: "bring-your-own-license", * storageType: "gp3", * preferredInstanceClasses: [ * "db.t3.small", * "db.r6i.large", * "db.m6i.large", * ], * })); * // The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information. * const exampleParameterGroup = new aws.rds.ParameterGroup("example", { * parameters: [ * { * applyMethod: "immediate", * name: "rds.ibm_customer_id", * value: "0", * }, * { * applyMethod: "immediate", * name: "rds.ibm_site_id", * value: "0", * }, * ], * name: "db-db2-params", * family: _default.then(_default => _default.parameterGroupFamily), * }); * // Create the RDS Db2 instance, use the data sources defined to set attributes * const exampleInstance = new aws.rds.Instance("example", { * allocatedStorage: 100, * backupRetentionPeriod: 7, * dbName: "test", * engine: example.then(example => example.engine), * engineVersion: example.then(example => example.engineVersion), * identifier: "db2-instance-demo", * instanceClass: aws.rds.InstanceType[example.then(example => example.instanceClass)], * parameterGroupName: exampleParameterGroup.name, * password: "avoid-plaintext-passwords", * username: "test", * }); * ``` * * ### Storage Autoscaling * * To enable Storage Autoscaling with instances that support the feature, define the `maxAllocatedStorage` argument higher than the `allocatedStorage` argument. This provider will automatically hide differences with the `allocatedStorage` argument value if autoscaling occurs. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.rds.Instance("example", { * allocatedStorage: 50, * maxAllocatedStorage: 100, * }); * ``` * * ### Managed Master Passwords via Secrets Manager, default KMS Key * * > More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the [RDS User Guide](https://aws.amazon.com/about-aws/whats-new/2022/12/amazon-rds-integration-aws-secrets-manager/) and [Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html). * * You can specify the `manageMasterUserPassword` attribute to enable managing the master password with Secrets Manager. You can also update an existing cluster to use Secrets Manager by specify the `manageMasterUserPassword` attribute and removing the `password` attribute (removal is required). * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * dbName: "mydb", * engine: "mysql", * engineVersion: "8.0", * instanceClass: aws.rds.InstanceType.T3_Micro, * manageMasterUserPassword: true, * username: "foo", * parameterGroupName: "default.mysql8.0", * }); * ``` * * ### Managed Master Passwords via Secrets Manager, specific KMS Key * * > More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the [RDS User Guide](https://aws.amazon.com/about-aws/whats-new/2022/12/amazon-rds-integration-aws-secrets-manager/) and [Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html). * * You can specify the `masterUserSecretKmsKeyId` attribute to specify a specific KMS Key. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.kms.Key("example", {description: "Example KMS Key"}); * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * dbName: "mydb", * engine: "mysql", * engineVersion: "8.0", * instanceClass: aws.rds.InstanceType.T3_Micro, * manageMasterUserPassword: true, * masterUserSecretKmsKeyId: example.keyId, * username: "foo", * parameterGroupName: "default.mysql8.0", * }); * ``` * * ### Disabling Master Password Rotation * * When `manageMasterUserPassword` is enabled, Secrets Manager rotates the master user password automatically (every 7 days by default). To disable that rotation while keeping the managed secret, manage the secret's rotation with `aws.secretsmanager.SecretRotation` and set `rotationEnabled = false`. * * Referencing `aws_db_instance.default.master_user_secret[0].secret_arn` (as in the example below) ensures the rotation change is applied after the instance is available. Avoid hardcoding the secret ARN, which would remove that ordering. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const _default = new aws.rds.Instance("default", { * allocatedStorage: 10, * dbName: "mydb", * engine: "mysql", * engineVersion: "8.0", * instanceClass: aws.rds.InstanceType.T3_Micro, * manageMasterUserPassword: true, * username: "foo", * parameterGroupName: "default.mysql8.0", * }); * const defaultSecretRotation = new aws.secretsmanager.SecretRotation("default", { * secretId: _default.masterUserSecrets[0].secretArn, * rotationEnabled: false, * }); * ``` * * ### RDS Instance from S3 Import (Percona XtraBackup) * * Full details on the core parameters and impacts are in the API Docs: [RestoreDBInstanceFromS3](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromS3.html). This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const db = new aws.rds.Instance("db", {s3Import: { * sourceEngine: "mysql", * sourceEngineVersion: "5.6", * bucketName: "mybucket", * bucketPrefix: "backups", * ingestionRole: "arn:aws:iam::1234567890:role/role-xtrabackup-rds-restore", * }}); * ``` * * > **NOTE:** Removing the `replicateSourceDb` attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database. * * For more detailed documentation about each argument, refer to the [AWS official documentation](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). * * ## Import * * ### Identity Schema * * #### Required * * * `identifier` (String) Identifier of the DB Instance. * * #### Optional * * * `accountId` (String) AWS Account where this resource is managed. * * `region` (String) Region where this resource is managed. * * Using `pulumi import`, import DB Instances using the `identifier`. For example: * * ```sh * $ pulumi import aws:rds/instance:Instance default mydb-rds-instance * ``` */ export declare class Instance extends pulumi.CustomResource { /** * Get an existing Instance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance; /** * Returns true if the given object is an instance of Instance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Instance; /** * DNS address of the DB instance. */ readonly address: pulumi.Output; /** * 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. */ readonly allocatedStorage: pulumi.Output; /** * Whether major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. */ readonly allowMajorVersionUpgrade: pulumi.Output; /** * Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) */ readonly applyImmediately: pulumi.Output; /** * ARN of the RDS instance. */ readonly arn: pulumi.Output; /** * Whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true. */ readonly autoMinorVersionUpgrade: pulumi.Output; /** * AZ for the RDS instance. */ readonly availabilityZone: pulumi.Output; /** * Days to retain backups for. Must be between `0` and `35`. Default is `0`. Must be greater than `0` if the database is used as a source for a [Read Replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html), uses low-downtime updates, or will use [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). */ readonly backupRetentionPeriod: pulumi.Output; /** * Where automated backups and manual snapshots are stored. Possible values are `region` (default) and `outposts`. See [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) for more information. */ readonly backupTarget: pulumi.Output; /** * 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`. */ readonly backupWindow: pulumi.Output; /** * Enables low-downtime updates using [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). See `blueGreenUpdate` Block below. */ readonly blueGreenUpdate: pulumi.Output; /** * Identifier of the CA certificate for the DB instance. */ readonly caCertIdentifier: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) or [Server-Level Collation for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html) for more information. Cannot be set with `replicateSourceDb`, `restoreToPointInTime`, `s3Import`, or `snapshotIdentifier`. */ readonly characterSetName: pulumi.Output; /** * Copy all Instance `tags` to snapshots. Default is `false`. */ readonly copyTagsToSnapshot: pulumi.Output; /** * Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. */ readonly customIamInstanceProfile: pulumi.Output; /** * Whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See [CoIP for RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.coip) for more information. */ readonly customerOwnedIpEnabled: pulumi.Output; /** * Mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` . */ readonly databaseInsightsMode: pulumi.Output; /** * 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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) 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. */ readonly dbName: pulumi.Output; /** * 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 `default` Subnet 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 the `default` Subnet Group. See [DBSubnetGroupName in API action CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) for additional read replica constraints. */ readonly dbSubnetGroupName: pulumi.Output; /** * Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.dlv) for more details. */ readonly dedicatedLogVolume: pulumi.Output; /** * Whether to remove automated backups immediately after the DB instance is deleted. Default is `true`. */ readonly deleteAutomatedBackups: pulumi.Output; /** * 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`. */ readonly deletionProtection: pulumi.Output; /** * ID of the Directory Service Active Directory domain to create the instance in. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ readonly domain: pulumi.Output; /** * ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domainIamRoleName`. */ readonly domainAuthSecretArn: pulumi.Output; /** * 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`. */ readonly domainDnsIps: pulumi.Output; /** * Fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domainIamRoleName`. */ readonly domainFqdn: pulumi.Output; /** * Name of the IAM role to be used when making API calls to the Directory Service. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ readonly domainIamRoleName: pulumi.Output; /** * Self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domainIamRoleName`. */ readonly domainOu: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). */ readonly enabledCloudwatchLogsExports: pulumi.Output; /** * Connection endpoint in `address:port` format. */ readonly endpoint: pulumi.Output; /** * Database engine to use. For supported values, see the Engine parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) in the Amazon RDS User Guide. */ readonly engine: pulumi.Output; /** * 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 */ readonly engineLifecycleSupport: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'. */ readonly engineVersion: pulumi.Output; /** * Running version of the database. */ readonly engineVersionActual: pulumi.Output; /** * Name of your final DB snapshot when this DB instance is deleted. Must be provided if `skipFinalSnapshot` is set to `false`. 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. */ readonly finalSnapshotIdentifier: pulumi.Output; /** * ID that Amazon Route 53 assigns when you create a hosted zone. */ readonly hostedZoneId: pulumi.Output; /** * Whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. */ readonly iamDatabaseAuthenticationEnabled: pulumi.Output; /** * Name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if `restoreToPointInTime` is specified. */ readonly identifier: pulumi.Output; /** * Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. */ readonly identifierPrefix: pulumi.Output; /** * Instance type of the RDS instance. */ readonly instanceClass: pulumi.Output; /** * Amount of provisioned IOPS. Setting this implies a storageType of "io1" or "io2". Can only be set when `storageType` is `"io1"`, `"io2` or `"gp3"`. Cannot be specified for gp3 storage if the `allocatedStorage` value is below a per-`engine` threshold. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ readonly iops: pulumi.Output; /** * ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. */ readonly kmsKeyId: pulumi.Output; /** * Latest time, in UTC [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), to which a database can be restored with point-in-time restore. */ readonly latestRestorableTime: pulumi.Output; /** * License model information for this DB instance. Valid values for this field are as follows: RDS for MariaDB: `general-public-license`; RDS for Microsoft SQL Server: `license-included`; RDS for MySQL: `general-public-license`; RDS for Oracle: `bring-your-own-license | license-included`; RDS for PostgreSQL: `postgresql-license`. */ readonly licenseModel: pulumi.Output; /** * Listener connection endpoint for SQL Server Always On. See Endpoint below. */ readonly listenerEndpoints: pulumi.Output; /** * Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See [RDS Maintenance Window docs](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) for more information. */ readonly maintenanceWindow: pulumi.Output; /** * Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `password` or `passwordWo` is provided. */ readonly manageMasterUserPassword: pulumi.Output; /** * 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. */ readonly masterUserSecretKmsKeyId: pulumi.Output; /** * Block that specifies the master user secret. Only available when `manageMasterUserPassword` is set to true. See `masterUserSecret` Block below. */ readonly masterUserSecrets: pulumi.Output; /** * 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. */ readonly maxAllocatedStorage: pulumi.Output; /** * 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. */ readonly monitoringInterval: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances. */ readonly monitoringRoleArn: pulumi.Output; /** * Whether the RDS instance is multi-AZ. */ readonly multiAz: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html). */ readonly ncharCharacterSetName: pulumi.Output; /** * Network type of the DB instance. Valid values: `IPV4`, `DUAL`. */ readonly networkType: pulumi.Output; /** * Name of the DB option group to associate. */ readonly optionGroupName: pulumi.Output; /** * Name of the DB parameter group to associate. */ readonly parameterGroupName: pulumi.Output; /** * 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`. */ readonly password: pulumi.Output; /** * **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 `manageMasterUserPassword` is set to `true`. If set, requires `passwordWoVersion` to be set. */ readonly passwordWo: pulumi.Output; /** * Required when `passwordWo` is set. Changing this value triggers an update to `passwordWo`. */ readonly passwordWoVersion: pulumi.Output; /** * Whether Performance Insights are enabled. Defaults to false. */ readonly performanceInsightsEnabled: pulumi.Output; /** * 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. */ readonly performanceInsightsKmsKeyId: pulumi.Output; /** * 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'. */ readonly performanceInsightsRetentionPeriod: pulumi.Output; /** * Port on which the DB accepts connections. */ readonly port: pulumi.Output; /** * Bool to control if instance is publicly accessible. Default is `false`. */ readonly publiclyAccessible: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Whether the replica is in either `mounted` or `open-read-only` mode. This attribute is only supported by Oracle instances. Oracle replicas operate in `open-read-only` mode unless otherwise specified. See [Working with Oracle Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) for more information. */ readonly replicaMode: pulumi.Output; /** * List of read replica identifiers associated with this instance. */ readonly replicas: pulumi.Output; /** * Set this to specify 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 `identifier` of the source DB, unless also specifying the `dbSubnetGroupName`. If specifying the `dbSubnetGroupName` in the same region, use the `arn` of the source DB. If replicating an Instance in a different region, use the `arn` of the source DB. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a `kmsKeyId`. See [DB Instance Replication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html) and [Working with PostgreSQL and MySQL Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) for more information on using Replication. */ readonly replicateSourceDb: pulumi.Output; /** * RDS Resource ID of this instance. */ readonly resourceId: pulumi.Output; /** * Configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See `restoreToPointInTime` Block below for details. */ readonly restoreToPointInTime: pulumi.Output; /** * Restore from a Percona XtraBackup in S3. See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html). See `s3Import` Block below. */ readonly s3Import: pulumi.Output; /** * 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 is `false`. */ readonly skipFinalSnapshot: pulumi.Output; /** * 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. */ readonly snapshotIdentifier: pulumi.Output; /** * RDS instance status. */ readonly status: pulumi.Output; /** * 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 `kmsKeyId` with a valid ARN. The default is `false` if not specified. */ readonly storageEncrypted: pulumi.Output; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ readonly storageThroughput: pulumi.Output; /** * One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs `iops` independently) "io1" (provisioned IOPS SSD) or "io2" (block express storage provisioned IOPS SSD). The default is "io1" if `iops` is specified, "gp2" if not. */ readonly storageType: pulumi.Output; /** * 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. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Time zone of the DB instance. `timezone` is currently only supported by Microsoft SQL Server. The `timezone` can only be set on creation. See [MSSQL User Guide](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) for more information. */ readonly timezone: pulumi.Output; /** * Order in which the instances are upgraded (`first`, `second`, `last`). See [the AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Maintenance.AMVU.UpgradeRollout.html) for details. */ readonly upgradeRolloutOrder: pulumi.Output; /** * Whether to upgrade the storage file system configuration on the read replica. Can only be set with `replicateSourceDb`. */ readonly upgradeStorageConfig: pulumi.Output; /** * Username for the master DB user. Cannot be specified for a replica. */ readonly username: pulumi.Output; /** * List of VPC security groups to associate. */ readonly vpcSecurityGroupIds: pulumi.Output; /** * Set of RDS event categories (for example `failure`, `maintenance`) to check for after create and update operations. If set, the provider describes RDS events reported for this instance during the operation and surfaces a warning diagnostic, with the RDS event message, for each one found in these categories. Has no effect if unset; see [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) and the `aws.rds.getEvents` data source for the source of these events. Requires the `rds:DescribeEvents` IAM permission when set. */ readonly warningEventCategories: pulumi.Output; /** * Create a Instance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Instance resources. */ export interface InstanceState { /** * DNS address of the DB instance. */ address?: pulumi.Input; /** * 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. */ allocatedStorage?: pulumi.Input; /** * Whether major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. */ allowMajorVersionUpgrade?: pulumi.Input; /** * Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) */ applyImmediately?: pulumi.Input; /** * ARN of the RDS instance. */ arn?: pulumi.Input; /** * Whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true. */ autoMinorVersionUpgrade?: pulumi.Input; /** * AZ for the RDS instance. */ availabilityZone?: pulumi.Input; /** * Days to retain backups for. Must be between `0` and `35`. Default is `0`. Must be greater than `0` if the database is used as a source for a [Read Replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html), uses low-downtime updates, or will use [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). */ backupRetentionPeriod?: pulumi.Input; /** * Where automated backups and manual snapshots are stored. Possible values are `region` (default) and `outposts`. See [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) for more information. */ backupTarget?: pulumi.Input; /** * 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`. */ backupWindow?: pulumi.Input; /** * Enables low-downtime updates using [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). See `blueGreenUpdate` Block below. */ blueGreenUpdate?: pulumi.Input; /** * Identifier of the CA certificate for the DB instance. */ caCertIdentifier?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) or [Server-Level Collation for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html) for more information. Cannot be set with `replicateSourceDb`, `restoreToPointInTime`, `s3Import`, or `snapshotIdentifier`. */ characterSetName?: pulumi.Input; /** * Copy all Instance `tags` to snapshots. Default is `false`. */ copyTagsToSnapshot?: pulumi.Input; /** * Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. */ customIamInstanceProfile?: pulumi.Input; /** * Whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See [CoIP for RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.coip) for more information. */ customerOwnedIpEnabled?: pulumi.Input; /** * Mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` . */ databaseInsightsMode?: pulumi.Input; /** * 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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) 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. */ dbName?: pulumi.Input; /** * 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 `default` Subnet 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 the `default` Subnet Group. See [DBSubnetGroupName in API action CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) for additional read replica constraints. */ dbSubnetGroupName?: pulumi.Input; /** * Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.dlv) for more details. */ dedicatedLogVolume?: pulumi.Input; /** * Whether to remove automated backups immediately after the DB instance is deleted. Default is `true`. */ deleteAutomatedBackups?: pulumi.Input; /** * 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`. */ deletionProtection?: pulumi.Input; /** * ID of the Directory Service Active Directory domain to create the instance in. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ domain?: pulumi.Input; /** * ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domainIamRoleName`. */ domainAuthSecretArn?: pulumi.Input; /** * 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`. */ domainDnsIps?: pulumi.Input[] | undefined>; /** * Fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domainIamRoleName`. */ domainFqdn?: pulumi.Input; /** * Name of the IAM role to be used when making API calls to the Directory Service. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ domainIamRoleName?: pulumi.Input; /** * Self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domainIamRoleName`. */ domainOu?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). */ enabledCloudwatchLogsExports?: pulumi.Input[] | undefined>; /** * Connection endpoint in `address:port` format. */ endpoint?: pulumi.Input; /** * Database engine to use. For supported values, see the Engine parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) in the Amazon RDS User Guide. */ engine?: pulumi.Input; /** * 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 */ engineLifecycleSupport?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'. */ engineVersion?: pulumi.Input; /** * Running version of the database. */ engineVersionActual?: pulumi.Input; /** * Name of your final DB snapshot when this DB instance is deleted. Must be provided if `skipFinalSnapshot` is set to `false`. 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. */ finalSnapshotIdentifier?: pulumi.Input; /** * ID that Amazon Route 53 assigns when you create a hosted zone. */ hostedZoneId?: pulumi.Input; /** * Whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. */ iamDatabaseAuthenticationEnabled?: pulumi.Input; /** * Name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if `restoreToPointInTime` is specified. */ identifier?: pulumi.Input; /** * Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. */ identifierPrefix?: pulumi.Input; /** * Instance type of the RDS instance. */ instanceClass?: pulumi.Input; /** * Amount of provisioned IOPS. Setting this implies a storageType of "io1" or "io2". Can only be set when `storageType` is `"io1"`, `"io2` or `"gp3"`. Cannot be specified for gp3 storage if the `allocatedStorage` value is below a per-`engine` threshold. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ iops?: pulumi.Input; /** * ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. */ kmsKeyId?: pulumi.Input; /** * Latest time, in UTC [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), to which a database can be restored with point-in-time restore. */ latestRestorableTime?: pulumi.Input; /** * License model information for this DB instance. Valid values for this field are as follows: RDS for MariaDB: `general-public-license`; RDS for Microsoft SQL Server: `license-included`; RDS for MySQL: `general-public-license`; RDS for Oracle: `bring-your-own-license | license-included`; RDS for PostgreSQL: `postgresql-license`. */ licenseModel?: pulumi.Input; /** * Listener connection endpoint for SQL Server Always On. See Endpoint below. */ listenerEndpoints?: pulumi.Input[] | undefined>; /** * Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See [RDS Maintenance Window docs](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) for more information. */ maintenanceWindow?: pulumi.Input; /** * Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `password` or `passwordWo` is provided. */ manageMasterUserPassword?: pulumi.Input; /** * 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. */ masterUserSecretKmsKeyId?: pulumi.Input; /** * Block that specifies the master user secret. Only available when `manageMasterUserPassword` is set to true. See `masterUserSecret` Block below. */ masterUserSecrets?: pulumi.Input[] | undefined>; /** * 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. */ maxAllocatedStorage?: pulumi.Input; /** * 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. */ monitoringInterval?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances. */ monitoringRoleArn?: pulumi.Input; /** * Whether the RDS instance is multi-AZ. */ multiAz?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html). */ ncharCharacterSetName?: pulumi.Input; /** * Network type of the DB instance. Valid values: `IPV4`, `DUAL`. */ networkType?: pulumi.Input; /** * Name of the DB option group to associate. */ optionGroupName?: pulumi.Input; /** * Name of the DB parameter group to associate. */ parameterGroupName?: pulumi.Input; /** * 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`. */ password?: pulumi.Input; /** * **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 `manageMasterUserPassword` is set to `true`. If set, requires `passwordWoVersion` to be set. */ passwordWo?: pulumi.Input; /** * Required when `passwordWo` is set. Changing this value triggers an update to `passwordWo`. */ passwordWoVersion?: pulumi.Input; /** * Whether Performance Insights are enabled. Defaults to false. */ performanceInsightsEnabled?: pulumi.Input; /** * 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. */ performanceInsightsKmsKeyId?: pulumi.Input; /** * 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'. */ performanceInsightsRetentionPeriod?: pulumi.Input; /** * Port on which the DB accepts connections. */ port?: pulumi.Input; /** * Bool to control if instance is publicly accessible. Default is `false`. */ publiclyAccessible?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Whether the replica is in either `mounted` or `open-read-only` mode. This attribute is only supported by Oracle instances. Oracle replicas operate in `open-read-only` mode unless otherwise specified. See [Working with Oracle Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) for more information. */ replicaMode?: pulumi.Input; /** * List of read replica identifiers associated with this instance. */ replicas?: pulumi.Input[] | undefined>; /** * Set this to specify 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 `identifier` of the source DB, unless also specifying the `dbSubnetGroupName`. If specifying the `dbSubnetGroupName` in the same region, use the `arn` of the source DB. If replicating an Instance in a different region, use the `arn` of the source DB. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a `kmsKeyId`. See [DB Instance Replication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html) and [Working with PostgreSQL and MySQL Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) for more information on using Replication. */ replicateSourceDb?: pulumi.Input; /** * RDS Resource ID of this instance. */ resourceId?: pulumi.Input; /** * Configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See `restoreToPointInTime` Block below for details. */ restoreToPointInTime?: pulumi.Input; /** * Restore from a Percona XtraBackup in S3. See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html). See `s3Import` Block below. */ s3Import?: pulumi.Input; /** * 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 is `false`. */ skipFinalSnapshot?: pulumi.Input; /** * 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. */ snapshotIdentifier?: pulumi.Input; /** * RDS instance status. */ status?: pulumi.Input; /** * 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 `kmsKeyId` with a valid ARN. The default is `false` if not specified. */ storageEncrypted?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ storageThroughput?: pulumi.Input; /** * One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs `iops` independently) "io1" (provisioned IOPS SSD) or "io2" (block express storage provisioned IOPS SSD). The default is "io1" if `iops` is specified, "gp2" if not. */ storageType?: pulumi.Input; /** * 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. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Time zone of the DB instance. `timezone` is currently only supported by Microsoft SQL Server. The `timezone` can only be set on creation. See [MSSQL User Guide](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) for more information. */ timezone?: pulumi.Input; /** * Order in which the instances are upgraded (`first`, `second`, `last`). See [the AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Maintenance.AMVU.UpgradeRollout.html) for details. */ upgradeRolloutOrder?: pulumi.Input; /** * Whether to upgrade the storage file system configuration on the read replica. Can only be set with `replicateSourceDb`. */ upgradeStorageConfig?: pulumi.Input; /** * Username for the master DB user. Cannot be specified for a replica. */ username?: pulumi.Input; /** * List of VPC security groups to associate. */ vpcSecurityGroupIds?: pulumi.Input[] | undefined>; /** * Set of RDS event categories (for example `failure`, `maintenance`) to check for after create and update operations. If set, the provider describes RDS events reported for this instance during the operation and surfaces a warning diagnostic, with the RDS event message, for each one found in these categories. Has no effect if unset; see [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) and the `aws.rds.getEvents` data source for the source of these events. Requires the `rds:DescribeEvents` IAM permission when set. */ warningEventCategories?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * 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. */ allocatedStorage?: pulumi.Input; /** * Whether major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. */ allowMajorVersionUpgrade?: pulumi.Input; /** * Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) */ applyImmediately?: pulumi.Input; /** * Whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true. */ autoMinorVersionUpgrade?: pulumi.Input; /** * AZ for the RDS instance. */ availabilityZone?: pulumi.Input; /** * Days to retain backups for. Must be between `0` and `35`. Default is `0`. Must be greater than `0` if the database is used as a source for a [Read Replica](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html), uses low-downtime updates, or will use [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). */ backupRetentionPeriod?: pulumi.Input; /** * Where automated backups and manual snapshots are stored. Possible values are `region` (default) and `outposts`. See [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) for more information. */ backupTarget?: pulumi.Input; /** * 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`. */ backupWindow?: pulumi.Input; /** * Enables low-downtime updates using [RDS Blue/Green deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html). See `blueGreenUpdate` Block below. */ blueGreenUpdate?: pulumi.Input; /** * Identifier of the CA certificate for the DB instance. */ caCertIdentifier?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) or [Server-Level Collation for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html) for more information. Cannot be set with `replicateSourceDb`, `restoreToPointInTime`, `s3Import`, or `snapshotIdentifier`. */ characterSetName?: pulumi.Input; /** * Copy all Instance `tags` to snapshots. Default is `false`. */ copyTagsToSnapshot?: pulumi.Input; /** * Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. */ customIamInstanceProfile?: pulumi.Input; /** * Whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See [CoIP for RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html#rds-on-outposts.coip) for more information. */ customerOwnedIpEnabled?: pulumi.Input; /** * Mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` . */ databaseInsightsMode?: pulumi.Input; /** * 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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) 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. */ dbName?: pulumi.Input; /** * 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 `default` Subnet 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 the `default` Subnet Group. See [DBSubnetGroupName in API action CreateDBInstanceReadReplica](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) for additional read replica constraints. */ dbSubnetGroupName?: pulumi.Input; /** * Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.dlv) for more details. */ dedicatedLogVolume?: pulumi.Input; /** * Whether to remove automated backups immediately after the DB instance is deleted. Default is `true`. */ deleteAutomatedBackups?: pulumi.Input; /** * 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`. */ deletionProtection?: pulumi.Input; /** * ID of the Directory Service Active Directory domain to create the instance in. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ domain?: pulumi.Input; /** * ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domainIamRoleName`. */ domainAuthSecretArn?: pulumi.Input; /** * 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`. */ domainDnsIps?: pulumi.Input[] | undefined>; /** * Fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domainIamRoleName`. */ domainFqdn?: pulumi.Input; /** * Name of the IAM role to be used when making API calls to the Directory Service. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`. */ domainIamRoleName?: pulumi.Input; /** * Self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domainIamRoleName`. */ domainOu?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). */ enabledCloudwatchLogsExports?: pulumi.Input[] | undefined>; /** * Database engine to use. For supported values, see the Engine parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) in the Amazon RDS User Guide. */ engine?: pulumi.Input; /** * 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 */ engineLifecycleSupport?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'. */ engineVersion?: pulumi.Input; /** * Name of your final DB snapshot when this DB instance is deleted. Must be provided if `skipFinalSnapshot` is set to `false`. 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. */ finalSnapshotIdentifier?: pulumi.Input; /** * Whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. */ iamDatabaseAuthenticationEnabled?: pulumi.Input; /** * Name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if `restoreToPointInTime` is specified. */ identifier?: pulumi.Input; /** * Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. */ identifierPrefix?: pulumi.Input; /** * Instance type of the RDS instance. */ instanceClass: pulumi.Input; /** * Amount of provisioned IOPS. Setting this implies a storageType of "io1" or "io2". Can only be set when `storageType` is `"io1"`, `"io2` or `"gp3"`. Cannot be specified for gp3 storage if the `allocatedStorage` value is below a per-`engine` threshold. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ iops?: pulumi.Input; /** * ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. */ kmsKeyId?: pulumi.Input; /** * License model information for this DB instance. Valid values for this field are as follows: RDS for MariaDB: `general-public-license`; RDS for Microsoft SQL Server: `license-included`; RDS for MySQL: `general-public-license`; RDS for Oracle: `bring-your-own-license | license-included`; RDS for PostgreSQL: `postgresql-license`. */ licenseModel?: pulumi.Input; /** * Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See [RDS Maintenance Window docs](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) for more information. */ maintenanceWindow?: pulumi.Input; /** * Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `password` or `passwordWo` is provided. */ manageMasterUserPassword?: pulumi.Input; /** * 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. */ masterUserSecretKmsKeyId?: pulumi.Input; /** * 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. */ maxAllocatedStorage?: pulumi.Input; /** * 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. */ monitoringInterval?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances. */ monitoringRoleArn?: pulumi.Input; /** * Whether the RDS instance is multi-AZ. */ multiAz?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html). */ ncharCharacterSetName?: pulumi.Input; /** * Network type of the DB instance. Valid values: `IPV4`, `DUAL`. */ networkType?: pulumi.Input; /** * Name of the DB option group to associate. */ optionGroupName?: pulumi.Input; /** * Name of the DB parameter group to associate. */ parameterGroupName?: pulumi.Input; /** * 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`. */ password?: pulumi.Input; /** * **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 `manageMasterUserPassword` is set to `true`. If set, requires `passwordWoVersion` to be set. */ passwordWo?: pulumi.Input; /** * Required when `passwordWo` is set. Changing this value triggers an update to `passwordWo`. */ passwordWoVersion?: pulumi.Input; /** * Whether Performance Insights are enabled. Defaults to false. */ performanceInsightsEnabled?: pulumi.Input; /** * 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. */ performanceInsightsKmsKeyId?: pulumi.Input; /** * 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'. */ performanceInsightsRetentionPeriod?: pulumi.Input; /** * Port on which the DB accepts connections. */ port?: pulumi.Input; /** * Bool to control if instance is publicly accessible. Default is `false`. */ publiclyAccessible?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Whether the replica is in either `mounted` or `open-read-only` mode. This attribute is only supported by Oracle instances. Oracle replicas operate in `open-read-only` mode unless otherwise specified. See [Working with Oracle Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) for more information. */ replicaMode?: pulumi.Input; /** * Set this to specify 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 `identifier` of the source DB, unless also specifying the `dbSubnetGroupName`. If specifying the `dbSubnetGroupName` in the same region, use the `arn` of the source DB. If replicating an Instance in a different region, use the `arn` of the source DB. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a `kmsKeyId`. See [DB Instance Replication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html) and [Working with PostgreSQL and MySQL Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) for more information on using Replication. */ replicateSourceDb?: pulumi.Input; /** * Configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See `restoreToPointInTime` Block below for details. */ restoreToPointInTime?: pulumi.Input; /** * Restore from a Percona XtraBackup in S3. See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html). See `s3Import` Block below. */ s3Import?: pulumi.Input; /** * 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 is `false`. */ skipFinalSnapshot?: pulumi.Input; /** * 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. */ snapshotIdentifier?: pulumi.Input; /** * 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 `kmsKeyId` with a valid ARN. The default is `false` if not specified. */ storageEncrypted?: pulumi.Input; /** * 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage) for details. */ storageThroughput?: pulumi.Input; /** * One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs `iops` independently) "io1" (provisioned IOPS SSD) or "io2" (block express storage provisioned IOPS SSD). The default is "io1" if `iops` is specified, "gp2" if not. */ storageType?: pulumi.Input; /** * 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. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Time zone of the DB instance. `timezone` is currently only supported by Microsoft SQL Server. The `timezone` can only be set on creation. See [MSSQL User Guide](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) for more information. */ timezone?: pulumi.Input; /** * Whether to upgrade the storage file system configuration on the read replica. Can only be set with `replicateSourceDb`. */ upgradeStorageConfig?: pulumi.Input; /** * Username for the master DB user. Cannot be specified for a replica. */ username?: pulumi.Input; /** * List of VPC security groups to associate. */ vpcSecurityGroupIds?: pulumi.Input[] | undefined>; /** * Set of RDS event categories (for example `failure`, `maintenance`) to check for after create and update operations. If set, the provider describes RDS events reported for this instance during the operation and surfaces a warning diagnostic, with the RDS event message, for each one found in these categories. Has no effect if unset; see [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) and the `aws.rds.getEvents` data source for the source of these events. Requires the `rds:DescribeEvents` IAM permission when set. */ warningEventCategories?: pulumi.Input[] | undefined>; } //# sourceMappingURL=instance.d.ts.map