Package com.pulumi.aws.rds.inputs
Class ClusterState
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.rds.inputs.ClusterState
-
public final class ClusterState extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classClusterState.Builder
-
Field Summary
Fields Modifier and Type Field Description static ClusterStateEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>allocatedStorage()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>allowMajorVersionUpgrade()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>applyImmediately()java.util.Optional<com.pulumi.core.Output<java.lang.String>>arn()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>autoMinorVersionUpgrade()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>availabilityZones()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>backtrackWindow()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>backupRetentionPeriod()static ClusterState.Builderbuilder()static ClusterState.Builderbuilder(ClusterState defaults)java.util.Optional<com.pulumi.core.Output<java.lang.String>>caCertificateIdentifier()java.util.Optional<com.pulumi.core.Output<java.lang.String>>caCertificateValidTill()java.util.Optional<com.pulumi.core.Output<java.lang.String>>clusterIdentifier()java.util.Optional<com.pulumi.core.Output<java.lang.String>>clusterIdentifierPrefix()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>clusterMembers()java.util.Optional<com.pulumi.core.Output<java.lang.String>>clusterResourceId()java.util.Optional<com.pulumi.core.Output<java.lang.String>>clusterScalabilityType()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>copyTagsToSnapshot()java.util.Optional<com.pulumi.core.Output<java.lang.String>>databaseInsightsMode()java.util.Optional<com.pulumi.core.Output<java.lang.String>>databaseName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbClusterInstanceClass()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbClusterParameterGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbInstanceParameterGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbSubnetGroupName()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dbSystemId()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>>domainIamRoleName()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>enabledCloudwatchLogsExports()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>enableGlobalWriteForwarding()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>enableHttpEndpoint()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>enableLocalWriteForwarding()java.util.Optional<com.pulumi.core.Output<java.lang.String>>endpoint()java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,EngineType>>>engine()java.util.Optional<com.pulumi.core.Output<java.lang.String>>engineLifecycleSupport()java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,EngineMode>>>engineMode()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>>globalClusterIdentifier()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.util.List<java.lang.String>>>iamRoles()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.Boolean>>manageMasterUserPassword()java.util.Optional<com.pulumi.core.Output<java.lang.String>>masterPassword()java.util.Optional<com.pulumi.core.Output<java.lang.String>>masterPasswordWo()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>masterPasswordWoVersion()java.util.Optional<com.pulumi.core.Output<java.lang.String>>masterUsername()java.util.Optional<com.pulumi.core.Output<java.lang.String>>masterUserSecretKmsKeyId()java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterMasterUserSecretArgs>>>masterUserSecrets()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.String>>networkType()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.String>>preferredBackupWindow()java.util.Optional<com.pulumi.core.Output<java.lang.String>>preferredMaintenanceWindow()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>publiclyAccessible()java.util.Optional<com.pulumi.core.Output<java.lang.String>>readerEndpoint()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<java.lang.String>>replicationSourceIdentifier()java.util.Optional<com.pulumi.core.Output<ClusterRestoreToPointInTimeArgs>>restoreToPointInTime()java.util.Optional<com.pulumi.core.Output<ClusterS3ImportArgs>>s3Import()java.util.Optional<com.pulumi.core.Output<ClusterScalingConfigurationArgs>>scalingConfiguration()java.util.Optional<com.pulumi.core.Output<ClusterServerlessv2ScalingConfigurationArgs>>serverlessv2ScalingConfiguration()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>>sourceRegion()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>storageEncrypted()java.util.Optional<com.pulumi.core.Output<java.lang.String>>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()java.util.Optional<com.pulumi.core.Output<java.lang.String>>upgradeRolloutOrder()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>vpcSecurityGroupIds()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>warningEventCategories()
-
-
-
Field Detail
-
Empty
public static final ClusterState Empty
-
-
Method Detail
-
allocatedStorage
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()
- Returns:
- Amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
-
allowMajorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowMajorVersionUpgrade()
- Returns:
- Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`.
-
applyImmediately
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
- Returns:
- Whether any cluster 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:
- ARN of cluster
-
autoMinorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
- Returns:
- Whether to apply minor engine upgrades automatically to the DB cluster during the maintenance window. Defaults to `true`.
-
availabilityZones
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> availabilityZones()
- Returns:
- List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the `lifecycle` configuration block `ignoreChanges` argument if necessary. A maximum of 3 AZs can be configured. **Note:** [Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) require exactly 3 Availability Zones in the DB subnet group. Aurora DB clusters can operate with fewer AZs, but RDS will still automatically assign 3 AZs as described above. **Note:** Do not set `availabilityZones` to the output of a data source such as `aws.getAvailabilityZones`, as this may be subject to change (for example, when a new AZ is added to a Region). Changing `availabilityZones` forces a replacement, which will destroy and recreate the cluster. Always use an explicit, static list of AZs.
-
backtrackWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backtrackWindow()
- Returns:
- Target backtrack window, in seconds. Only available for `aurora` and `aurora-mysql` engines currently. To disable backtracking, set this value to `0`. Defaults to `0`. Must be between `0` and `259200` (72 hours)
-
backupRetentionPeriod
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> backupRetentionPeriod()
- Returns:
- Days to retain backups for. Default `1`
-
caCertificateIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertificateIdentifier()
- Returns:
- CA certificate identifier to use for the DB cluster's server certificate.
-
caCertificateValidTill
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertificateValidTill()
- Returns:
- Expiration date of the DB instance’s server certificate
-
clusterIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
- Returns:
- Cluster identifier. If omitted, this provider will assign a random, unique identifier.
-
clusterIdentifierPrefix
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifierPrefix()
- Returns:
- Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.
-
clusterMembers
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> clusterMembers()
- Returns:
- List of RDS Instances that are a part of this cluster
-
clusterResourceId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterResourceId()
- Returns:
- RDS Cluster Resource ID
-
clusterScalabilityType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterScalabilityType()
- Returns:
- Scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation. Valid values: `limitless`, `standard`.
-
copyTagsToSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()
- Returns:
- Copy all Cluster `tags` to snapshots. Default is `false`.
-
databaseInsightsMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> databaseInsightsMode()
- Returns:
- Mode of Database Insights to enable for the DB cluster. Valid values: `standard`, `advanced`.
-
databaseName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> databaseName()
- Returns:
- Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints)
-
dbClusterInstanceClass
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbClusterInstanceClass()
- Returns:
- Compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6g.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide.
-
dbClusterParameterGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbClusterParameterGroupName()
- Returns:
- Cluster parameter group to associate with the cluster.
-
dbInstanceParameterGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbInstanceParameterGroupName()
- Returns:
- Instance parameter group to associate with all instances of the DB cluster. The `dbInstanceParameterGroupName` parameter is only valid in combination with the `allowMajorVersionUpgrade` parameter.
-
dbSubnetGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()
- Returns:
- DB subnet group to associate with this DB cluster. **NOTE:** This must match the `dbSubnetGroupName` specified on every `aws.rds.ClusterInstance` in the cluster.
-
dbSystemId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSystemId()
- Returns:
- For use with RDS Custom.
-
deleteAutomatedBackups
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deleteAutomatedBackups()
- Returns:
- Whether to remove automated backups immediately after the DB cluster is deleted. Default is `true`.
-
deletionProtection
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> deletionProtection()
- Returns:
- If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.
-
domain
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domain()
- Returns:
- ID of the Directory Service Active Directory domain to create the cluster in.
-
domainIamRoleName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainIamRoleName()
- Returns:
- Name of the IAM role to be used when making API calls to the Directory Service.
-
enableGlobalWriteForwarding
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableGlobalWriteForwarding()
- Returns:
- Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an `aws.rds.GlobalCluster`'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information.
-
enableHttpEndpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableHttpEndpoint()
- Returns:
- Enable HTTP endpoint (data API). Only valid for some combinations of `engineMode`, `engine` and `engineVersion` and only available in some regions. See the [Region and version availability](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html#data-api.regions) section of the documentation. This option also does not work with any of these options specified: `snapshotIdentifier`, `replicationSourceIdentifier`, `s3Import`.
-
enableLocalWriteForwarding
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableLocalWriteForwarding()
- Returns:
- Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher.
-
enabledCloudwatchLogsExports
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> enabledCloudwatchLogsExports()
- Returns:
- Set of log types to export to CloudWatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `iam-db-auth-error`, `instance`, `postgresql` (PostgreSQL), `slowquery`.
-
endpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
- Returns:
- DNS address of the RDS instance
-
engine
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,EngineType>>> engine()
- Returns:
- Name of the database engine to be used for this DB cluster. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`. (Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
-
engineLifecycleSupport
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineLifecycleSupport()
- Returns:
- Life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
-
engineMode
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,EngineMode>>> engineMode()
- Returns:
- Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. Specify an empty value (`""`) for no engine mode. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) for limitations when using `serverless`.
-
engineVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
- Returns:
- Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engineVersionActual`, see Attribute Reference below.
-
engineVersionActual
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()
- Returns:
- Running version of the database.
-
finalSnapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
- Returns:
- Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
-
globalClusterIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> globalClusterIdentifier()
- Returns:
- Global cluster identifier specified on `aws.rds.GlobalCluster`.
-
hostedZoneId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostedZoneId()
- Returns:
- Route53 Hosted Zone ID of the endpoint
-
iamDatabaseAuthenticationEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> iamDatabaseAuthenticationEnabled()
- Returns:
- Whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.
-
iamRoles
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> iamRoles()
- Returns:
- List of ARNs for the IAM roles to associate to the RDS Cluster.
-
iops
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> iops()
- Returns:
- Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see [Amazon RDS Provisioned IOPS storage to improve performance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
-
kmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
- Returns:
- ARN for the KMS encryption key. When specifying `kmsKeyId`, `storageEncrypted` needs to be set to true.
-
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 `masterPassword` is provided.
-
masterPassword
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPassword()
- Returns:
- Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the [RDS Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). Cannot be set if `manageMasterUserPassword` is set to `true`.
-
masterPasswordWo
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPasswordWo()
- Returns:
- **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. Password for the master DB user. Note that this may show up in logs. Please refer to the [RDS Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). Cannot be set if `manageMasterUserPassword` is set to `true`. If set, requires `masterPasswordWoVersion` to be set.
-
masterPasswordWoVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> masterPasswordWoVersion()
- Returns:
- Required when `masterPasswordWo` is set. Changing this value triggers an update to `masterPasswordWo`.
-
masterUserSecretKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUserSecretKmsKeyId()
- Returns:
- Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
-
masterUserSecrets
public java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterMasterUserSecretArgs>>> masterUserSecrets()
- Returns:
- Block that specifies the master user secret. Only available when `manageMasterUserPassword` is set to true. Documented below.
-
masterUsername
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUsername()
- Returns:
- Username for the master DB user. Please refer to the [RDS Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints). This argument does not support in-place updates and cannot be changed during a restore from snapshot.
-
monitoringInterval
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()
- Returns:
- Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
-
monitoringRoleArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()
- Returns:
- ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Clusters.
-
networkType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
- Returns:
- Network type of the cluster. Valid values: `IPV4`, `DUAL`.
-
performanceInsightsEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()
- Returns:
- Enables Performance Insights.
-
performanceInsightsKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()
- Returns:
- KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (`aws/rds`).
-
performanceInsightsRetentionPeriod
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> performanceInsightsRetentionPeriod()
- Returns:
- Amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are `7`, `month * 31` (where month is a number of months from 1-23), and `731`. See [here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.cost.html) for more information on retention periods.
-
port
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
- Returns:
- Port on which the DB accepts connections.
-
preferredBackupWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredBackupWindow()
- Returns:
- Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. `04:00-09:00`.
-
preferredMaintenanceWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()
- Returns:
- Weekly time range during which system maintenance can occur, in (UTC) e.g., `wed:04:00-wed:04:30`
-
publiclyAccessible
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
- Returns:
- Whether the DB cluster is publicly accessible. Valid only for Multi-AZ DB clusters. If not specified, defaults to `true` when `dbSubnetGroupName` is not set or is `default`, and `false` otherwise. If `true`, the VPC of the DB subnet group must have an internet gateway attached. Cannot be used with `s3Import`.
-
readerEndpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> readerEndpoint()
- Returns:
- Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
replicationSourceIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicationSourceIdentifier()
- Returns:
- ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. **Note:** Removing this attribute after creation will promote the read replica to a standalone cluster. If DB Cluster is part of a Global Cluster, use the `ignoreChanges` resource option to prevent Pulumi from showing differences for this argument instead of configuring this value.
-
restoreToPointInTime
public java.util.Optional<com.pulumi.core.Output<ClusterRestoreToPointInTimeArgs>> restoreToPointInTime()
- Returns:
- Nested attribute for [point in time restore](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-pitr.html). More details below.
-
s3Import
public java.util.Optional<com.pulumi.core.Output<ClusterS3ImportArgs>> s3Import()
-
scalingConfiguration
public java.util.Optional<com.pulumi.core.Output<ClusterScalingConfigurationArgs>> scalingConfiguration()
- Returns:
- Nested attribute with scaling properties. Only valid when `engineMode` is set to `serverless`. More details below.
-
serverlessv2ScalingConfiguration
public java.util.Optional<com.pulumi.core.Output<ClusterServerlessv2ScalingConfigurationArgs>> serverlessv2ScalingConfiguration()
- Returns:
- Nested attribute with scaling properties for ServerlessV2. Only valid when `engineMode` is set to `provisioned`. More details below.
-
skipFinalSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()
- Returns:
- Whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`.
-
snapshotIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotIdentifier()
- Returns:
- Whether to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with `globalClusterIdentifier`. Clusters cannot be restored from snapshot **and** joined to an existing global cluster in a single operation. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database.use-snapshot) or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
-
sourceRegion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceRegion()
- Returns:
- Source region for an encrypted replica DB cluster.
-
storageEncrypted
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> storageEncrypted()
- Returns:
- Whether the DB cluster is encrypted. The default is `false` for `provisioned` `engineMode` and `true` for `serverless` `engineMode`. When restoring an unencrypted `snapshotIdentifier`, the `kmsKeyId` argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
-
storageType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageType()
- Returns:
- (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, `storageType` modifications can be done in-place. For Multi-AZ DB Clusters, the `iops` argument must also be set. Valid values are: `""`, `aurora-iopt1` (Aurora DB Clusters); `io1`, `io2`, `gp3` (Multi-AZ DB Clusters). Default: `""` (Aurora DB Clusters); `io1` (Multi-AZ DB Clusters).
-
tags
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
upgradeRolloutOrder
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> upgradeRolloutOrder()
- Returns:
- Order in which the clusters are upgraded (`first`, `second`, `last`). See [the AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Maintenance.AMVU.UpgradeRollout.html) for details.
-
vpcSecurityGroupIds
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
- Returns:
- List of VPC security groups to associate with the Cluster
-
warningEventCategories
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> warningEventCategories()
- Returns:
- Set of RDS event categories (for example `failure`, `maintenance`) to check for after create and update operations. If set, the provider describes RDS events reported for this cluster during the operation and surfaces a warning diagnostic, with the RDS event message, for each one found in these categories. Has no effect if unset; see [DescribeEvents](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) and the `aws.rds.getEvents` data source for the source of these events. Requires the `rds:DescribeEvents` IAM permission when set.
-
builder
public static ClusterState.Builder builder()
-
builder
public static ClusterState.Builder builder(ClusterState defaults)
-
-