DBClusterList is a list of DBCluster
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
List of dbclusters. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
No Additional ItemsDBCluster is the Schema for the DBClusters API
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
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
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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: stringCreationTimestamp 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
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.
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
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.
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
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: stringManagedFields 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 ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
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.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
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.
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 creationTimestampName 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
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
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 ItemsOwnerReference 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.
API version of the referent.
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.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
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
DBClusterSpec defines the desired state of DBCluster.
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element
in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in
the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with
two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
in the Amazon RDS User Guide.
A list of Availability Zones (AZs) where you specifically want to create
DB instances in the DB cluster.
For information on AZs, see Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones)
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
The name of the character set (CharacterSet) to associate the DB cluster
with.
Valid for Cluster Type: Aurora DB clusters only
Specifies whether to copy all tags from the DB cluster to snapshots of the
DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Specifies the mode of Database Insights to enable for the cluster.
The identifier for this DB cluster. This parameter is stored as a lowercase
string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ
DB clusters) letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster,
for example db.m6gd.xlarge. 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 class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
The name of the DB cluster parameter group to associate with this DB cluster.
If you don't specify a value, then the default DB cluster parameter group
for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
Reserved for future use.
DestinationRegion is used for presigning the request to a given region.
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication
to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
The list of log types that need to be enabled for exporting to CloudWatch
Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, 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.
For more information about exporting CloudWatch Logs for Amazon Aurora, see
Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USERLogAccess.html#USERLogAccess.Procedural.UploadtoCloudWatch)
in the Amazon Aurora User Guide.
Specifies whether to enable this DB cluster to forward write operations to
the primary cluster of a global cluster (Aurora global database). By default,
write operations are not allowed on Aurora DB clusters that are secondary
clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an
Aurora global database. With this parameter enabled, a secondary cluster
can forward writes to the current primary cluster, and the resulting changes
are replicated back to this cluster. For the primary DB cluster of an Aurora
global database, this value is used immediately if the primary is demoted
by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
Specifies whether to enable the HTTP endpoint for the DB cluster. By default,
the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API
(RDS Data API) for running SQL queries on the DB cluster. You can also query
your database from inside the RDS console with the RDS query editor.
RDS Data API is supported with the following DB clusters:
Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
in the Amazon Aurora User Guide or IAM database authentication for MariaDB,
MySQL, and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Specifies whether to turn on Performance Insights for the DB cluster.
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.
Valid for Cluster Type: Multi-AZ DB clusters only
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
neptune - For information about using Amazon Neptune, see the Amazon
Neptune User Guide (https://docs.aws.amazon.com/neptune/latest/userguide/intro.html).
The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
Aurora Serverless v2 DB clusters use the provisioned engine mode.
For information about limitations and requirements for Serverless DB clusters,
see the following sections in the Amazon Aurora User Guide:
Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
Valid for Cluster Type: Aurora DB clusters only
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible)
and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora
MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the
following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following
command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use
the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)
in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine
versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)
in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The global cluster ID of an Aurora cluster that becomes the primary cluster
in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAPStorage.html#USERPIOPS)
in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
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.
When a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then
Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon
RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier
isn't specified, 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.
If you create a read replica of an encrypted DB cluster in another Amazon
Web Services Region, make sure to set KmsKeyId to a KMS key identifier that
is valid in the destination Amazon Web Services Region. This KMS key is used
to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
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 and Password management with Amazon Web Services
Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.
Key is the key within the secret
name is unique within a namespace to reference a secret resource.
namespace defines the space within which the secret name must be unique.
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 cluster.
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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
The interval, in seconds, between points when Enhanced Monitoring metrics
are collected for the DB cluster. To turn off collecting Enhanced Monitoring
metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value
other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is 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, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB
cluster. 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/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
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.
Valid for Cluster Type: Multi-AZ DB clusters only
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
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
issues an error.
When you are replicating a DB cluster from one Amazon Web Services GovCloud
(US) Region to another, an URL that contains a Signature Version 4 signed
request for the CreateDBCluster operation to be called in the source Amazon
Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl
only when you are performing cross-Region replication from an encrypted DB
cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation
that can run in the source Amazon Web Services Region that contains the encrypted
DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt
the copy of the DB cluster in the destination Amazon Web Services Region.
This should refer to the same KMS key for both the CreateDBCluster operation
that is called in the destination Amazon Web Services Region, and the
operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that
Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted
DB cluster to be copied. This identifier must be in the Amazon Resource
Name (ARN) format for the source Amazon Web Services Region. For example,
if you are copying an encrypted DB cluster from the us-west-2 Amazon Web
Services Region, then your ReplicationSourceIdentifier would look like
Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
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.
Valid for Cluster Type: Aurora DB clusters only
The daily time range during which automated backups are created if automated
backups are enabled using the BackupRetentionPeriod parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block
of time for each Amazon Web Services Region. To view the time blocks available,
see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
in the Amazon Aurora User Guide.
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.
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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. To see the time blocks available, see Adjusting the Preferred DB
Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of
the DB cluster'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 cluster, the endpoint resolves to the private IP address.
Access to the DB cluster is ultimately controlled by the security group it
uses. That public access isn't permitted if the security group assigned to
the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster
with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
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 cluster is private.
If the default VPC in the target Region has an internet gateway attached
to it, the DB cluster 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 cluster is private.
If the subnets are part of a VPC that has an internet gateway attached
to it, the DB cluster is public.
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if
this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The type of restore to be performed. You can specify one of the following
values:
full-copy - The new DB cluster is restored as a full copy of the source
DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source
DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored
as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
For DB clusters in serverless DB engine mode, the scaling properties of the
DB cluster.
Valid for Cluster Type: Aurora DB clusters only
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
in the Amazon Aurora User Guide.
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify
a DB cluster snapshot. However, you can use only the ARN to specify a DB
snapshot.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations
for Amazon Aurora DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type).
For information on storage types for Multi-AZ DB clusters, see Settings for
creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter
is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to aurora-iopt1,
the storage type is returned in the response. The storage type isn't returned
when you set it to aurora.
Specifies whether to restore the DB cluster to the latest restorable backup
time. By default, the DB cluster isn't restored to the latest restorable
backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
No Additional ItemsAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
DBClusterStatus defines the observed state of DBCluster
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
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
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
Partition is the AWS partition in which the resource exists or will exist
Region is the AWS region in which the resource exists or will exist.
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.
The name of the Amazon Kinesis data stream used for the database activity
stream.
The mode of the database activity stream. Database events such as a change
or access generate an activity stream event. The database session can handle
these events either synchronously or asynchronously.
The status of the database activity stream.
A list of the Amazon Web Services Identity and Access Management (IAM) roles
that are associated with the DB cluster. IAM roles that are associated with
a DB cluster grant permission for the DB cluster to access other Amazon Web
Services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role
that is associated with a DB cluster.
The time when a stopped DB cluster is restarted automatically.
The number of change records stored for Backtrack.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity
is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora
Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
in the Amazon Aurora User Guide.
The ID of the clone group with which the DB cluster is associated.
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
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
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
Last time the condition transitioned from one status to another.
A human readable message indicating details about the transition.
The reason for the condition's last transition.
Status of the condition, one of True, False, Unknown.
Type is the type of the Condition
Indicates whether the DB cluster is a clone of a DB cluster owned by a different
Amazon Web Services account.
The custom endpoints associated with the DB cluster.
No Additional ItemsThe list of DB instances that make up the DB cluster.
No Additional ItemsContains information about an instance that is part of a DB cluster.
The list of option group memberships for this DB cluster.
No Additional ItemsContains status information for a DB cluster option group.
The name of the DB cluster parameter group for the DB cluster.
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
This identifier is found in Amazon Web Services CloudTrail log entries whenever
the KMS key for the DB cluster is accessed.
Information about the subnet group associated with the DB cluster, including
the name, description, and subnets in the subnet group.
The Active Directory Domain membership records associated with the DB cluster.
No Additional ItemsAn Active Directory Domain membership record associated with the DB instance
or cluster.
The earliest time to which a DB cluster can be backtracked.
The earliest time to which a database can be restored with point-in-time
restore.
A list of log types that this DB cluster is configured to export to CloudWatch
Logs.
Log types vary by DB engine. For information about the log types for each
DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)
in the Amazon Aurora User Guide.
The connection endpoint for the primary instance of the DB cluster.
Indicates whether write forwarding is enabled for a secondary cluster in
an Aurora global database. Because write forwarding takes time to enable,
check the value of GlobalWriteForwardingStatus to confirm that the request
has completed before using the write forwarding feature for this cluster.
The status of write forwarding for a secondary cluster in an Aurora global
database.
The ID that Amazon Route 53 assigns when you create a hosted zone.
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API
(RDS Data API) for running SQL queries on the DB cluster. You can also query
your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
in the Amazon Aurora User Guide.
Indicates whether the mapping of Amazon Web Services Identity and Access
Management (IAM) accounts to database accounts is enabled.
The latest time to which a database can be restored with point-in-time restore.
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 and Password management with Amazon Web Services
Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)
in the Amazon Aurora User Guide.
Indicates whether the DB cluster has instances in multiple Availability Zones.
Information about pending changes to the DB cluster. This information is
returned only when there are pending changes. Specific changes are identified
by subelements.
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.
The progress of the operation as a percentage.
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Contains one or more identifiers of the read replicas associated with this
DB cluster.
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster
load-balances connections across the Aurora Replicas that are available in
a DB cluster. As clients request new connections to the reader endpoint,
Aurora distributes the connection requests among the Aurora Replicas in the
DB cluster. This functionality can help balance your read workload across
multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is
promoted to be the primary instance, your connection is dropped. To continue
sending your read workload to other Aurora Replicas in the cluster, you can
then reconnect to the reader endpoint.
The current state of this DB cluster.
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/USERTagging.html)
in the Amazon Aurora User Guide.
The list of VPC security groups that the DB cluster belongs to.
No Additional ItemsThis data type is used as a response element for queries on VPC security
group membership.
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
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.