Package com.pulumi.aws.rds
Class InstanceArgs.Builder
- java.lang.Object
-
- com.pulumi.aws.rds.InstanceArgs.Builder
-
- Enclosing class:
- InstanceArgs
public static final class InstanceArgs.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
Builder(InstanceArgs defaults)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InstanceArgs.Builder
allocatedStorage(com.pulumi.core.Output<java.lang.Integer> allocatedStorage)
InstanceArgs.Builder
allocatedStorage(java.lang.Integer allocatedStorage)
InstanceArgs.Builder
allowMajorVersionUpgrade(com.pulumi.core.Output<java.lang.Boolean> allowMajorVersionUpgrade)
InstanceArgs.Builder
allowMajorVersionUpgrade(java.lang.Boolean allowMajorVersionUpgrade)
InstanceArgs.Builder
applyImmediately(com.pulumi.core.Output<java.lang.Boolean> applyImmediately)
InstanceArgs.Builder
applyImmediately(java.lang.Boolean applyImmediately)
InstanceArgs.Builder
autoMinorVersionUpgrade(com.pulumi.core.Output<java.lang.Boolean> autoMinorVersionUpgrade)
InstanceArgs.Builder
autoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
InstanceArgs.Builder
availabilityZone(com.pulumi.core.Output<java.lang.String> availabilityZone)
InstanceArgs.Builder
availabilityZone(java.lang.String availabilityZone)
InstanceArgs.Builder
backupRetentionPeriod(com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod)
InstanceArgs.Builder
backupRetentionPeriod(java.lang.Integer backupRetentionPeriod)
InstanceArgs.Builder
backupTarget(com.pulumi.core.Output<java.lang.String> backupTarget)
InstanceArgs.Builder
backupTarget(java.lang.String backupTarget)
InstanceArgs.Builder
backupWindow(com.pulumi.core.Output<java.lang.String> backupWindow)
InstanceArgs.Builder
backupWindow(java.lang.String backupWindow)
InstanceArgs.Builder
blueGreenUpdate(InstanceBlueGreenUpdateArgs blueGreenUpdate)
InstanceArgs.Builder
blueGreenUpdate(com.pulumi.core.Output<InstanceBlueGreenUpdateArgs> blueGreenUpdate)
InstanceArgs
build()
InstanceArgs.Builder
caCertIdentifier(com.pulumi.core.Output<java.lang.String> caCertIdentifier)
InstanceArgs.Builder
caCertIdentifier(java.lang.String caCertIdentifier)
InstanceArgs.Builder
characterSetName(com.pulumi.core.Output<java.lang.String> characterSetName)
InstanceArgs.Builder
characterSetName(java.lang.String characterSetName)
InstanceArgs.Builder
copyTagsToSnapshot(com.pulumi.core.Output<java.lang.Boolean> copyTagsToSnapshot)
InstanceArgs.Builder
copyTagsToSnapshot(java.lang.Boolean copyTagsToSnapshot)
InstanceArgs.Builder
customerOwnedIpEnabled(com.pulumi.core.Output<java.lang.Boolean> customerOwnedIpEnabled)
InstanceArgs.Builder
customerOwnedIpEnabled(java.lang.Boolean customerOwnedIpEnabled)
InstanceArgs.Builder
customIamInstanceProfile(com.pulumi.core.Output<java.lang.String> customIamInstanceProfile)
InstanceArgs.Builder
customIamInstanceProfile(java.lang.String customIamInstanceProfile)
InstanceArgs.Builder
dbName(com.pulumi.core.Output<java.lang.String> dbName)
InstanceArgs.Builder
dbName(java.lang.String dbName)
InstanceArgs.Builder
dbSubnetGroupName(com.pulumi.core.Output<java.lang.String> dbSubnetGroupName)
InstanceArgs.Builder
dbSubnetGroupName(java.lang.String dbSubnetGroupName)
InstanceArgs.Builder
dedicatedLogVolume(com.pulumi.core.Output<java.lang.Boolean> dedicatedLogVolume)
InstanceArgs.Builder
dedicatedLogVolume(java.lang.Boolean dedicatedLogVolume)
InstanceArgs.Builder
deleteAutomatedBackups(com.pulumi.core.Output<java.lang.Boolean> deleteAutomatedBackups)
InstanceArgs.Builder
deleteAutomatedBackups(java.lang.Boolean deleteAutomatedBackups)
InstanceArgs.Builder
deletionProtection(com.pulumi.core.Output<java.lang.Boolean> deletionProtection)
InstanceArgs.Builder
deletionProtection(java.lang.Boolean deletionProtection)
InstanceArgs.Builder
domain(com.pulumi.core.Output<java.lang.String> domain)
InstanceArgs.Builder
domain(java.lang.String domain)
InstanceArgs.Builder
domainAuthSecretArn(com.pulumi.core.Output<java.lang.String> domainAuthSecretArn)
InstanceArgs.Builder
domainAuthSecretArn(java.lang.String domainAuthSecretArn)
InstanceArgs.Builder
domainDnsIps(com.pulumi.core.Output<java.util.List<java.lang.String>> domainDnsIps)
InstanceArgs.Builder
domainDnsIps(java.lang.String... domainDnsIps)
InstanceArgs.Builder
domainDnsIps(java.util.List<java.lang.String> domainDnsIps)
InstanceArgs.Builder
domainFqdn(com.pulumi.core.Output<java.lang.String> domainFqdn)
InstanceArgs.Builder
domainFqdn(java.lang.String domainFqdn)
InstanceArgs.Builder
domainIamRoleName(com.pulumi.core.Output<java.lang.String> domainIamRoleName)
InstanceArgs.Builder
domainIamRoleName(java.lang.String domainIamRoleName)
InstanceArgs.Builder
domainOu(com.pulumi.core.Output<java.lang.String> domainOu)
InstanceArgs.Builder
domainOu(java.lang.String domainOu)
InstanceArgs.Builder
enabledCloudwatchLogsExports(com.pulumi.core.Output<java.util.List<java.lang.String>> enabledCloudwatchLogsExports)
InstanceArgs.Builder
enabledCloudwatchLogsExports(java.lang.String... enabledCloudwatchLogsExports)
InstanceArgs.Builder
enabledCloudwatchLogsExports(java.util.List<java.lang.String> enabledCloudwatchLogsExports)
InstanceArgs.Builder
engine(com.pulumi.core.Output<java.lang.String> engine)
InstanceArgs.Builder
engine(java.lang.String engine)
InstanceArgs.Builder
engineVersion(com.pulumi.core.Output<java.lang.String> engineVersion)
InstanceArgs.Builder
engineVersion(java.lang.String engineVersion)
InstanceArgs.Builder
finalSnapshotIdentifier(com.pulumi.core.Output<java.lang.String> finalSnapshotIdentifier)
InstanceArgs.Builder
finalSnapshotIdentifier(java.lang.String finalSnapshotIdentifier)
InstanceArgs.Builder
iamDatabaseAuthenticationEnabled(com.pulumi.core.Output<java.lang.Boolean> iamDatabaseAuthenticationEnabled)
InstanceArgs.Builder
iamDatabaseAuthenticationEnabled(java.lang.Boolean iamDatabaseAuthenticationEnabled)
InstanceArgs.Builder
identifier(com.pulumi.core.Output<java.lang.String> identifier)
InstanceArgs.Builder
identifier(java.lang.String identifier)
InstanceArgs.Builder
identifierPrefix(com.pulumi.core.Output<java.lang.String> identifierPrefix)
InstanceArgs.Builder
identifierPrefix(java.lang.String identifierPrefix)
InstanceArgs.Builder
instanceClass(InstanceType instanceClass)
InstanceArgs.Builder
instanceClass(com.pulumi.core.Either<java.lang.String,InstanceType> instanceClass)
InstanceArgs.Builder
instanceClass(com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>> instanceClass)
InstanceArgs.Builder
instanceClass(java.lang.String instanceClass)
InstanceArgs.Builder
iops(com.pulumi.core.Output<java.lang.Integer> iops)
InstanceArgs.Builder
iops(java.lang.Integer iops)
InstanceArgs.Builder
kmsKeyId(com.pulumi.core.Output<java.lang.String> kmsKeyId)
InstanceArgs.Builder
kmsKeyId(java.lang.String kmsKeyId)
InstanceArgs.Builder
licenseModel(com.pulumi.core.Output<java.lang.String> licenseModel)
InstanceArgs.Builder
licenseModel(java.lang.String licenseModel)
InstanceArgs.Builder
maintenanceWindow(com.pulumi.core.Output<java.lang.String> maintenanceWindow)
InstanceArgs.Builder
maintenanceWindow(java.lang.String maintenanceWindow)
InstanceArgs.Builder
manageMasterUserPassword(com.pulumi.core.Output<java.lang.Boolean> manageMasterUserPassword)
InstanceArgs.Builder
manageMasterUserPassword(java.lang.Boolean manageMasterUserPassword)
InstanceArgs.Builder
masterUserSecretKmsKeyId(com.pulumi.core.Output<java.lang.String> masterUserSecretKmsKeyId)
InstanceArgs.Builder
masterUserSecretKmsKeyId(java.lang.String masterUserSecretKmsKeyId)
InstanceArgs.Builder
maxAllocatedStorage(com.pulumi.core.Output<java.lang.Integer> maxAllocatedStorage)
InstanceArgs.Builder
maxAllocatedStorage(java.lang.Integer maxAllocatedStorage)
InstanceArgs.Builder
monitoringInterval(com.pulumi.core.Output<java.lang.Integer> monitoringInterval)
InstanceArgs.Builder
monitoringInterval(java.lang.Integer monitoringInterval)
InstanceArgs.Builder
monitoringRoleArn(com.pulumi.core.Output<java.lang.String> monitoringRoleArn)
InstanceArgs.Builder
monitoringRoleArn(java.lang.String monitoringRoleArn)
InstanceArgs.Builder
multiAz(com.pulumi.core.Output<java.lang.Boolean> multiAz)
InstanceArgs.Builder
multiAz(java.lang.Boolean multiAz)
InstanceArgs.Builder
name(com.pulumi.core.Output<java.lang.String> name)
Deprecated.This property has been deprecated.InstanceArgs.Builder
name(java.lang.String name)
Deprecated.This property has been deprecated.InstanceArgs.Builder
ncharCharacterSetName(com.pulumi.core.Output<java.lang.String> ncharCharacterSetName)
InstanceArgs.Builder
ncharCharacterSetName(java.lang.String ncharCharacterSetName)
InstanceArgs.Builder
networkType(com.pulumi.core.Output<java.lang.String> networkType)
InstanceArgs.Builder
networkType(java.lang.String networkType)
InstanceArgs.Builder
optionGroupName(com.pulumi.core.Output<java.lang.String> optionGroupName)
InstanceArgs.Builder
optionGroupName(java.lang.String optionGroupName)
InstanceArgs.Builder
parameterGroupName(com.pulumi.core.Output<java.lang.String> parameterGroupName)
InstanceArgs.Builder
parameterGroupName(java.lang.String parameterGroupName)
InstanceArgs.Builder
password(com.pulumi.core.Output<java.lang.String> password)
InstanceArgs.Builder
password(java.lang.String password)
InstanceArgs.Builder
performanceInsightsEnabled(com.pulumi.core.Output<java.lang.Boolean> performanceInsightsEnabled)
InstanceArgs.Builder
performanceInsightsEnabled(java.lang.Boolean performanceInsightsEnabled)
InstanceArgs.Builder
performanceInsightsKmsKeyId(com.pulumi.core.Output<java.lang.String> performanceInsightsKmsKeyId)
InstanceArgs.Builder
performanceInsightsKmsKeyId(java.lang.String performanceInsightsKmsKeyId)
InstanceArgs.Builder
performanceInsightsRetentionPeriod(com.pulumi.core.Output<java.lang.Integer> performanceInsightsRetentionPeriod)
InstanceArgs.Builder
performanceInsightsRetentionPeriod(java.lang.Integer performanceInsightsRetentionPeriod)
InstanceArgs.Builder
port(com.pulumi.core.Output<java.lang.Integer> port)
InstanceArgs.Builder
port(java.lang.Integer port)
InstanceArgs.Builder
publiclyAccessible(com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible)
InstanceArgs.Builder
publiclyAccessible(java.lang.Boolean publiclyAccessible)
InstanceArgs.Builder
replicaMode(com.pulumi.core.Output<java.lang.String> replicaMode)
InstanceArgs.Builder
replicaMode(java.lang.String replicaMode)
InstanceArgs.Builder
replicateSourceDb(com.pulumi.core.Output<java.lang.String> replicateSourceDb)
InstanceArgs.Builder
replicateSourceDb(java.lang.String replicateSourceDb)
InstanceArgs.Builder
restoreToPointInTime(InstanceRestoreToPointInTimeArgs restoreToPointInTime)
InstanceArgs.Builder
restoreToPointInTime(com.pulumi.core.Output<InstanceRestoreToPointInTimeArgs> restoreToPointInTime)
InstanceArgs.Builder
s3Import(InstanceS3ImportArgs s3Import)
InstanceArgs.Builder
s3Import(com.pulumi.core.Output<InstanceS3ImportArgs> s3Import)
InstanceArgs.Builder
skipFinalSnapshot(com.pulumi.core.Output<java.lang.Boolean> skipFinalSnapshot)
InstanceArgs.Builder
skipFinalSnapshot(java.lang.Boolean skipFinalSnapshot)
InstanceArgs.Builder
snapshotIdentifier(com.pulumi.core.Output<java.lang.String> snapshotIdentifier)
InstanceArgs.Builder
snapshotIdentifier(java.lang.String snapshotIdentifier)
InstanceArgs.Builder
storageEncrypted(com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
InstanceArgs.Builder
storageEncrypted(java.lang.Boolean storageEncrypted)
InstanceArgs.Builder
storageThroughput(com.pulumi.core.Output<java.lang.Integer> storageThroughput)
InstanceArgs.Builder
storageThroughput(java.lang.Integer storageThroughput)
InstanceArgs.Builder
storageType(StorageType storageType)
InstanceArgs.Builder
storageType(com.pulumi.core.Either<java.lang.String,StorageType> storageType)
InstanceArgs.Builder
storageType(com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,StorageType>> storageType)
InstanceArgs.Builder
storageType(java.lang.String storageType)
InstanceArgs.Builder
tags(com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tags)
InstanceArgs.Builder
tags(java.util.Map<java.lang.String,java.lang.String> tags)
InstanceArgs.Builder
timezone(com.pulumi.core.Output<java.lang.String> timezone)
InstanceArgs.Builder
timezone(java.lang.String timezone)
InstanceArgs.Builder
username(com.pulumi.core.Output<java.lang.String> username)
InstanceArgs.Builder
username(java.lang.String username)
InstanceArgs.Builder
vpcSecurityGroupIds(com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds)
InstanceArgs.Builder
vpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
InstanceArgs.Builder
vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds)
-
-
-
Constructor Detail
-
Builder
public Builder()
-
Builder
public Builder(InstanceArgs defaults)
-
-
Method Detail
-
allocatedStorage
public InstanceArgs.Builder allocatedStorage(@Nullable com.pulumi.core.Output<java.lang.Integer> allocatedStorage)
- Parameters:
allocatedStorage
- 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.- Returns:
- builder
-
allocatedStorage
public InstanceArgs.Builder allocatedStorage(java.lang.Integer allocatedStorage)
- Parameters:
allocatedStorage
- 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.- Returns:
- builder
-
allowMajorVersionUpgrade
public InstanceArgs.Builder allowMajorVersionUpgrade(@Nullable com.pulumi.core.Output<java.lang.Boolean> allowMajorVersionUpgrade)
- Parameters:
allowMajorVersionUpgrade
- 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.- Returns:
- builder
-
allowMajorVersionUpgrade
public InstanceArgs.Builder allowMajorVersionUpgrade(java.lang.Boolean allowMajorVersionUpgrade)
- Parameters:
allowMajorVersionUpgrade
- 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.- Returns:
- builder
-
applyImmediately
public InstanceArgs.Builder applyImmediately(@Nullable com.pulumi.core.Output<java.lang.Boolean> applyImmediately)
- Parameters:
applyImmediately
- 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)- Returns:
- builder
-
applyImmediately
public InstanceArgs.Builder applyImmediately(java.lang.Boolean applyImmediately)
- Parameters:
applyImmediately
- 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)- Returns:
- builder
-
autoMinorVersionUpgrade
public InstanceArgs.Builder autoMinorVersionUpgrade(@Nullable com.pulumi.core.Output<java.lang.Boolean> autoMinorVersionUpgrade)
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.- Returns:
- builder
-
autoMinorVersionUpgrade
public InstanceArgs.Builder autoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.- Returns:
- builder
-
availabilityZone
public InstanceArgs.Builder availabilityZone(@Nullable com.pulumi.core.Output<java.lang.String> availabilityZone)
- Parameters:
availabilityZone
- The AZ for the RDS instance.- Returns:
- builder
-
availabilityZone
public InstanceArgs.Builder availabilityZone(java.lang.String availabilityZone)
- Parameters:
availabilityZone
- The AZ for the RDS instance.- Returns:
- builder
-
backupRetentionPeriod
public InstanceArgs.Builder backupRetentionPeriod(@Nullable com.pulumi.core.Output<java.lang.Integer> backupRetentionPeriod)
- Parameters:
backupRetentionPeriod
- 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].- Returns:
- builder
-
backupRetentionPeriod
public InstanceArgs.Builder backupRetentionPeriod(java.lang.Integer backupRetentionPeriod)
- Parameters:
backupRetentionPeriod
- 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].- Returns:
- builder
-
backupTarget
public InstanceArgs.Builder backupTarget(@Nullable com.pulumi.core.Output<java.lang.String> backupTarget)
- Parameters:
backupTarget
- Specifies where automated backups and manual snapshots are stored. Possible values are `region` (default) and `outposts`. See [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) for more information.- Returns:
- builder
-
backupTarget
public InstanceArgs.Builder backupTarget(java.lang.String backupTarget)
- Parameters:
backupTarget
- Specifies where automated backups and manual snapshots are stored. Possible values are `region` (default) and `outposts`. See [Working with Amazon RDS on AWS Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) for more information.- Returns:
- builder
-
backupWindow
public InstanceArgs.Builder backupWindow(@Nullable com.pulumi.core.Output<java.lang.String> backupWindow)
- Parameters:
backupWindow
- 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`.- Returns:
- builder
-
backupWindow
public InstanceArgs.Builder backupWindow(java.lang.String backupWindow)
- Parameters:
backupWindow
- 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`.- Returns:
- builder
-
blueGreenUpdate
public InstanceArgs.Builder blueGreenUpdate(@Nullable com.pulumi.core.Output<InstanceBlueGreenUpdateArgs> blueGreenUpdate)
- Parameters:
blueGreenUpdate
- Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See `blue_green_update` below.- Returns:
- builder
-
blueGreenUpdate
public InstanceArgs.Builder blueGreenUpdate(InstanceBlueGreenUpdateArgs blueGreenUpdate)
- Parameters:
blueGreenUpdate
- Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See `blue_green_update` below.- Returns:
- builder
-
caCertIdentifier
public InstanceArgs.Builder caCertIdentifier(@Nullable com.pulumi.core.Output<java.lang.String> caCertIdentifier)
- Parameters:
caCertIdentifier
- The identifier of the CA certificate for the DB instance.- Returns:
- builder
-
caCertIdentifier
public InstanceArgs.Builder caCertIdentifier(java.lang.String caCertIdentifier)
- Parameters:
caCertIdentifier
- The identifier of the CA certificate for the DB instance.- Returns:
- builder
-
characterSetName
public InstanceArgs.Builder characterSetName(@Nullable com.pulumi.core.Output<java.lang.String> characterSetName)
- Parameters:
characterSetName
- 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`.- Returns:
- builder
-
characterSetName
public InstanceArgs.Builder characterSetName(java.lang.String characterSetName)
- Parameters:
characterSetName
- 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`.- Returns:
- builder
-
copyTagsToSnapshot
public InstanceArgs.Builder copyTagsToSnapshot(@Nullable com.pulumi.core.Output<java.lang.Boolean> copyTagsToSnapshot)
- Parameters:
copyTagsToSnapshot
- Copy all Instance `tags` to snapshots. Default is `false`.- Returns:
- builder
-
copyTagsToSnapshot
public InstanceArgs.Builder copyTagsToSnapshot(java.lang.Boolean copyTagsToSnapshot)
- Parameters:
copyTagsToSnapshot
- Copy all Instance `tags` to snapshots. Default is `false`.- Returns:
- builder
-
customIamInstanceProfile
public InstanceArgs.Builder customIamInstanceProfile(@Nullable com.pulumi.core.Output<java.lang.String> customIamInstanceProfile)
- Parameters:
customIamInstanceProfile
- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.- Returns:
- builder
-
customIamInstanceProfile
public InstanceArgs.Builder customIamInstanceProfile(java.lang.String customIamInstanceProfile)
- Parameters:
customIamInstanceProfile
- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.- Returns:
- builder
-
customerOwnedIpEnabled
public InstanceArgs.Builder customerOwnedIpEnabled(@Nullable com.pulumi.core.Output<java.lang.Boolean> customerOwnedIpEnabled)
- Parameters:
customerOwnedIpEnabled
- 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.- Returns:
- builder
-
customerOwnedIpEnabled
public InstanceArgs.Builder customerOwnedIpEnabled(java.lang.Boolean customerOwnedIpEnabled)
- Parameters:
customerOwnedIpEnabled
- 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.- Returns:
- builder
-
dbName
public InstanceArgs.Builder dbName(@Nullable com.pulumi.core.Output<java.lang.String> dbName)
- Parameters:
dbName
- The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the [AWS documentation](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.- Returns:
- builder
-
dbName
public InstanceArgs.Builder dbName(java.lang.String dbName)
- Parameters:
dbName
- The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the [AWS documentation](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.- Returns:
- builder
-
dbSubnetGroupName
public InstanceArgs.Builder dbSubnetGroupName(@Nullable com.pulumi.core.Output<java.lang.String> dbSubnetGroupName)
- Parameters:
dbSubnetGroupName
- 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.- Returns:
- builder
-
dbSubnetGroupName
public InstanceArgs.Builder dbSubnetGroupName(java.lang.String dbSubnetGroupName)
- Parameters:
dbSubnetGroupName
- 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.- Returns:
- builder
-
dedicatedLogVolume
public InstanceArgs.Builder dedicatedLogVolume(@Nullable com.pulumi.core.Output<java.lang.Boolean> dedicatedLogVolume)
- Parameters:
dedicatedLogVolume
- 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.- Returns:
- builder
-
dedicatedLogVolume
public InstanceArgs.Builder dedicatedLogVolume(java.lang.Boolean dedicatedLogVolume)
- Parameters:
dedicatedLogVolume
- 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.- Returns:
- builder
-
deleteAutomatedBackups
public InstanceArgs.Builder deleteAutomatedBackups(@Nullable com.pulumi.core.Output<java.lang.Boolean> deleteAutomatedBackups)
- Parameters:
deleteAutomatedBackups
- Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is `true`.- Returns:
- builder
-
deleteAutomatedBackups
public InstanceArgs.Builder deleteAutomatedBackups(java.lang.Boolean deleteAutomatedBackups)
- Parameters:
deleteAutomatedBackups
- Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is `true`.- Returns:
- builder
-
deletionProtection
public InstanceArgs.Builder deletionProtection(@Nullable com.pulumi.core.Output<java.lang.Boolean> deletionProtection)
- Parameters:
deletionProtection
- If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.- Returns:
- builder
-
deletionProtection
public InstanceArgs.Builder deletionProtection(java.lang.Boolean deletionProtection)
- Parameters:
deletionProtection
- If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.- Returns:
- builder
-
domain
public InstanceArgs.Builder domain(@Nullable com.pulumi.core.Output<java.lang.String> domain)
- Parameters:
domain
- 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`.- Returns:
- builder
-
domain
public InstanceArgs.Builder domain(java.lang.String domain)
- Parameters:
domain
- 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`.- Returns:
- builder
-
domainAuthSecretArn
public InstanceArgs.Builder domainAuthSecretArn(@Nullable com.pulumi.core.Output<java.lang.String> domainAuthSecretArn)
- Parameters:
domainAuthSecretArn
- The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainAuthSecretArn
public InstanceArgs.Builder domainAuthSecretArn(java.lang.String domainAuthSecretArn)
- Parameters:
domainAuthSecretArn
- The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainDnsIps
public InstanceArgs.Builder domainDnsIps(@Nullable com.pulumi.core.Output<java.util.List<java.lang.String>> domainDnsIps)
- Parameters:
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainDnsIps
public InstanceArgs.Builder domainDnsIps(java.util.List<java.lang.String> domainDnsIps)
- Parameters:
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainDnsIps
public InstanceArgs.Builder domainDnsIps(java.lang.String... domainDnsIps)
- Parameters:
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainFqdn
public InstanceArgs.Builder domainFqdn(@Nullable com.pulumi.core.Output<java.lang.String> domainFqdn)
- Parameters:
domainFqdn
- The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainFqdn
public InstanceArgs.Builder domainFqdn(java.lang.String domainFqdn)
- Parameters:
domainFqdn
- The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainIamRoleName
public InstanceArgs.Builder domainIamRoleName(@Nullable com.pulumi.core.Output<java.lang.String> domainIamRoleName)
- Parameters:
domainIamRoleName
- 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`.- Returns:
- builder
-
domainIamRoleName
public InstanceArgs.Builder domainIamRoleName(java.lang.String domainIamRoleName)
- Parameters:
domainIamRoleName
- 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`.- Returns:
- builder
-
domainOu
public InstanceArgs.Builder domainOu(@Nullable com.pulumi.core.Output<java.lang.String> domainOu)
- Parameters:
domainOu
- The self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
domainOu
public InstanceArgs.Builder domainOu(java.lang.String domainOu)
- Parameters:
domainOu
- The self managed Active Directory organizational unit for your DB instance to join. Conflicts with `domain` and `domain_iam_role_name`.- Returns:
- builder
-
enabledCloudwatchLogsExports
public InstanceArgs.Builder enabledCloudwatchLogsExports(@Nullable com.pulumi.core.Output<java.util.List<java.lang.String>> enabledCloudwatchLogsExports)
- Parameters:
enabledCloudwatchLogsExports
- Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).- Returns:
- builder
-
enabledCloudwatchLogsExports
public InstanceArgs.Builder enabledCloudwatchLogsExports(java.util.List<java.lang.String> enabledCloudwatchLogsExports)
- Parameters:
enabledCloudwatchLogsExports
- Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).- Returns:
- builder
-
enabledCloudwatchLogsExports
public InstanceArgs.Builder enabledCloudwatchLogsExports(java.lang.String... enabledCloudwatchLogsExports)
- Parameters:
enabledCloudwatchLogsExports
- Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in [API action CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).- Returns:
- builder
-
engine
public InstanceArgs.Builder engine(@Nullable com.pulumi.core.Output<java.lang.String> engine)
- Parameters:
engine
- 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.- Returns:
- builder
-
engine
public InstanceArgs.Builder engine(java.lang.String engine)
- Parameters:
engine
- 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.- Returns:
- builder
-
engineVersion
public InstanceArgs.Builder engineVersion(@Nullable com.pulumi.core.Output<java.lang.String> engineVersion)
- Parameters:
engineVersion
- 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'.- Returns:
- builder
-
engineVersion
public InstanceArgs.Builder engineVersion(java.lang.String engineVersion)
- Parameters:
engineVersion
- 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'.- Returns:
- builder
-
finalSnapshotIdentifier
public InstanceArgs.Builder finalSnapshotIdentifier(@Nullable com.pulumi.core.Output<java.lang.String> finalSnapshotIdentifier)
- Parameters:
finalSnapshotIdentifier
- 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.- Returns:
- builder
-
finalSnapshotIdentifier
public InstanceArgs.Builder finalSnapshotIdentifier(java.lang.String finalSnapshotIdentifier)
- Parameters:
finalSnapshotIdentifier
- 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.- Returns:
- builder
-
iamDatabaseAuthenticationEnabled
public InstanceArgs.Builder iamDatabaseAuthenticationEnabled(@Nullable com.pulumi.core.Output<java.lang.Boolean> iamDatabaseAuthenticationEnabled)
- Parameters:
iamDatabaseAuthenticationEnabled
- Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.- Returns:
- builder
-
iamDatabaseAuthenticationEnabled
public InstanceArgs.Builder iamDatabaseAuthenticationEnabled(java.lang.Boolean iamDatabaseAuthenticationEnabled)
- Parameters:
iamDatabaseAuthenticationEnabled
- Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.- Returns:
- builder
-
identifier
public InstanceArgs.Builder identifier(@Nullable com.pulumi.core.Output<java.lang.String> identifier)
- Parameters:
identifier
- 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.- Returns:
- builder
-
identifier
public InstanceArgs.Builder identifier(java.lang.String identifier)
- Parameters:
identifier
- 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.- Returns:
- builder
-
identifierPrefix
public InstanceArgs.Builder identifierPrefix(@Nullable com.pulumi.core.Output<java.lang.String> identifierPrefix)
- Parameters:
identifierPrefix
- Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.- Returns:
- builder
-
identifierPrefix
public InstanceArgs.Builder identifierPrefix(java.lang.String identifierPrefix)
- Parameters:
identifierPrefix
- Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.- Returns:
- builder
-
instanceClass
public InstanceArgs.Builder instanceClass(com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>> instanceClass)
- Parameters:
instanceClass
- The instance type of the RDS instance.- Returns:
- builder
-
instanceClass
public InstanceArgs.Builder instanceClass(com.pulumi.core.Either<java.lang.String,InstanceType> instanceClass)
- Parameters:
instanceClass
- The instance type of the RDS instance.- Returns:
- builder
-
instanceClass
public InstanceArgs.Builder instanceClass(java.lang.String instanceClass)
- Parameters:
instanceClass
- The instance type of the RDS instance.- Returns:
- builder
-
instanceClass
public InstanceArgs.Builder instanceClass(InstanceType instanceClass)
- Parameters:
instanceClass
- The instance type of the RDS instance.- Returns:
- builder
-
iops
public InstanceArgs.Builder iops(@Nullable com.pulumi.core.Output<java.lang.Integer> iops)
- Parameters:
iops
- 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.- Returns:
- builder
-
iops
public InstanceArgs.Builder iops(java.lang.Integer iops)
- Parameters:
iops
- 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.- Returns:
- builder
-
kmsKeyId
public InstanceArgs.Builder kmsKeyId(@Nullable com.pulumi.core.Output<java.lang.String> kmsKeyId)
- Parameters:
kmsKeyId
- The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.- Returns:
- builder
-
kmsKeyId
public InstanceArgs.Builder kmsKeyId(java.lang.String kmsKeyId)
- Parameters:
kmsKeyId
- The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.- Returns:
- builder
-
licenseModel
public InstanceArgs.Builder licenseModel(@Nullable com.pulumi.core.Output<java.lang.String> licenseModel)
- Parameters:
licenseModel
- 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`- Returns:
- builder
-
licenseModel
public InstanceArgs.Builder licenseModel(java.lang.String licenseModel)
- Parameters:
licenseModel
- 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`- Returns:
- builder
-
maintenanceWindow
public InstanceArgs.Builder maintenanceWindow(@Nullable com.pulumi.core.Output<java.lang.String> maintenanceWindow)
- Parameters:
maintenanceWindow
- 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.- Returns:
- builder
-
maintenanceWindow
public InstanceArgs.Builder maintenanceWindow(java.lang.String maintenanceWindow)
- Parameters:
maintenanceWindow
- 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.- Returns:
- builder
-
manageMasterUserPassword
public InstanceArgs.Builder manageMasterUserPassword(@Nullable com.pulumi.core.Output<java.lang.Boolean> manageMasterUserPassword)
- Parameters:
manageMasterUserPassword
- Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `password` is provided.- Returns:
- builder
-
manageMasterUserPassword
public InstanceArgs.Builder manageMasterUserPassword(java.lang.Boolean manageMasterUserPassword)
- Parameters:
manageMasterUserPassword
- Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if `password` is provided.- Returns:
- builder
-
masterUserSecretKmsKeyId
public InstanceArgs.Builder masterUserSecretKmsKeyId(@Nullable com.pulumi.core.Output<java.lang.String> masterUserSecretKmsKeyId)
- Parameters:
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.- Returns:
- builder
-
masterUserSecretKmsKeyId
public InstanceArgs.Builder masterUserSecretKmsKeyId(java.lang.String masterUserSecretKmsKeyId)
- Parameters:
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.- Returns:
- builder
-
maxAllocatedStorage
public InstanceArgs.Builder maxAllocatedStorage(@Nullable com.pulumi.core.Output<java.lang.Integer> maxAllocatedStorage)
- Parameters:
maxAllocatedStorage
- 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.- Returns:
- builder
-
maxAllocatedStorage
public InstanceArgs.Builder maxAllocatedStorage(java.lang.Integer maxAllocatedStorage)
- Parameters:
maxAllocatedStorage
- 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.- Returns:
- builder
-
monitoringInterval
public InstanceArgs.Builder monitoringInterval(@Nullable com.pulumi.core.Output<java.lang.Integer> monitoringInterval)
- Parameters:
monitoringInterval
- 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.- Returns:
- builder
-
monitoringInterval
public InstanceArgs.Builder monitoringInterval(java.lang.Integer monitoringInterval)
- Parameters:
monitoringInterval
- 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.- Returns:
- builder
-
monitoringRoleArn
public InstanceArgs.Builder monitoringRoleArn(@Nullable com.pulumi.core.Output<java.lang.String> monitoringRoleArn)
- Parameters:
monitoringRoleArn
- 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.- Returns:
- builder
-
monitoringRoleArn
public InstanceArgs.Builder monitoringRoleArn(java.lang.String monitoringRoleArn)
- Parameters:
monitoringRoleArn
- 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.- Returns:
- builder
-
multiAz
public InstanceArgs.Builder multiAz(@Nullable com.pulumi.core.Output<java.lang.Boolean> multiAz)
- Parameters:
multiAz
- Specifies if the RDS instance is multi-AZ- Returns:
- builder
-
multiAz
public InstanceArgs.Builder multiAz(java.lang.Boolean multiAz)
- Parameters:
multiAz
- Specifies if the RDS instance is multi-AZ- Returns:
- builder
-
name
@Deprecated public InstanceArgs.Builder name(@Nullable com.pulumi.core.Output<java.lang.String> name)
Deprecated.This property has been deprecated. Please use 'dbName' instead.- Returns:
- builder
-
name
@Deprecated public InstanceArgs.Builder name(java.lang.String name)
Deprecated.This property has been deprecated. Please use 'dbName' instead.- Returns:
- builder
-
ncharCharacterSetName
public InstanceArgs.Builder ncharCharacterSetName(@Nullable com.pulumi.core.Output<java.lang.String> ncharCharacterSetName)
- Parameters:
ncharCharacterSetName
- The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See [Oracle Character Sets Supported in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html).- Returns:
- builder
-
ncharCharacterSetName
public InstanceArgs.Builder ncharCharacterSetName(java.lang.String ncharCharacterSetName)
- Parameters:
ncharCharacterSetName
- The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See [Oracle Character Sets Supported in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html).- Returns:
- builder
-
networkType
public InstanceArgs.Builder networkType(@Nullable com.pulumi.core.Output<java.lang.String> networkType)
- Parameters:
networkType
- The network type of the DB instance. Valid values: `IPV4`, `DUAL`.- Returns:
- builder
-
networkType
public InstanceArgs.Builder networkType(java.lang.String networkType)
- Parameters:
networkType
- The network type of the DB instance. Valid values: `IPV4`, `DUAL`.- Returns:
- builder
-
optionGroupName
public InstanceArgs.Builder optionGroupName(@Nullable com.pulumi.core.Output<java.lang.String> optionGroupName)
- Parameters:
optionGroupName
- Name of the DB option group to associate.- Returns:
- builder
-
optionGroupName
public InstanceArgs.Builder optionGroupName(java.lang.String optionGroupName)
- Parameters:
optionGroupName
- Name of the DB option group to associate.- Returns:
- builder
-
parameterGroupName
public InstanceArgs.Builder parameterGroupName(@Nullable com.pulumi.core.Output<java.lang.String> parameterGroupName)
- Parameters:
parameterGroupName
- Name of the DB parameter group to associate.- Returns:
- builder
-
parameterGroupName
public InstanceArgs.Builder parameterGroupName(java.lang.String parameterGroupName)
- Parameters:
parameterGroupName
- Name of the DB parameter group to associate.- Returns:
- builder
-
password
public InstanceArgs.Builder password(@Nullable com.pulumi.core.Output<java.lang.String> password)
- Parameters:
password
- (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`.- Returns:
- builder
-
password
public InstanceArgs.Builder password(java.lang.String password)
- Parameters:
password
- (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`.- Returns:
- builder
-
performanceInsightsEnabled
public InstanceArgs.Builder performanceInsightsEnabled(@Nullable com.pulumi.core.Output<java.lang.Boolean> performanceInsightsEnabled)
- Parameters:
performanceInsightsEnabled
- Specifies whether Performance Insights are enabled. Defaults to false.- Returns:
- builder
-
performanceInsightsEnabled
public InstanceArgs.Builder performanceInsightsEnabled(java.lang.Boolean performanceInsightsEnabled)
- Parameters:
performanceInsightsEnabled
- Specifies whether Performance Insights are enabled. Defaults to false.- Returns:
- builder
-
performanceInsightsKmsKeyId
public InstanceArgs.Builder performanceInsightsKmsKeyId(@Nullable com.pulumi.core.Output<java.lang.String> performanceInsightsKmsKeyId)
- Parameters:
performanceInsightsKmsKeyId
- 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.- Returns:
- builder
-
performanceInsightsKmsKeyId
public InstanceArgs.Builder performanceInsightsKmsKeyId(java.lang.String performanceInsightsKmsKeyId)
- Parameters:
performanceInsightsKmsKeyId
- 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.- Returns:
- builder
-
performanceInsightsRetentionPeriod
public InstanceArgs.Builder performanceInsightsRetentionPeriod(@Nullable com.pulumi.core.Output<java.lang.Integer> performanceInsightsRetentionPeriod)
- Parameters:
performanceInsightsRetentionPeriod
- Amount of time in days to retain Performance Insights data. Valid values are `7`, `731` (2 years) or a multiple of `31`. When specifying `performance_insights_retention_period`, `performance_insights_enabled` needs to be set to true. Defaults to '7'.- Returns:
- builder
-
performanceInsightsRetentionPeriod
public InstanceArgs.Builder performanceInsightsRetentionPeriod(java.lang.Integer performanceInsightsRetentionPeriod)
- Parameters:
performanceInsightsRetentionPeriod
- Amount of time in days to retain Performance Insights data. Valid values are `7`, `731` (2 years) or a multiple of `31`. When specifying `performance_insights_retention_period`, `performance_insights_enabled` needs to be set to true. Defaults to '7'.- Returns:
- builder
-
port
public InstanceArgs.Builder port(@Nullable com.pulumi.core.Output<java.lang.Integer> port)
- Parameters:
port
- The port on which the DB accepts connections.- Returns:
- builder
-
port
public InstanceArgs.Builder port(java.lang.Integer port)
- Parameters:
port
- The port on which the DB accepts connections.- Returns:
- builder
-
publiclyAccessible
public InstanceArgs.Builder publiclyAccessible(@Nullable com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible)
- Parameters:
publiclyAccessible
- Bool to control if instance is publicly accessible. Default is `false`.- Returns:
- builder
-
publiclyAccessible
public InstanceArgs.Builder publiclyAccessible(java.lang.Boolean publiclyAccessible)
- Parameters:
publiclyAccessible
- Bool to control if instance is publicly accessible. Default is `false`.- Returns:
- builder
-
replicaMode
public InstanceArgs.Builder replicaMode(@Nullable com.pulumi.core.Output<java.lang.String> replicaMode)
- Parameters:
replicaMode
- 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.- Returns:
- builder
-
replicaMode
public InstanceArgs.Builder replicaMode(java.lang.String replicaMode)
- Parameters:
replicaMode
- 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.- Returns:
- builder
-
replicateSourceDb
public InstanceArgs.Builder replicateSourceDb(@Nullable com.pulumi.core.Output<java.lang.String> replicateSourceDb)
- Parameters:
replicateSourceDb
- 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.- Returns:
- builder
-
replicateSourceDb
public InstanceArgs.Builder replicateSourceDb(java.lang.String replicateSourceDb)
- Parameters:
replicateSourceDb
- 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.- Returns:
- builder
-
restoreToPointInTime
public InstanceArgs.Builder restoreToPointInTime(@Nullable com.pulumi.core.Output<InstanceRestoreToPointInTimeArgs> restoreToPointInTime)
- Parameters:
restoreToPointInTime
- 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.- Returns:
- builder
-
restoreToPointInTime
public InstanceArgs.Builder restoreToPointInTime(InstanceRestoreToPointInTimeArgs restoreToPointInTime)
- Parameters:
restoreToPointInTime
- 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.- Returns:
- builder
-
s3Import
public InstanceArgs.Builder s3Import(@Nullable com.pulumi.core.Output<InstanceS3ImportArgs> s3Import)
- Parameters:
s3Import
- 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)- Returns:
- builder
-
s3Import
public InstanceArgs.Builder s3Import(InstanceS3ImportArgs s3Import)
- Parameters:
s3Import
- 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)- Returns:
- builder
-
skipFinalSnapshot
public InstanceArgs.Builder skipFinalSnapshot(@Nullable com.pulumi.core.Output<java.lang.Boolean> skipFinalSnapshot)
- Parameters:
skipFinalSnapshot
- 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`.- Returns:
- builder
-
skipFinalSnapshot
public InstanceArgs.Builder skipFinalSnapshot(java.lang.Boolean skipFinalSnapshot)
- Parameters:
skipFinalSnapshot
- 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`.- Returns:
- builder
-
snapshotIdentifier
public InstanceArgs.Builder snapshotIdentifier(@Nullable com.pulumi.core.Output<java.lang.String> snapshotIdentifier)
- Parameters:
snapshotIdentifier
- 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.- Returns:
- builder
-
snapshotIdentifier
public InstanceArgs.Builder snapshotIdentifier(java.lang.String snapshotIdentifier)
- Parameters:
snapshotIdentifier
- 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.- Returns:
- builder
-
storageEncrypted
public InstanceArgs.Builder storageEncrypted(@Nullable com.pulumi.core.Output<java.lang.Boolean> storageEncrypted)
- Parameters:
storageEncrypted
- 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.- Returns:
- builder
-
storageEncrypted
public InstanceArgs.Builder storageEncrypted(java.lang.Boolean storageEncrypted)
- Parameters:
storageEncrypted
- 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.- Returns:
- builder
-
storageThroughput
public InstanceArgs.Builder storageThroughput(@Nullable com.pulumi.core.Output<java.lang.Integer> storageThroughput)
- Parameters:
storageThroughput
- 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.- Returns:
- builder
-
storageThroughput
public InstanceArgs.Builder storageThroughput(java.lang.Integer storageThroughput)
- Parameters:
storageThroughput
- 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.- Returns:
- builder
-
storageType
public InstanceArgs.Builder storageType(@Nullable com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,StorageType>> storageType)
- Parameters:
storageType
- 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.- Returns:
- builder
-
storageType
public InstanceArgs.Builder storageType(com.pulumi.core.Either<java.lang.String,StorageType> storageType)
- Parameters:
storageType
- 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.- Returns:
- builder
-
storageType
public InstanceArgs.Builder storageType(java.lang.String storageType)
- Parameters:
storageType
- 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.- Returns:
- builder
-
storageType
public InstanceArgs.Builder storageType(StorageType storageType)
- Parameters:
storageType
- 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.- Returns:
- builder
-
tags
public InstanceArgs.Builder tags(@Nullable com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tags)
- Parameters:
tags
- 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.- Returns:
- builder
-
tags
public InstanceArgs.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)
- Parameters:
tags
- 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.- Returns:
- builder
-
timezone
public InstanceArgs.Builder timezone(@Nullable com.pulumi.core.Output<java.lang.String> timezone)
- Parameters:
timezone
- 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.- Returns:
- builder
-
timezone
public InstanceArgs.Builder timezone(java.lang.String timezone)
- Parameters:
timezone
- 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.- Returns:
- builder
-
username
public InstanceArgs.Builder username(@Nullable com.pulumi.core.Output<java.lang.String> username)
- Parameters:
username
- (Required unless a `snapshot_identifier` or `replicate_source_db` is provided) Username for the master DB user. Cannot be specified for a replica.- Returns:
- builder
-
username
public InstanceArgs.Builder username(java.lang.String username)
- Parameters:
username
- (Required unless a `snapshot_identifier` or `replicate_source_db` is provided) Username for the master DB user. Cannot be specified for a replica.- Returns:
- builder
-
vpcSecurityGroupIds
public InstanceArgs.Builder vpcSecurityGroupIds(@Nullable com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds)
- Parameters:
vpcSecurityGroupIds
- List of VPC security groups to associate.- Returns:
- builder
-
vpcSecurityGroupIds
public InstanceArgs.Builder vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds)
- Parameters:
vpcSecurityGroupIds
- List of VPC security groups to associate.- Returns:
- builder
-
vpcSecurityGroupIds
public InstanceArgs.Builder vpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
- Parameters:
vpcSecurityGroupIds
- List of VPC security groups to associate.- Returns:
- builder
-
build
public InstanceArgs build()
-
-