DBInstance (rds.services.k8s.aws/v1alpha1)

Type: object

DBInstance is the Schema for the DBInstances API

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

DBInstanceSpec defines the desired state of DBInstance.

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance,
CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,
PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Type: integerFormat: int64

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster
volumes automatically grow as the amount of data in your database increases,
though you are only charged for the space that you use in an Aurora cluster
volume.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40
    to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 40 to 65536
    for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

RDS for Db2

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to
    65536.

RDS for MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
    to 65536.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to
    65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
    to 65536.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to
    65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
    to 65536.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to
    65536.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

RDS for PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
    to 65536.

  • Provisioned IOPS storage (io1, io2): Must be an integer from 100 to
    65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

RDS for SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions:
    Must be an integer from 20 to 16384. Web and Express editions: Must be
    an integer from 20 to 16384.

  • Provisioned IOPS storage (io1, io2): Enterprise and Standard editions:
    Must be an integer from 100 to 16384. Web and Express editions: Must be
    an integer from 100 to 16384.

  • Magnetic storage (standard): Enterprise and Standard editions: Must
    be an integer from 20 to 1024. Web and Express editions: Must be an integer
    from 20 to 1024.

Type: boolean

Specifies whether minor engine upgrades are applied automatically to the
DB instance during the maintenance window. By default, minor engine upgrades
are applied automatically.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade
to false.

Type: string

The Availability Zone (AZ) where the database will be created. For information
on Amazon Web Services Regions and Availability Zones, see Regions and Availability
Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in
three separate Availability Zones. Specify one of these Availability Zones.
Aurora automatically chooses an appropriate Availability Zone if you don't
specify one.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon
Web Services Region.

Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance
    is a Multi-AZ deployment.

  • The specified Availability Zone must be in the same Amazon Web Services
    Region as the current endpoint.

Example: us-east-1d

Type: integerFormat: int64

The number of days for which automated backups are retained. Setting this
parameter to a positive number enables backups. Setting this parameter to
0 disables automated backups.

This setting doesn't apply to Amazon Aurora DB instances. The retention period
for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35.

  • Can't be set to 0 if the DB instance is a source to read replicas.

  • Can't be set to 0 for an RDS Custom for Oracle DB instance.

Type: string

The location for storing automated backups and manual snapshots.

Valid Values:

  • outposts (Amazon Web Services Outposts)

  • region (Amazon Web Services Region)

Default: region

For more information, see Working with Amazon RDS on Amazon Web Services
Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
in the Amazon RDS User Guide.

Type: string

The CA certificate identifier to use for the DB instance's server certificate.

This setting doesn't apply to RDS Custom DB instances.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)
in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to
a DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)
in the Amazon Aurora User Guide.

Type: string

For supported engines, the character set (CharacterSet) to associate the
DB instance with.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora - The character set is managed by the DB cluster. For
    more information, see CreateDBCluster.

  • RDS Custom - However, if you need to change the character set, you can
    change it on the database itself.

Type: boolean

Specifies whether to copy tags from the DB instance to snapshots of the DB
instance. By default, tags are not copied.

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to
snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting.

Type: string

The instance profile associated with the underlying Amazon EC2 instance of
an RDS Custom DB instance.

This setting is required for RDS Custom.

Constraints:

  • The profile must exist in your account.

  • The profile must have an IAM role that Amazon EC2 has permissions to
    assume.

  • The instance profile name and the associated IAM role name must start
    with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM
and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)
in the Amazon RDS User Guide.

Type: string

Specifies the mode of Database Insights to enable for the instance.

Type: string

The identifier of the DB cluster that this DB instance will belong to.

This setting doesn't apply to RDS Custom DB instances.

Type: string

The identifier for the Multi-AZ DB cluster snapshot to restore from.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
in the Amazon RDS User Guide.

Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.

  • Can't be specified when DBSnapshotIdentifier is specified.

  • Must be specified when DBSnapshotIdentifier isn't specified.

  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot,
    the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.

  • Can't be the identifier of an Aurora DB cluster snapshot.

Type: string

The compute and memory capacity of the DB instance, for example db.m5.large.
Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines. For the full list of DB instance classes, and
availability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)
in the Amazon Aurora User Guide.

Type: string

The identifier for this DB instance. This parameter is stored as a lowercase
string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Type: string

The meaning of this parameter differs according to the database engine you
use.

