Package com.pulumi.aws.rds.inputs
Class ClusterInstanceState
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.rds.inputs.ClusterInstanceState
-
public final class ClusterInstanceState extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClusterInstanceState.Builder
-
Field Summary
Fields Modifier and Type Field Description static ClusterInstanceState
Empty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
applyImmediately()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
arn()
java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
autoMinorVersionUpgrade()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
availabilityZone()
static ClusterInstanceState.Builder
builder()
static ClusterInstanceState.Builder
builder(ClusterInstanceState defaults)
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
caCertIdentifier()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
clusterIdentifier()
java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
copyTagsToSnapshot()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
customIamInstanceProfile()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
dbiResourceId()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
dbParameterGroupName()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
dbSubnetGroupName()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
endpoint()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engine()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engineVersion()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
engineVersionActual()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
identifier()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
identifierPrefix()
java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>>>
instanceClass()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>
kmsKeyId()
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.Integer>>
promotionTier()
java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
publiclyAccessible()
java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
storageEncrypted()
java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>
tags()
java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>
tagsAll()
Deprecated.Please use `tags` instead.java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>
writer()
-
-
-
Field Detail
-
Empty
public static final ClusterInstanceState Empty
-
-
Method Detail
-
applyImmediately
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
- Returns:
- Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`.
-
arn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
- Returns:
- Amazon Resource Name (ARN) of cluster instance
-
autoMinorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
- Returns:
- Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.
-
availabilityZone
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
- Returns:
- EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details.
-
caCertIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertIdentifier()
- Returns:
- Identifier of the CA certificate for the DB instance.
-
clusterIdentifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
- Returns:
- Identifier of the `aws.rds.Cluster` in which to launch this instance.
-
copyTagsToSnapshot
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> copyTagsToSnapshot()
- Returns:
- Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`.
-
customIamInstanceProfile
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customIamInstanceProfile()
- Returns:
- Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
-
dbParameterGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbParameterGroupName()
- Returns:
- Name of the DB parameter group to associate with this instance.
-
dbSubnetGroupName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbSubnetGroupName()
- Returns:
- Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether `db_subnet_group_name` is specified. Please refer to official [AWS documentation](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) to understand how `db_subnet_group_name` and `publicly_accessible` parameters affect DB instance behaviour. **NOTE:** This must match the `db_subnet_group_name` of the attached `aws.rds.Cluster`.
-
dbiResourceId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbiResourceId()
- Returns:
- Region-unique, immutable identifier for the DB instance.
-
endpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
- Returns:
- DNS address for this instance. May not be writable
-
engine
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
- Returns:
- Name of the database engine to be used for the RDS cluster instance. Valid Values: `aurora-mysql`, `aurora-postgresql`, `mysql`, `postgres`.(Note that `mysql` and `postgres` are Multi-AZ RDS clusters).
-
engineVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
- Returns:
- Database engine version. Please note that to upgrade the `engine_version` of the instance, it must be done on the `aws.rds.Cluster` `engine_version`. Trying to upgrade in `aws_cluster_instance` will not update the `engine_version`.
-
engineVersionActual
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersionActual()
- Returns:
- Database engine version
-
identifier
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifier()
- Returns:
- Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
-
identifierPrefix
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identifierPrefix()
- Returns:
- Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
-
instanceClass
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,InstanceType>>> instanceClass()
- Returns:
- Instance class to use. For details on CPU and memory, see [Scaling Aurora DB Instances](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html). Aurora uses `db.*` instance classes/types. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) for currently available instance classes and complete details. For Aurora Serverless v2 use `db.serverless`.
-
kmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
- Returns:
- ARN for the KMS encryption key if one is set to the cluster.
-
monitoringInterval
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> monitoringInterval()
- Returns:
- Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
-
monitoringRoleArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> monitoringRoleArn()
- Returns:
- ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the [AWS Documentation](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
-
networkType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
- Returns:
- Network type of the DB instance.
-
performanceInsightsEnabled
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> performanceInsightsEnabled()
- Returns:
- Specifies whether Performance Insights is enabled or not.
-
performanceInsightsKmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> performanceInsightsKmsKeyId()
- Returns:
- ARN for the KMS key to encrypt Performance Insights data. When specifying `performance_insights_kms_key_id`, `performance_insights_enabled` needs to be set to true.
-
performanceInsightsRetentionPeriod
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> performanceInsightsRetentionPeriod()
- Returns:
- Amount of time in days to retain Performance Insights data. Valid values are `7`, `731` (2 years) or a multiple of `31`. When specifying `performance_insights_retention_period`, `performance_insights_enabled` needs to be set to true. Defaults to '7'.
-
port
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
- Returns:
- Database port
-
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. Eg: "04:00-09:00". **NOTE:** If `preferred_backup_window` is set at the cluster level, this argument **must** be omitted.
-
preferredMaintenanceWindow
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()
- Returns:
- Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
-
promotionTier
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> promotionTier()
- Returns:
- Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
-
publiclyAccessible
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
- Returns:
- Bool to control if instance is publicly accessible. Default `false`. See the documentation on [Creating DB Instances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) for more details on controlling this property.
-
storageEncrypted
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> storageEncrypted()
- Returns:
- Specifies whether the DB cluster is encrypted.
-
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 instance. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
@Deprecated public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tagsAll()
Deprecated.Please use `tags` instead.- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
-
writer
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> writer()
- Returns:
- Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.
-
builder
public static ClusterInstanceState.Builder builder()
-
builder
public static ClusterInstanceState.Builder builder(ClusterInstanceState defaults)
-
-