Package com.pulumi.aws.rds.inputs
Class InstanceState
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.rds.inputs.InstanceState
-
public final class InstanceState extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InstanceState.Builder
-
Field Summary
Fields Modifier and Type Field Description static InstanceState
Empty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.String>>
address()
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.String>>
arn()
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 InstanceState.Builder
builder()
static InstanceState.Builder
builder(InstanceState 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>>
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>>
endpoint()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engine()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engineVersion()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engineVersionActual()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
finalSnapshotIdentifier()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
hostedZoneId()
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()
java.util.Optional<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>>
latestRestorableTime()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
licenseModel()
java.util.Optional<com.pulumi.core.Output<java.util.List<InstanceListenerEndpointArgs>>>
listenerEndpoints()
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.util.List<InstanceMasterUserSecretArgs>>>
masterUserSecrets()
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>>
name()
Deprecated.This property has been deprecated.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.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>>
replicaMode()
java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>
replicas()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
replicateSourceDb()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
resourceId()
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.String>>
status()
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.util.Map<java.lang.String,java.lang.String>>>
tagsAll()
Deprecated.Please use `tags` instead.java.util.Optional<com.pulumi.core.Output<java.lang.String>>
timezone()
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()
-
-
-
Field Detail
-
Empty
public static final InstanceState Empty
-
-
Method Detail
-
address
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> address()
- Returns:
- Specifies the DNS address of the DB instance.
-
allocatedStorage
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()
- Returns:
- The allocated storage in gibibytes. If `max_allocated_storage` is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If `replicate_source_db` 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:
- Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
-
applyImmediately
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
- Returns:
- Specifies 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)
-
arn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
- Returns:
- The ARN of the RDS instance.
-
autoMinorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
- Returns:
- Indicates that 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:
- The AZ for the RDS instance.
-
backupRetentionPeriod
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backupRetentionPeriod()
- Returns:
- The 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][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
-
backupTarget
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> backupTarget()
- Returns:
- Specifies 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:
- The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with `maintenance_window`.
-
blueGreenUpdate
public java.util.Optional<com.pulumi.core.Output<InstanceBlueGreenUpdateArgs>> blueGreenUpdate()
- Returns:
- Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See `blue_green_update` below.
-
caCertIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()
- Returns:
- The identifier of the CA certificate for the DB instance.
-
characterSetName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> characterSetName()
- Returns:
- The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See [Oracle Character Sets Supported in Amazon RDS](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 `replicate_source_db`, `restore_to_point_in_time`, `s3_import`, or `snapshot_identifier`.
-
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:
- The 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:
- Indicates 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. > **NOTE:** Removing the `replicate_source_db` attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
-
dbName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbName()
- Returns:
- The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the [AWS documentation](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` VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. 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:
- Specifies 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:
- The ID of the Directory Service Active Directory domain to create the instance in. Conflicts with `domain_fqdn`, `domain_ou`, `domain_auth_secret_arn` and a `domain_dns_ips`.
-
domainAuthSecretArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainAuthSecretArn()
- Returns:
- The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domain_iam_role_name`.
-
domainDnsIps
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> domainDnsIps()
- Returns:
- The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with `domain` and `domain_iam_role_name`.
-
domainFqdn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainFqdn()
- Returns:
- The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domain_iam_role_name`.
-
domainIamRoleName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainIamRoleName()
- Returns:
- The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with `domain_fqdn`, `domain_ou`, `domain_auth_secret_arn` and a `domain_dns_ips`.
-
domainOu
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainOu()
- Returns:
- The self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domain_iam_role_name`.
-
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).
-
endpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
- Returns:
- The connection endpoint in `address:port` format.
-
engine
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
- Returns:
- The 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.
-
engineVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
- Returns:
- The engine version to use. If `auto_minor_version_upgrade` is enabled, you can provide a prefix of the version such as `5.7` (for `5.7.10`). The actual engine version used is returned in the attribute `engine_version_actual`, 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'.
-
engineVersionActual
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()
- Returns:
- The running version of the database.
-
finalSnapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
- Returns:
- The name of your final DB snapshot when this DB instance is deleted. Must be provided if `skip_final_snapshot` 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.
-
hostedZoneId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostedZoneId()
- Returns:
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
-
iamDatabaseAuthenticationEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> iamDatabaseAuthenticationEnabled()
- Returns:
- Specifies 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:
- The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if `restore_to_point_in_time` 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 java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>>> instanceClass()
- Returns:
- The instance type of the RDS instance.
-
iops
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> iops()
- Returns:
- The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when `storage_type` is `"io1"` or `"gp3"`. Cannot be specified for gp3 storage if the `allocated_storage` 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:
- The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
-
latestRestorableTime
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> latestRestorableTime()
- Returns:
- The 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.
-
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`
-
listenerEndpoints
public java.util.Optional<com.pulumi.core.Output<java.util.List<InstanceListenerEndpointArgs>>> listenerEndpoints()
- Returns:
- Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
-
maintenanceWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()
- Returns:
- The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See [RDS Maintenance Window docs](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` is provided.
-
masterUserSecretKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUserSecretKmsKeyId()
- Returns:
- The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
-
masterUserSecrets
public java.util.Optional<com.pulumi.core.Output<java.util.List<InstanceMasterUserSecretArgs>>> masterUserSecrets()
- Returns:
- A block that specifies the master user secret. Only available when `manage_master_user_password` is set to true. Documented below.
-
maxAllocatedStorage
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxAllocatedStorage()
- Returns:
- When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to `allocated_storage`. Must be greater than or equal to `allocated_storage` or `0` to disable Storage Autoscaling.
-
monitoringInterval
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()
- Returns:
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
-
monitoringRoleArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()
- Returns:
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the [AWS Documentation](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:
- Specifies if the RDS instance is multi-AZ
-
name
@Deprecated public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
Deprecated.This property has been deprecated. Please use 'dbName' instead.
-
ncharCharacterSetName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ncharCharacterSetName()
- Returns:
- The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See [Oracle Character Sets Supported in Amazon RDS](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:
- The 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:
- (Required unless `manage_master_user_password` is set to true or unless a `snapshot_identifier` or `replicate_source_db` is provided or `manage_master_user_password` is set.) 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 `manage_master_user_password` is set to `true`.
-
performanceInsightsEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()
- Returns:
- Specifies whether Performance Insights are enabled. Defaults to false.
-
performanceInsightsKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()
- Returns:
- The ARN for the KMS key to encrypt Performance Insights data. When specifying `performance_insights_kms_key_id`, `performance_insights_enabled` 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 `performance_insights_retention_period`, `performance_insights_enabled` needs to be set to true. Defaults to '7'.
-
port
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
- Returns:
- The 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`.
-
replicaMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicaMode()
- Returns:
- Specifies 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.
-
replicas
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> replicas()
-
replicateSourceDb
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicateSourceDb()
- Returns:
- Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the `identifier` of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a `kms_key_id`. See [DB Instance Replication][instance-replication] 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.
-
resourceId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> resourceId()
- Returns:
- The RDS Resource ID of this instance.
-
restoreToPointInTime
public java.util.Optional<com.pulumi.core.Output<InstanceRestoreToPointInTimeArgs>> restoreToPointInTime()
- Returns:
- A 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 Restore To Point In Time 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)
-
skipFinalSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()
- Returns:
- Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
-
snapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotIdentifier()
- Returns:
- Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
-
status
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
- Returns:
- The RDS instance status.
-
storageEncrypted
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> storageEncrypted()
- Returns:
- Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare `kms_key_id` 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:
- The storage throughput value for the DB instance. Can only be set when `storage_type` is `"gp3"`. Cannot be specified if the `allocated_storage` 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) or "io1" (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:
- A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
@Deprecated public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tagsAll()
Deprecated.Please use `tags` instead.- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
-
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.
-
username
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> username()
- Returns:
- (Required unless a `snapshot_identifier` or `replicate_source_db` is provided) 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.
-
builder
public static InstanceState.Builder builder()
-
builder
public static InstanceState.Builder builder(InstanceState defaults)
-
-