Amazon Aurora MySQL

The name of the database to create when the primary DB instance of the Aurora
MySQL DB cluster is created. If this parameter isn't specified for an Aurora
MySQL DB cluster, no database is created in the DB cluster.

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0-9).

  • Can't be a word reserved by the database engine.

Amazon Aurora PostgreSQL

The name of the database to create when the primary DB instance of the Aurora
PostgreSQL DB cluster is created. A database named postgres is always created.
If this parameter is specified, an additional database with this name is
created.

Constraints:

  • It must contain 1 to 63 alphanumeric characters.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0 to 9).

  • Can't be a word reserved by the database engine.

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you
don't specify a value, the default value is ORCL for non-CDBs and RDSCDB
for CDBs.

Default: ORCL

Constraints:

  • Must contain 1 to 8 alphanumeric characters.

  • Must contain a letter.

  • Can't be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

RDS for Db2

The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance. In
some cases, we recommend that you don't add a database name. For more information,
see Additional considerations (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations)
in the Amazon RDS User Guide.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0-9).

  • Can't be a word reserved by the specified database engine.

RDS for MariaDB

The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0-9).

  • Can't be a word reserved by the specified database engine.

RDS for MySQL

The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0-9).

  • Can't be a word reserved by the specified database engine.

RDS for Oracle

The Oracle System ID (SID) of the created DB instance. If you don't specify
a value, the default value is ORCL. You can't specify the string null, or
any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters.

RDS for PostgreSQL

The name of the database to create when the DB instance is created. A database
named postgres is always created. If this parameter is specified, an additional
database with this name is created.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores,
    or digits (0-9).

  • Can't be a word reserved by the specified database engine.

RDS for SQL Server

Not applicable. Must be null.

Type: string

The name of the DB parameter group to associate with this DB instance. If
you don't specify a value, then Amazon RDS uses the default DB parameter
group for the specified DB engine and version.

This setting doesn't apply to RDS Custom DB instances.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: string

Type: string

The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DB snapshot.

  • Can't be specified when DBClusterSnapshotIdentifier is specified.

  • Must be specified when DBClusterSnapshotIdentifier isn't specified.

  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
    must be the ARN of the shared DB snapshot.

Type: string

A DB subnet group to associate with this DB instance.

Constraints:

  • Must match the name of an existing DB subnet group.

Example: mydbsubnetgroup

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: string

Type: string

Type: boolean

Specifies whether the DB instance has deletion protection enabled. The database
can't be deleted when deletion protection is enabled. By default, deletion
protection isn't enabled. For more information, see Deleting a DB Instance
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).

This setting doesn't apply to Amazon Aurora DB instances. You can enable
or disable deletion protection for the DB cluster. For more information,
see CreateDBCluster. DB instances in a DB cluster can be deleted even when
deletion protection is enabled for the DB cluster.

Type: string

DestinationRegion is used for presigning the request to a given region.

Type: string

The Active Directory directory ID to create the DB instance in. Currently,
you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL
DB instances in an Active Directory Domain.

For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
in the Amazon RDS User Guide.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)

  • RDS Custom

Type: string

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)

  • RDS Custom

Type: array of string

The list of log types to enable for exporting to CloudWatch Logs. For more
information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERLogAccess.html#USERLogAccess.Procedural.UploadtoCloudWatch)
in the Amazon RDS User Guide.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

  • RDS Custom

The following values are valid for each DB engine:

  • RDS for Db2 - diag.log | notify.log

  • RDS for MariaDB - audit | error | general | slowquery

  • RDS for Microsoft SQL Server - agent | error

  • RDS for MySQL - audit | error | general | slowquery

  • RDS for Oracle - alert | audit | listener | trace | oemagent

  • RDS for PostgreSQL - postgresql | upgrade

No Additional Items

Each item of this array must be:

Type: boolean

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS
on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost
subnets through your on-premises network. For some use cases, a CoIP can
provide lower latency for connections to the DB instance from outside of
its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on
Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)
in the Amazon Web Services Outposts User Guide.

Type: boolean

Specifies whether to enable mapping of Amazon Web Services Identity and Access
Management (IAM) accounts to database accounts. By default, mapping isn't
enabled.

For more information, see IAM Database Authentication for MySQL and PostgreSQL
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
in the Amazon RDS User Guide.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (Mapping Amazon Web Services IAM accounts to database
    accounts is managed by the DB cluster.)

  • RDS Custom

