Cloud.Service.AWS.RDS.Cluster.Instance

JSON Example

{
    "apply_immediately": false,
    "arn": "string",
    "auto_minor_version_upgrade": false,
    "availability_zone": "string",
    "cluster_identifier": "string",
    "db_parameter_group_name": "string",
    "db_subnet_group_name": "string",
    "dbi_resource_id": "string",
    "endpoint": "string",
    "engine": "string",
    "engine_version": "string",
    "identifier": "string",
    "identifier_prefix": "string",
    "instance_class": "string",
    "kms_key_id": "string",
    "monitoring_interval": 0,
    "monitoring_role_arn": "string",
    "performance_insights_enabled": false,
    "performance_insights_kms_key_id": "string",
    "port": 0,
    "preferred_backup_window": "string",
    "preferred_maintenance_window": "string",
    "promotion_tier": 0,
    "provider": "string",
    "provider_region": "string",
    "publicly_accessible": false,
    "storage_encrypted": false,
    "writer": false
}

boolean

apply_immediately

Optional

Whether database modifications are applied immediately or during the next maintenance window. Default is false (next window).

string

arn

Optional

Amazon Resource Name (ARN) assigned by AWS to the cluster instance.

boolean

auto_minor_version_upgrade

Optional

Whether to automatically apply minor database engine upgrades during the maintenance window. Default is true.

string

availability_zone

Optional

EC2 availability zone that will host the instance.

string

cluster_identifier

Required

(Required) Name of the aws_rds_cluster in which to launch this instance.

string

db_parameter_group_name

Optional

Database parameter group to associate with this instance.

string

db_subnet_group_name

Optional

Database subnet group to associate with this database instance. Required only if publicly_accessible is false.This value must match the db_subnet_group_name of the attached aws_rds_cluster.

string

dbi_resource_id

Optional

Region-unique, permanent identifier for the instance.

string

endpoint

Optional

The DNS address of the RDS instance. Not writable.

string

engine

Optional

RDS instance database engine of aurora, aurora-mysql, or aurora-postgresql for this cluster. Default is aurora.

string

engine_version

Optional

Version of the engine used for the database cluster instance.

string As ^(?!.*-$)(?!.*--)(?![0-9-])[0-9a-z-]+$

identifier

Optional

User-assigned identifier for the instance. If omitted, Cloud Assembly assigns a random, unique identifier. Cannot be used with identifier_prefix. Forces new resources.

string As ^(?!.*--)(?![0-9-])[0-9a-z-]+$

identifier_prefix

Optional

User-assigned prefix added to the automatic, Cloud Assembly identifier. Cannot be used with identifer. Forces new resources.

string

instance_class

Required

(Required) Database instance class that determines computation and memory capacity.

string

kms_key_id

Optional

ARN of the KMS encryption key if one is set for the cluster.

integer

monitoring_interval

Optional

Time, in seconds, between each Enhanced Monitoring metrics collection. Valid values are 0, 1, 5, 10, 15, 30, or 60. Default is 0 (no collection).

string

monitoring_role_arn

Optional

ARN for the IAM role with permission to send monitoring metrics.

boolean

performance_insights_enabled

Optional

Whether the Amazon RDS Performance Insights API is enabled.

string

performance_insights_kms_key_id

Optional

ARN for the KMS key to encrypt Performance Insights data. The performance_insights_enabled property must be true.

integer

port

Optional

Port on which the database accepts connections.

string

preferred_backup_window

Optional

Daily time range, in UTC, during which automated backups are created, provided that backups are enabled.

string

preferred_maintenance_window

Optional

Weekly time range, in UTC, during which system maintenance can occur. For example: Wed:04:00-Wed:04:30

integer

promotion_tier

Optional

Failover priority setting at the instance level. Default is 0. A low-tier read instance has higher priority to be promoted to a write instance.

string

provider

Required

(Required) The name of the AWS cloud account to use for this resource

string

provider_region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

boolean

publicly_accessible

Optional

Whether the instance is publicly accessible.

boolean

storage_encrypted

Optional

Whether the database cluster is encrypted.

object