Cloud.Service.AWS.DB.Instance

Cloud.Service.AWS.DB.Instance
Cloud.Service.AWS.DB.Instance
JSON Example
{
    "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"
    ]
}
string
address
Optional

Database instance hostname. See also endpoint and port.

integer
allocated_storage
Optional

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.

boolean
allow_major_version_upgrade
Optional

Whether Amazon RDS may keep the instance up to date with major RDS versions.

boolean
apply_immediately
Optional

Whether to apply database changes as soon as possible.

string
arn
Optional

Amazon Resource Name (ARN) assigned by AWS to the Relational Database Service (RDS) instance.

boolean
auto_minor_version_upgrade
Optional

Whether Amazon RDS may keep the instance up to date with minor RDS versions.

string
availability_zone
Optional

The instance is deployed to this availability zone within the region.

integer
backup_retention_period
Optional

Days to retain backups. The instance must be in the AVAILABLE state for automated backups to occur.

string
backup_window
Optional

Timestamps between which database backups may run.

string
ca_cert_identifier
Optional

Unique key of the CA certificate for database instance access authentication.

string
character_set_name
Optional

Supported character set within database records.

boolean
copy_tags_to_snapshot
Optional

Whether to include instance tags when creating database snapshots. Default is false.

string
db_subnet_group_name
Optional

In the VPC environment, the subnet group designated for the instance.

boolean
deletion_protection
Optional

Whether the instance can be deleted. Default is false, meaning it can be deleted.

string
domain
Optional

Identifier of the Directory Service Active Directory domain in which to create the instance.

string
domain_iam_role_name
Optional

Name of the IAM role to use when making API calls to the directory service. Required when a domain is provided.

array of string
enabled_cloudwatch_logs_exports
Optional

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.

string
endpoint
Optional

Database instance connection endpoint in address:port format.

string
engine
Optional

Database engine to deploy, such as MySQL or Oracle. Required unless snapshot_identifier or replicate_source_db are set.

string
engine_version
Optional

Database engine version, such as MySQL 5.7 or 8.0.

string
final_snapshot_identifier
Optional

Name to apply to the final database snapshot when deleting the instance.

string
hosted_zone_id
Optional

Canonical name of the hosted zone that has the domain name to use for opening connections to the instance.

boolean
iam_database_authentication_enabled
Optional

Whether to use AWS IAM to authenticate to the database.

string
identifier
Optional

Name of the RDS instance. Forces new resources.

string
identifier_prefix
Optional

Generates a unique identifier that begins with the specified prefix. Cannot be used with 'identifier'. Forces new resources.

string
instance_class
Required

(Required) Type of RDS instance. See the AWS lists of Standard, Memory Optimized, and Burstable Performance instance classes.

integer
iops
Optional

Maximum input/output operations per second that the database instance supports.

string
kms_key_id
Optional

When the instance is encrypted, the ARN for the KMS key.

string
license_model
Optional

License for the database. Might be required for some engines such as Oracle Database Enterprise Edition.

string
maintenance_window
Optional

Timestamps between which database maintenance is allowed.

integer
monitoring_interval
Optional

Time in seconds between log collections.

string
monitoring_role_arn
Optional

ARN for the IAM role that permits log data publishing.

boolean
multi_az
Optional

Whether the instance spans multiple availability zones.

string
name
Optional

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.

string
option_group_name
Optional

Name of the database option group to associate with this instance. An option group specifies available features.

string
parameter_group_name
Optional

Associate the instance with this parameter group.

string
password
Optional

Password for accessing the database. Used with username. Required unless snapshot_identifier or replicate_source_db are set.

integer
port
Optional

Port on which the database accepts connections.

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 database instance is reachable over the public internet.

array of string
replicas
Optional

List of read replicas of the instance. Updates made to the source instance are asynchronously copied to the replicas.

string
replicate_source_db
Optional

Whether the instance is a replica of an external database.

string
resource_id
Optional

Unique identifier assigned to the instance by AWS.

array of object
s3_import
Optional

List of settings used for restoring from a Percona Xtrabackup in S3.

array of string
security_group_names
Optional

List of database security groups.

boolean
skip_final_snapshot
Optional

Whether to take a final snapshot when deleting the instance.

string
snapshot_identifier
Optional

Name to apply to database instance snapshots other than the final one.

string
status
Optional

Health of the RDS instance.

boolean
storage_encrypted
Optional

Whether the database instance is encrypted.

string
storage_type
Optional

Volume for database and log storage: general purpose SSD, provisioned IOPS, or magnetic.

object
tags
Optional

Instance resource categorization, in case-sensitive key names, or in key-value pairs.

string
timezone
Optional

Time zone of the instance. Default is UTC.

string
username
Optional

Username for accessing the database. Used with password. Required unless snapshot_identifier or replicate_source_db are set.

array of string
vpc_security_group_ids
Optional

List of VPC security groups. There must be a VPC security group that allows access to the database instance.