Type: string

The database engine to use for this DB instance.

Not every database engine is available in every Amazon Web Services Region.

Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)

  • aurora-postgresql (for Aurora PostgreSQL DB instances)

  • custom-oracle-ee (for RDS Custom for Oracle DB instances)

  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

  • custom-oracle-se2 (for RDS Custom for Oracle DB instances)

  • custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances)

  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

  • custom-sqlserver-dev (for RDS Custom for SQL Server DB instances)

  • db2-ae

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Type: string

The version number of the database engine to use.

This setting doesn't apply to Amazon Aurora DB instances. The version number
of the database engine the DB instance uses is managed by the DB cluster.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

The following are the database engines and links to information about the
major and minor versions that are available with Amazon RDS. Not every database
engine is available for every Amazon Web Services Region.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting
is required for RDS Custom for Oracle. The CEV name has the following format:
19.customizedstring. A valid CEV name is 19.mycev1. For more information,
see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create)
in the Amazon RDS User Guide.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html)
in the Amazon RDS User Guide.

RDS for Db2

For information, see Db2 on Amazon RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt)
in the Amazon RDS User Guide.

RDS for MariaDB

For information, see MariaDB on Amazon RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)
in the Amazon RDS User Guide.

RDS for Microsoft SQL Server

For information, see Microsoft SQL Server versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)
in the Amazon RDS User Guide.

RDS for MySQL

For information, see MySQL on Amazon RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
in the Amazon RDS User Guide.

RDS for Oracle

For information, see Oracle Database Engine release notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html)
in the Amazon RDS User Guide.

RDS for PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
in the Amazon RDS User Guide.

Type: integerFormat: int64

The amount of Provisioned IOPS (input/output operations per second) to initially
allocate for the DB instance. For information about valid IOPS values, see
Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)
in the Amazon RDS User Guide.

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed
by the DB cluster.

Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
    multiple between .5 and 50 of the storage amount for the DB instance.

  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the
    storage amount for the DB instance.

Type: string

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
Web Services account, specify the key ARN or alias ARN.

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web
Services KMS key identifier is managed by the DB cluster. For more information,
see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS uses your default KMS key. There is a default
KMS key for your Amazon Web Services account. Your Amazon Web Services account
has a different default KMS key for each Amazon Web Services Region.

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS
engines, if you leave this parameter empty while enabling StorageEncrypted,
the engine uses the default KMS key. However, RDS Custom doesn't use the
default key when this parameter is empty. You must explicitly specify a key.

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: string

Type: string

Type: string

The license model information for this DB instance.

License models for RDS for Db2 require additional configuration. The Bring
Your Own License (BYOL) model requires a custom parameter group and an Amazon
Web Services License Manager self-managed license. The Db2 license through
Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace
subscription. For more information, see Amazon RDS for Db2 licensing options
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html)
in the Amazon RDS User Guide.

The default for RDS for Db2 is bring-your-own-license.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Valid Values:

  • RDS for Db2 - bring-your-own-license | marketplace-license

  • RDS for MariaDB - general-public-license

  • RDS for Microsoft SQL Server - license-included

  • RDS for MySQL - general-public-license

  • RDS for Oracle - bring-your-own-license | license-included

  • RDS for PostgreSQL - postgresql-license

Type: boolean

Specifies whether to manage the master user password with Amazon Web Services
Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets
Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)
in the Amazon RDS User Guide.

Constraints:

  • Can't manage the master user password with Amazon Web Services Secrets
    Manager if MasterUserPassword is specified.

Type: object

The password for the master user.

This setting doesn't apply to Amazon Aurora DB instances. The password for
the master user is managed by the DB cluster.

