ClusterInstanceArgs class

The set of arguments for ClusterInstance. The set of arguments for ClusterInstance.

Constructors

ClusterInstanceArgs({Input<bool?>? applyImmediately, Input<bool?>? autoMinorVersionUpgrade, Input<String?>? availabilityZone, Input<String?>? caCertIdentifier, required Input<String> clusterIdentifier, Input<bool?>? copyTagsToSnapshot, Input<String?>? customIamInstanceProfile, Input<String?>? dbParameterGroupName, Input<String?>? dbSubnetGroupName, required Input<EngineType> engine, Input<String?>? engineVersion, Input<bool?>? forceDestroy, Input<String?>? identifier, Input<String?>? identifierPrefix, required Input instanceClass, Input<int?>? monitoringInterval, Input<String?>? monitoringRoleArn, Input<bool?>? performanceInsightsEnabled, Input<String?>? performanceInsightsKmsKeyId, Input<int?>? performanceInsightsRetentionPeriod, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<int?>? promotionTier, Input<bool?>? publiclyAccessible, Input<String?>? region, Input<Map<String, String>?>? tags})
Creates a new ClusterInstanceArgs. applyImmediately Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse. autoMinorVersionUpgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true. availabilityZone EC2 Availability Zone that the DB instance is created in. See docs about the details. caCertIdentifier Identifier of the CA certificate for the DB instance. clusterIdentifier Identifier of the aws.rds.Cluster in which to launch this instance. copyTagsToSnapshot Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false. customIamInstanceProfile Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. dbParameterGroupName Name of the DB parameter group to associate with this instance. dbSubnetGroupName Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether dbSubnetGroupName is specified. Please refer to official AWS documentation to understand how dbSubnetGroupName and publiclyAccessible parameters affect DB instance behaviour. NOTE: This must match the dbSubnetGroupName of the attached aws.rds.Cluster. engine Name of the database engine to be used for the RDS cluster instance. engineVersion Database engine version. Please note that to upgrade the engineVersion of the instance, it must be done on the aws.rds.Cluster engineVersion. Trying to upgrade in aws.rds.ClusterInstance will not update the engineVersion. forceDestroy Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion. identifier Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier. identifierPrefix Creates a unique identifier beginning with the specified prefix. Conflicts with identifier. instanceClass Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless. monitoringInterval 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 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 what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances. performanceInsightsEnabled Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration. performanceInsightsKmsKeyId ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true. 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 performanceInsightsRetentionPeriod, performanceInsightsEnabled needs to be set to true. Defaults to '7'. preferredBackupWindow Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferredBackupWindow is set at the cluster level, this argument must be omitted. preferredMaintenanceWindow Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". promotionTier Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer. publiclyAccessible Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags Map of tags to assign to the instance. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
ClusterInstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

applyImmediately → Input<bool?>?
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
final
autoMinorVersionUpgrade → Input<bool?>?
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
final
availabilityZone → Input<String?>?
EC2 Availability Zone that the DB instance is created in. See docs about the details.
final
caCertIdentifier → Input<String?>?
Identifier of the CA certificate for the DB instance.
final
clusterIdentifier → Input<String>
Identifier of the aws.rds.Cluster in which to launch this instance.
final
copyTagsToSnapshot → Input<bool?>?
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
final
customIamInstanceProfile → Input<String?>?
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
final
dbParameterGroupName → Input<String?>?
Name of the DB parameter group to associate with this instance.
final
dbSubnetGroupName → Input<String?>?
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether dbSubnetGroupName is specified. Please refer to official AWS documentation to understand how dbSubnetGroupName and publiclyAccessible parameters affect DB instance behaviour. NOTE: This must match the dbSubnetGroupName of the attached aws.rds.Cluster.
final
engine → Input<EngineType>
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).
final
engineVersion → Input<String?>?
Database engine version. Please note that to upgrade the engineVersion of the instance, it must be done on the aws.rds.Cluster engineVersion. Trying to upgrade in aws.rds.ClusterInstance will not update the engineVersion.
final
forceDestroy → Input<bool?>?
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
final
hashCode → int
The hash code for this object.
no setterinherited
identifier → Input<String?>?
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
final
identifierPrefix → Input<String?>?
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
final
instanceClass → Input
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
final
monitoringInterval → Input<int?>?
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.
final
monitoringRoleArn → Input<String?>?
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 what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
final
performanceInsightsEnabled → Input<bool?>?
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
final
performanceInsightsKmsKeyId → Input<String?>?
ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true.
final
performanceInsightsRetentionPeriod → Input<int?>?
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performanceInsightsRetentionPeriod, performanceInsightsEnabled needs to be set to true. Defaults to '7'.
final
preferredBackupWindow → Input<String?>?
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferredBackupWindow is set at the cluster level, this argument must be omitted.
final
preferredMaintenanceWindow → Input<String?>?
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
final
promotionTier → Input<int?>?
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
final
publiclyAccessible → Input<bool?>?
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
Map of tags to assign to the instance. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited