Package com.pulumi.aws.rds
Class InstanceArgs
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.rds.InstanceArgs
-
public final class InstanceArgs extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classInstanceArgs.Builder
-
Field Summary
Fields Modifier and Type Field Description static InstanceArgsEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>allocatedStorage()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>allowMajorVersionUpgrade()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>applyImmediately()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>autoMinorVersionUpgrade()java.util.Optional<com.pulumi.core.Output<java.lang.String>>availabilityZone()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>backupRetentionPeriod()java.util.Optional<com.pulumi.core.Output<java.lang.String>>backupTarget()java.util.Optional<com.pulumi.core.Output<java.lang.String>>backupWindow()java.util.Optional<com.pulumi.core.Output<InstanceBlueGreenUpdateArgs>>blueGreenUpdate()static InstanceArgs.Builderbuilder()static InstanceArgs.Builderbuilder(InstanceArgs defaults)java.util.Optional<com.pulumi.core.Output<java.lang.String>>caCertIdentifier()java.util.Optional<com.pulumi.core.Output<java.lang.String>>characterSetName()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>copyTagsToSnapshot()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>customerOwnedIpEnabled()java.util.Optional<com.pulumi.core.Output<java.lang.String>>customIamInstanceProfile()java.util.Optional<com.pulumi.core.Output<java.lang.String>>databaseInsightsMode()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbSubnetGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>dedicatedLogVolume()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>deleteAutomatedBackups()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>deletionProtection()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domain()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainAuthSecretArn()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>domainDnsIps()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainFqdn()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainIamRoleName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainOu()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>enabledCloudwatchLogsExports()java.util.Optional<com.pulumi.core.Output<java.lang.String>>engine()java.util.Optional<com.pulumi.core.Output<java.lang.String>>engineLifecycleSupport()java.util.Optional<com.pulumi.core.Output<java.lang.String>>engineVersion()java.util.Optional<com.pulumi.core.Output<java.lang.String>>finalSnapshotIdentifier()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>iamDatabaseAuthenticationEnabled()java.util.Optional<com.pulumi.core.Output<java.lang.String>>identifier()java.util.Optional<com.pulumi.core.Output<java.lang.String>>identifierPrefix()com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>>instanceClass()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>iops()java.util.Optional<com.pulumi.core.Output<java.lang.String>>kmsKeyId()java.util.Optional<com.pulumi.core.Output<java.lang.String>>licenseModel()java.util.Optional<com.pulumi.core.Output<java.lang.String>>maintenanceWindow()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>manageMasterUserPassword()java.util.Optional<com.pulumi.core.Output<java.lang.String>>masterUserSecretKmsKeyId()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>maxAllocatedStorage()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>monitoringInterval()java.util.Optional<com.pulumi.core.Output<java.lang.String>>monitoringRoleArn()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>multiAz()java.util.Optional<com.pulumi.core.Output<java.lang.String>>ncharCharacterSetName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>networkType()java.util.Optional<com.pulumi.core.Output<java.lang.String>>optionGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>parameterGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>password()java.util.Optional<com.pulumi.core.Output<java.lang.String>>passwordWo()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>passwordWoVersion()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>performanceInsightsEnabled()java.util.Optional<com.pulumi.core.Output<java.lang.String>>performanceInsightsKmsKeyId()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>performanceInsightsRetentionPeriod()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>port()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>publiclyAccessible()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<java.lang.String>>replicaMode()java.util.Optional<com.pulumi.core.Output<java.lang.String>>replicateSourceDb()java.util.Optional<com.pulumi.core.Output<InstanceRestoreToPointInTimeArgs>>restoreToPointInTime()java.util.Optional<com.pulumi.core.Output<InstanceS3ImportArgs>>s3Import()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>skipFinalSnapshot()java.util.Optional<com.pulumi.core.Output<java.lang.String>>snapshotIdentifier()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>storageEncrypted()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>storageThroughput()java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,StorageType>>>storageType()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tags()java.util.Optional<com.pulumi.core.Output<java.lang.String>>timezone()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>upgradeStorageConfig()java.util.Optional<com.pulumi.core.Output<java.lang.String>>username()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>vpcSecurityGroupIds()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>warningEventCategories()
-
-
-
Field Detail
-
Empty
public static final InstanceArgs Empty
-
-
Method Detail
-
allocatedStorage
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowMajorVersionUpgrade()
- Returns:
- 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.
-
applyImmediately
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
- Returns:
- 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)
-
autoMinorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
- Returns:
- Whether minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
-
availabilityZone
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
- Returns:
- AZ for the RDS instance.
-
backupRetentionPeriod
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backupRetentionPeriod()
- Returns:
- 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).
-
backupTarget
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> backupTarget()
- Returns:
- 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.
-
backupWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> backupWindow()
- Returns:
- 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`.
-
blueGreenUpdate
public java.util.Optional<com.pulumi.core.Output<InstanceBlueGreenUpdateArgs>> blueGreenUpdate()
- Returns:
- 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.
-
caCertIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()
- Returns:
- Identifier of the CA certificate for the DB instance.
-
characterSetName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> characterSetName()
- Returns:
- 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`.
-
copyTagsToSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()
- Returns:
- Copy all Instance `tags` to snapshots. Default is `false`.
-
customIamInstanceProfile
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customIamInstanceProfile()
- Returns:
- Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
-
customerOwnedIpEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> customerOwnedIpEnabled()
- Returns:
- 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.
-
databaseInsightsMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> databaseInsightsMode()
- Returns:
- Mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` .
-
dbName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbName()
- Returns:
- 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.
-
dbSubnetGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()
- Returns:
- 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.
-
dedicatedLogVolume
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> dedicatedLogVolume()
- Returns:
- 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.
-
deleteAutomatedBackups
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deleteAutomatedBackups()
- Returns:
- Whether to remove automated backups immediately after the DB instance is deleted. Default is `true`.
-
deletionProtection
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deletionProtection()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domain()
- Returns:
- ID of the Directory Service Active Directory domain to create the instance in. Conflicts with `domainFqdn`, `domainOu`, `domainAuthSecretArn` and a `domainDnsIps`.
-
domainAuthSecretArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainAuthSecretArn()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> domainDnsIps()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainFqdn()
- Returns:
- Fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domainIamRoleName`.
-
domainIamRoleName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainIamRoleName()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainOu()
- Returns:
- Self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domainIamRoleName`.
-
enabledCloudwatchLogsExports
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> enabledCloudwatchLogsExports()
- Returns:
- 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).
-
engine
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
- Returns:
- 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.
-
engineLifecycleSupport
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineLifecycleSupport()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
- Returns:
- 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'.
-
finalSnapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
- Returns:
- 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.
-
iamDatabaseAuthenticationEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> iamDatabaseAuthenticationEnabled()
- Returns:
- Whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
-
identifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifier()
- Returns:
- Name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if `restoreToPointInTime` is specified.
-
identifierPrefix
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifierPrefix()
- Returns:
- Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
-
instanceClass
public com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>> instanceClass()
- Returns:
- Instance type of the RDS instance.
-
iops
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> iops()
- Returns:
- 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.
-
kmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
- Returns:
- ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
-
licenseModel
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> licenseModel()
- Returns:
- 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`.
-
maintenanceWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()
- Returns:
- 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.
-
manageMasterUserPassword
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> manageMasterUserPassword()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUserSecretKmsKeyId()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxAllocatedStorage()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()
- Returns:
- 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.
-
monitoringRoleArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()
- Returns:
- 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.
-
multiAz
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiAz()
- Returns:
- Whether the RDS instance is multi-AZ.
-
ncharCharacterSetName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ncharCharacterSetName()
- Returns:
- 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).
-
networkType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
- Returns:
- Network type of the DB instance. Valid values: `IPV4`, `DUAL`.
-
optionGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> optionGroupName()
- Returns:
- Name of the DB option group to associate.
-
parameterGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterGroupName()
- Returns:
- Name of the DB parameter group to associate.
-
password
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> passwordWo()
- Returns:
- **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. Cannot be set if `manageMasterUserPassword` is set to `true`. If set, requires `passwordWoVersion` to be set.
-
passwordWoVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> passwordWoVersion()
- Returns:
- Required when `passwordWo` is set. Changing this value triggers an update to `passwordWo`.
-
performanceInsightsEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()
- Returns:
- Whether Performance Insights are enabled. Defaults to false.
-
performanceInsightsKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> performanceInsightsRetentionPeriod()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
- Returns:
- Port on which the DB accepts connections.
-
publiclyAccessible
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
- Returns:
- Bool to control if instance is publicly accessible. Default is `false`.
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- 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.
-
replicaMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicaMode()
- Returns:
- 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.
-
replicateSourceDb
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicateSourceDb()
- Returns:
- 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.
-
restoreToPointInTime
public java.util.Optional<com.pulumi.core.Output<InstanceRestoreToPointInTimeArgs>> restoreToPointInTime()
- Returns:
- 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.
-
s3Import
public java.util.Optional<com.pulumi.core.Output<InstanceS3ImportArgs>> s3Import()
- Returns:
- 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.
-
skipFinalSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()
- Returns:
- 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`.
-
snapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotIdentifier()
- Returns:
- 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.
-
storageEncrypted
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> storageEncrypted()
- Returns:
- 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.
-
storageThroughput
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> storageThroughput()
- Returns:
- 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.
-
storageType
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,StorageType>>> storageType()
- Returns:
- 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.
-
tags
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> timezone()
- Returns:
- 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.
-
upgradeStorageConfig
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> upgradeStorageConfig()
- Returns:
- Whether to upgrade the storage file system configuration on the read replica. Can only be set with `replicateSourceDb`.
-
username
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> username()
- Returns:
- Username for the master DB user. Cannot be specified for a replica.
-
vpcSecurityGroupIds
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
- Returns:
- List of VPC security groups to associate.
-
warningEventCategories
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> warningEventCategories()
- Returns:
- 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.
-
builder
public static InstanceArgs.Builder builder()
-
builder
public static InstanceArgs.Builder builder(InstanceArgs defaults)
-
-