Constraints:

  • Can't be specified if ManageMasterUserPassword is turned on.

  • Can include any printable ASCII character except "/", """, or "@". For
    RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes)
    character.

Length Constraints:

  • RDS for Db2 - Must contain from 8 to 255 characters.

  • RDS for MariaDB - Must contain from 8 to 41 characters.

  • RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

  • RDS for MySQL - Must contain from 8 to 41 characters.

  • RDS for Oracle - Must contain from 8 to 30 characters.

  • RDS for PostgreSQL - Must contain from 8 to 128 characters.

Type: string

Key is the key within the secret

Type: string

name is unique within a namespace to reference a secret resource.

Type: string

namespace defines the space within which the secret name must be unique.

Type: string

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically
generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS
in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key. To use a KMS key in a different Amazon
Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon
Web Services account, then you can't use the aws/secretsmanager KMS key to
encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon
Web Services account has a different default KMS key for each Amazon Web
Services Region.

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: string

The name for the master user.

This setting doesn't apply to Amazon Aurora DB instances. The name for the
master user is managed by the DB cluster.

This setting is required for RDS DB instances.

Constraints:

  • Must be 1 to 16 letters, numbers, or underscores.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Type: integerFormat: int64

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically
scale the storage of the DB instance.

For more information about this setting, including limitations that apply
to it, see Managing capacity automatically with Amazon RDS storage autoscaling
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERPIOPS.StorageTypes.html#USERPIOPS.Autoscaling)
in the Amazon RDS User Guide.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)

  • RDS Custom

Type: integerFormat: int64

The interval, in seconds, between points when Enhanced Monitoring metrics
are collected for the DB instance. To disable collection of Enhanced Monitoring
metrics, specify 0.

If MonitoringRoleArn is specified, then you must set MonitoringInterval to
a value other than 0.

This setting doesn't apply to RDS Custom DB instances.

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

Type: string

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics
to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.
For information on creating a monitoring role, see Setting Up and Enabling
Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERMonitoring.OS.html#USERMonitoring.OS.Enabling)
in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply
a MonitoringRoleArn value.

This setting doesn't apply to RDS Custom DB instances.

Type: boolean

Specifies whether the DB instance is a Multi-AZ deployment. You can't set
the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the
    DB cluster.)

  • RDS Custom

Type: string

The name of the NCHAR character set for the Oracle DB instance.

This setting doesn't apply to RDS Custom DB instances.

Type: string

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB
instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4
and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
in the Amazon RDS User Guide.

Valid Values: IPV4 | DUAL

Type: string

The option group to associate the DB instance with.

Permanent options, such as the TDE option for Oracle Advanced Security TDE,
can't be removed from an option group. Also, that option group can't be removed
from a DB instance after it is associated with a DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Type: boolean

Specifies whether to enable Performance Insights for the DB instance. For
more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom DB instances.

Type: string

The Amazon Web Services KMS key identifier for encryption of Performance
Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon
RDS uses your default KMS key. There is a default KMS key for your Amazon
Web Services account. Your Amazon Web Services account has a different default
KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom DB instances.

Type: integerFormat: int64

The number of days to retain Performance Insights data.

This setting doesn't apply to RDS Custom DB instances.

Valid Values:

  • 7

  • month * 31, where month is a number of months from 1-23. Examples: 93
    (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

  • 731

Default: 7 days

If you specify a retention period that isn't valid, such as 94, Amazon RDS
returns an error.

Type: integerFormat: int64

The port number on which the database accepts connections.

This setting doesn't apply to Aurora DB instances. The port number is managed
by the cluster.

Valid Values: 1150-65535

Default:

  • RDS for Db2 - 50000

  • RDS for MariaDB - 3306

  • RDS for Microsoft SQL Server - 1433

  • RDS for MySQL - 3306

  • RDS for Oracle - 1521

  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260,
    3343, 3389, 47001, or 49152-49156.

Type: string

When you are creating a read replica from one Amazon Web Services GovCloud
(US) Region to another or from one China Amazon Web Services Region to another,
the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica
API operation in the source Amazon Web Services Region that contains the
source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and
China Amazon Web Services Regions. It's ignored in other Amazon Web Services
Regions.

This setting applies only when replicating from a source DB instance. Source
DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions
and China Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica
from another Amazon Web Services Region by using the Amazon RDS API. Don't
specify PreSignedUrl when you are creating an encrypted read replica in the
same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API operation that can run in the source Amazon Web Services Region that
contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted
    read replica is created in. This Amazon Web Services Region is the same
    one where the CreateDBInstanceReadReplica operation is called that contains
    this presigned URL. For example, if you create an encrypted DB instance
    in the us-west-1 Amazon Web Services Region, from a source DB instance
    in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica
    operation in the us-east-1 Amazon Web Services Region and provide a presigned
    URL that contains a call to the CreateDBInstanceReadReplica operation
    in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion
    in the presigned URL must be set to the us-east-1 Amazon Web Services
    Region.

  • KmsKeyId - The KMS key identifier for the key to use to encrypt the
    read replica in the destination Amazon Web Services Region. This is the
    same identifier for both the CreateDBInstanceReadReplica operation that
    is called in the destination Amazon Web Services Region, and the operation
    contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted
    DB instance to be replicated. This identifier must be in the Amazon Resource
    Name (ARN) format for the source Amazon Web Services Region. For example,
    if you are creating an encrypted read replica from a DB instance in the
    us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier
    looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating
Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

If you are using an Amazon Web Services SDK tool or the CLI, you can specify
SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
manually. Specifying SourceRegion autogenerates a presigned URL that is a
valid request for the operation that can run in the source Amazon Web Services
Region.

This setting doesn't apply to RDS Custom DB instances.

Type: string

The daily time range during which automated backups are created if automated
backups are enabled, using the BackupRetentionPeriod parameter. The default
is a 30-minute window selected at random from an 8-hour block of time for
each Amazon Web Services Region. For more information, see Backup window
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERWorkingWithAutomatedBackups.html#USERWorkingWithAutomatedBackups.BackupWindow)
in the Amazon RDS User Guide.

This setting doesn't apply to Amazon Aurora DB instances. The daily time
range for creating automated backups is managed by the DB cluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Type: string

The time range each week during which system maintenance can occur. For more
information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
in the Amazon RDS User Guide.

The default is a 30-minute window selected at random from an 8-hour block
of time for each Amazon Web Services Region, occurring on a random day of
the week.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • The day values must be mon | tue | wed | thu | fri | sat | sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

Type: array of object

The number of CPU cores and the number of threads per core for the DB instance
class of the DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

No Additional Items

Each item of this array must be:

Type: object

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the
Name parameter. To specify the number of threads per core, use the threadsPerCore
feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance
when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by
calling the DescribeOrderableDBInstanceOptions action and specifying the
instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor
information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values
only if the following conditions are met:

  • You are accessing an Oracle DB instance.

  • Your Oracle DB instance class supports configuring the number of CPU
    cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the processor for a DB instance class
in RDS for Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)
in the Amazon RDS User Guide.

Type: integerFormat: int64

The order of priority in which an Aurora Replica is promoted to the primary
instance after a failure of the existing primary instance. For more information,
see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance)
in the Amazon Aurora User Guide.

This setting doesn't apply to RDS Custom DB instances.

Default: 1

Valid Values: 0 - 15

Type: boolean

Specifies whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside
of the DB instance's virtual private cloud (VPC), its Domain Name System
(DNS) endpoint resolves to the public IP address. When you connect from within
the same VPC as the DB instance, the endpoint resolves to the private IP
address. Access to the DB instance is ultimately controlled by the security
group it uses. That public access is not permitted if the security group
assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance
with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway
    attached to it, the DB instance is private.

  • If the default VPC in the target Region has an internet gateway attached
    to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified,
the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway
    attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an internet gateway attached
    to it, the DB instance is public.

Type: string

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Database Enterprise Edition. The
main use case for mounted replicas is cross-Region disaster recovery. The
primary database doesn't use Active Data Guard to transmit information to
the mounted replica. Because it doesn't accept user connections, a mounted
replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the
same primary DB instance. For more information, see Working with Oracle Read
Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
in the Amazon RDS User Guide.

For RDS Custom, you must specify this parameter and set it to mounted. The
value won't be set by default. After replica creation, you can manage the
open mode manually.

Type: string

The identifier of the DB instance that will act as the source for the read
replica. Each DB instance can have up to 15 read replicas, with the exception
of Oracle and SQL Server, which can have up to five.

Constraints:

  • Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL,
    or SQL Server DB instance.

  • Can't be specified if the SourceDBClusterIdentifier parameter is also
    specified.

  • For the limitations of Oracle read replicas, see Version and licensing
    considerations for RDS for Oracle replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses)
    in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read replica limitations
    with SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations)
    in the Amazon RDS User Guide.

  • The specified DB instance must have automatic backups enabled, that
    is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region
    as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region
    from the read replica, specify a valid DB instance ARN. For more information,
    see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERTagging.ARN.html#USERTagging.ARN.Constructing)
    in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS
    Custom, which don't support cross-Region replicas.

Type: string

SourceRegion is the source region where the resource exists. This is not
sent over the wire and is only used for presigning. This value should always
have the same region as the source ARN.

Type: boolean

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

For RDS Custom DB instances, either enable this setting or leave it unset.
Otherwise, Amazon RDS reports an error.

This setting doesn't apply to Amazon Aurora DB instances. The encryption
for DB instances is managed by the DB cluster.

Type: integerFormat: int64

The storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Type: string

The storage type to associate with the DB instance.

If you specify io1, io2, or gp3, you must also include a value for the Iops
parameter.

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed
by the DB cluster.

Valid Values: gp2 | gp3 | io1 | io2 | standard

Default: io1, if the Iops parameter is specified. Otherwise, gp2.

Type: array of object

Tags to assign to the DB instance.

No Additional Items

Each item of this array must be:

Type: object

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USERTagging.html)
in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER
Tagging.html)
in the Amazon Aurora User Guide.

Type: string

Type: string

Type: string

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Type: string

The password for the given ARN from the key store in order to access the
device.

This setting doesn't apply to RDS Custom DB instances.

Type: string

The time zone of the DB instance. The time zone parameter is currently supported
only by RDS for Db2 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone)
and RDS for SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).

Type: boolean

Specifies whether the DB instance class of the DB instance uses its default
processor features.

This setting doesn't apply to RDS Custom.

Type: array of string

A list of Amazon EC2 VPC security groups to associate with this DB instance.

This setting doesn't apply to Amazon Aurora DB instances. The associated
list of EC2 VPC security groups is managed by the DB cluster.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

No Additional Items

Each item of this array must be:

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: object

DBInstanceStatus defines the observed state of DBInstance

Type: object

All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource

Type: string

ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an "adopted" resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR's Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270

Type: string

OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.

Type: string

Partition is the AWS partition in which the resource exists or will exist

Type: string

Region is the AWS region in which the resource exists or will exist.

Type: boolean

Indicates whether engine-native audit fields are included in the database
activity stream.

Type: string

The Amazon Web Services KMS key identifier used for encrypting messages in
the database activity stream. The Amazon Web Services KMS key identifier
is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Type: string

The name of the Amazon Kinesis data stream used for the database activity
stream.

Type: string

The mode of the database activity stream. Database events such as a change
or access generate an activity stream event. RDS for Oracle always handles
these events asynchronously.

Type: string

The status of the policy state of the activity stream.

Type: string

The status of the database activity stream.

Type: array of object

The Amazon Web Services Identity and Access Management (IAM) roles associated
with the DB instance.

No Additional Items

Each item of this array must be:

Type: object

Information about an Amazon Web Services Identity and Access Management (IAM)
role that is associated with a DB instance.

Type: stringFormat: date-time

The time when a stopped DB instance is restarted automatically.

Type: string

The automation mode of the RDS Custom DB instance: full or all paused. If
full, the DB instance automates monitoring and instance recovery. If all
paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

Type: string

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
Backup.

Type: object

The details of the DB instance's server certificate.

Type: stringFormat: date-time

Type: array of object

All CRs managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource

No Additional Items

Each item of this array must be:

Type: object

Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource

Type: stringFormat: date-time

Last time the condition transitioned from one status to another.

Type: string

A human readable message indicating details about the transition.

Type: string

The reason for the condition's last transition.

Type: string

Status of the condition, one of True, False, Unknown.

Type: string

Type is the type of the Condition

Type: boolean

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS
on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost
subnets through your on-premises network. For some use cases, a CoIP can
provide lower latency for connections to the DB instance from outside of
its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on
Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)
in the Amazon Web Services Outposts User Guide.

Type: array of object

The list of replicated automated backups associated with the DB instance.

No Additional Items

Each item of this array must be:

Type: object

Automated backups of a DB instance replicated to another Amazon Web Services
Region. They consist of system backups, transaction logs, and database instance
properties.

Type: integerFormat: int64

The port that the DB instance listens on. If the DB instance is part of a
DB cluster, this can be a different port than the DB cluster port.

Type: string

The current state of this database.

For information about DB instance statuses, see Viewing DB instance status
(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status)
in the Amazon RDS User Guide.

Type: array of object

The list of DB parameter groups applied to this DB instance.

No Additional Items

Each item of this array must be:

Type: object

The status of the DB parameter group.

This data type is used as a response element in the following actions:

  • CreateDBInstance

  • CreateDBInstanceReadReplica

  • DeleteDBInstance

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

Type: object

Information about the subnet group associated with the DB instance, including
the name, description, and subnets in the subnet group.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This data type is used as a response element for the DescribeDBSubnetGroups
operation.

Type: object

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data
type.

Type: object

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web
Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)
in the Amazon RDS User Guide.

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: string

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle
SID is also the name of the CDB. This setting is only valid for RDS Custom
DB instances.

Type: string

The Amazon Web Services Region-unique, immutable identifier for the DB instance.
This identifier is found in Amazon Web Services CloudTrail log entries whenever
the Amazon Web Services KMS key for the DB instance is accessed.

Type: array of object

The Active Directory Domain membership records associated with the DB instance.

No Additional Items

Each item of this array must be:

Type: object

An Active Directory Domain membership record associated with the DB instance
or cluster.

Type: array of string

A list of log types that this DB instance is configured to export to CloudWatch
Logs.

Log types vary by DB engine. For information about the log types for each
DB engine, see Monitoring Amazon RDS log files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html)
in the Amazon RDS User Guide.

No Additional Items

Each item of this array must be:

Type: object

The connection endpoint for the DB instance.

The endpoint might not be shown for instances with the status of creating.

Type: string

Type: string

Type: integerFormat: int64

Type: string

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that
receives the Enhanced Monitoring metrics data for the DB instance.

Type: boolean

Indicates whether mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled for the DB instance.

For a list of engine versions that support IAM database authentication, see
IAM database authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDSFeaRegionsDB-eng.Feature.IamDatabaseAuthentication.html)
in the Amazon RDS User Guide and IAM database authentication in Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora
FeaRegionsDB-eng.Feature.IAMdbauth.html)
in the Amazon Aurora User Guide.

Type: stringFormat: date-time

The date and time when the DB instance was created.

Type: stringFormat: date-time

The latest time to which a database in this DB instance can be restored with
point-in-time restore.

Type: object

The listener connection endpoint for SQL Server Always On.

Type: string

Type: integerFormat: int64

Type: object

The secret managed by RDS in Amazon Web Services Secrets Manager for the
master user password.

For more information, see Password management with Amazon Web Services Secrets
Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)
in the Amazon RDS User Guide.

Type: string

Type: string

Type: array of object

The list of option group memberships for this DB instance.

No Additional Items

Each item of this array must be:

Type: object

Provides information on the option groups the DB instance is a member of.

Type: object

Information about pending changes to the DB instance. This information is
returned only when there are pending changes. Specific changes are identified
by subelements.

Type: integerFormat: int64

Type: integerFormat: int64

Type: integerFormat: int64

Type: object

A list of the log types whose configuration is still pending. In other words,
these log types are in the process of being activated or deactivated.

Type: integerFormat: int64

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the
Name parameter. To specify the number of threads per core, use the threadsPerCore
feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance
when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by
calling the DescribeOrderableDBInstanceOptions action and specifying the
instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor
information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values
only if the following conditions are met:

  • You are accessing an Oracle DB instance.

  • Your Oracle DB instance class supports configuring the number of CPU
    cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the processor for a DB instance class
in RDS for Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)
in the Amazon RDS User Guide.

Type: stringFormat: date-time

Type: integerFormat: int64

Type: array of string

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated
as a read replica. For example, when you create an Aurora read replica of
an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora
read replica is shown. This output doesn't contain information about cross-Region
Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

No Additional Items

Each item of this array must be:

Type: array of string

The identifiers of the read replicas associated with this DB instance.

No Additional Items

Each item of this array must be:

Type: string

The identifier of the source DB cluster if this DB instance is a read replica.

Type: string

The identifier of the source DB instance if this DB instance is a read replica.

Type: stringFormat: date-time

The number of minutes to pause the automation. When the time period ends,
RDS Custom resumes full automation. The minimum value is 60 (default). The
maximum value is 1,440.

Type: string

If present, specifies the name of the secondary Availability Zone for a DB
instance with multi-AZ support.

Type: array of object

The status of a read replica. If the DB instance isn't a read replica, the
value is blank.

No Additional Items

Each item of this array must be:

Type: object

Provides a list of status information for a DB instance.

Type: array of object

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

No Additional Items

Each item of this array must be:

Type: object

This data type is used as a response element for queries on VPC security
group membership.