Cloud.Service.AWS.DB.Instance
{
"address": "string",
"allocated_storage": 0,
"allow_major_version_upgrade": false,
"apply_immediately": false,
"arn": "string",
"auto_minor_version_upgrade": false,
"availability_zone": "string",
"backup_retention_period": 0,
"backup_window": "string",
"ca_cert_identifier": "string",
"character_set_name": "string",
"copy_tags_to_snapshot": false,
"db_subnet_group_name": "string",
"deletion_protection": false,
"domain": "string",
"domain_iam_role_name": "string",
"enabled_cloudwatch_logs_exports": [
"string"
],
"endpoint": "string",
"engine": "string",
"engine_version": "string",
"final_snapshot_identifier": "string",
"hosted_zone_id": "string",
"iam_database_authentication_enabled": false,
"identifier": "string",
"identifier_prefix": "string",
"instance_class": "string",
"iops": 0,
"kms_key_id": "string",
"license_model": "string",
"maintenance_window": "string",
"monitoring_interval": 0,
"monitoring_role_arn": "string",
"multi_az": false,
"name": "string",
"option_group_name": "string",
"parameter_group_name": "string",
"password": "string",
"port": 0,
"provider": "string",
"provider_region": "string",
"publicly_accessible": false,
"replicas": [
"string"
],
"replicate_source_db": "string",
"resource_id": "string",
"s3_import": [
{
"bucket_name": "string",
"bucket_prefix": "string",
"ingestion_role": "string",
"source_engine": "string",
"source_engine_version": "string"
}
],
"security_group_names": [
"string"
],
"skip_final_snapshot": false,
"snapshot_identifier": "string",
"status": "string",
"storage_encrypted": false,
"storage_type": "string",
"timezone": "string",
"username": "string",
"vpc_security_group_ids": [
"string"
]
}Database instance hostname. See also endpoint and port.
Gigabytes allocated for the instance. When max_allocated_storage is set, this value is the initial allocation, and differences are ignored when storage autoscaling occurs. Required unless snapshot_identifier or replicate_source_db are set.
Whether Amazon RDS may keep the instance up to date with major RDS versions.
Whether to apply database changes as soon as possible.
Amazon Resource Name (ARN) assigned by AWS to the Relational Database Service (RDS) instance.
Whether Amazon RDS may keep the instance up to date with minor RDS versions.
The instance is deployed to this availability zone within the region.
Days to retain backups. The instance must be in the AVAILABLE state for automated backups to occur.
Timestamps between which database backups may run.
Unique key of the CA certificate for database instance access authentication.
Supported character set within database records.
Whether to include instance tags when creating database snapshots. Default is false.
In the VPC environment, the subnet group designated for the instance.
Whether the instance can be deleted. Default is false, meaning it can be deleted.
Identifier of the Directory Service Active Directory domain in which to create the instance.
Name of the IAM role to use when making API calls to the directory service. Required when a domain is provided.
List of log types to export to CloudWatch logs. When omitted, no logs are exported. Valid values depend on engine: alert, audit, error, general, listener, slowquery, trace, postgresql, or upgrade.
Database instance connection endpoint in address:port format.
Database engine to deploy, such as MySQL or Oracle. Required unless snapshot_identifier or replicate_source_db are set.
Database engine version, such as MySQL 5.7 or 8.0.
Name to apply to the final database snapshot when deleting the instance.
Canonical name of the hosted zone that has the domain name to use for opening connections to the instance.
Whether to use AWS IAM to authenticate to the database.
Name of the RDS instance. Forces new resources.
Generates a unique identifier that begins with the specified prefix. Cannot be used with 'identifier'. Forces new resources.
(Required) Type of RDS instance. See the AWS lists of Standard, Memory Optimized, and Burstable Performance instance classes.
Maximum input/output operations per second that the database instance supports.
When the instance is encrypted, the ARN for the KMS key.
License for the database. Might be required for some engines such as Oracle Database Enterprise Edition.
Timestamps between which database maintenance is allowed.
Time in seconds between log collections.
ARN for the IAM role that permits log data publishing.
Whether the instance spans multiple availability zones.
Name of the database to create when the instance is created. When omitted, no database is created. See the AWS create-db-instance documentation for use with Oracle and SQL Server.
Name of the database option group to associate with this instance. An option group specifies available features.
Associate the instance with this parameter group.
Password for accessing the database. Used with username. Required unless snapshot_identifier or replicate_source_db are set.
Port on which the database accepts connections.
(Required) The name of the AWS cloud account to use for this resource
(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.
Whether the database instance is reachable over the public internet.
List of read replicas of the instance. Updates made to the source instance are asynchronously copied to the replicas.
Whether the instance is a replica of an external database.
Unique identifier assigned to the instance by AWS.
List of settings used for restoring from a Percona Xtrabackup in S3.
List of database security groups.
Whether to take a final snapshot when deleting the instance.
Name to apply to database instance snapshots other than the final one.
Health of the RDS instance.
Whether the database instance is encrypted.
Volume for database and log storage: general purpose SSD, provisioned IOPS, or magnetic.
Instance resource categorization, in case-sensitive key names, or in key-value pairs.
Time zone of the instance. Default is UTC.
Username for accessing the database. Used with password. Required unless snapshot_identifier or replicate_source_db are set.
List of VPC security groups. There must be a VPC security group that allows access to the database instance.