DBCluster
rds.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | rds-controller/apis/v1alpha1#DBCluster |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DBCluster |
| ListKind | DBClusterList |
| Plural | dbclusters |
| Singular | 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.
Spec
allocatedStorage: integer
autoMinorVersionUpgrade: boolean
availabilityZones:
- string
backtrackWindow: integer
backupRetentionPeriod: integer
characterSetName: string
copyTagsToSnapshot: boolean
databaseName: string
dbClusterIdentifier: string
dbClusterInstanceClass: string
dbClusterParameterGroupName: string
dbClusterParameterGroupRef:
from:
name: string
namespace: string
dbSubnetGroupName: string
dbSubnetGroupRef:
from:
name: string
namespace: string
dbSystemID: string
deletionProtection: boolean
destinationRegion: string
domain: string
domainIAMRoleName: string
enableCloudwatchLogsExports:
- string
enableGlobalWriteForwarding: boolean
enableHTTPEndpoint: boolean
enableIAMDatabaseAuthentication: boolean
enablePerformanceInsights: boolean
engine: string
engineMode: string
engineVersion: string
globalClusterIdentifier: string
iops: integer
kmsKeyID: string
kmsKeyRef:
from:
name: string
namespace: string
manageMasterUserPassword: boolean
masterUserPassword:
key: string
name: string
namespace: string
masterUserSecretKMSKeyID: string
masterUserSecretKMSKeyRef:
from:
name: string
namespace: string
masterUsername: string
monitoringInterval: integer
monitoringRoleARN: string
networkType: string
optionGroupName: string
performanceInsightsKMSKeyID: string
performanceInsightsRetentionPeriod: integer
port: integer
preSignedURL: string
preferredBackupWindow: string
preferredMaintenanceWindow: string
publiclyAccessible: boolean
replicationSourceIdentifier: string
restoreToTime: string
restoreType: string
scalingConfiguration:
autoPause: boolean
maxCapacity: integer
minCapacity: integer
secondsBeforeTimeout: integer
secondsUntilAutoPause: integer
timeoutAction: string
serverlessV2ScalingConfiguration:
maxCapacity: number
minCapacity: number
secondsUntilAutoPause: integer
snapshotIdentifier: string
sourceDBClusterIdentifier: string
sourceRegion: string
storageEncrypted: boolean
storageType: string
tags:
- key: string
value: string
useLatestRestorableTime: boolean
vpcSecurityGroupIDs:
- string
vpcSecurityGroupRefs:
from:
name: string
namespace: string
| Field | Description |
|---|---|
| allocatedStorage Optional | integer The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This setting is required to create a Multi-AZ DB cluster. |
| autoMinorVersionUpgrade Optional | boolean Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only |
| availabilityZones Optional | array 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: * Can’t specify more than three AZs. |
| availabilityZones.[] Required | string |
| backupRetentionPeriod Optional | integer The number of days for which automated backups are retained. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1 Constraints: * Must be a value from 1 to 35. |
| characterSetName Optional | string The name of the character set (CharacterSet) to associate the DB cluster with. Valid for Cluster Type: Aurora DB clusters only |
| copyTagsToSnapshot Optional | boolean 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 |
| databaseName Optional | string The name for your database of up to 64 alphanumeric characters. A database named postgres is always created. If this parameter is specified, an additional database with this name is created. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
| dbClusterIdentifier Required | string 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 |
| dbClusterInstanceClass Optional | string 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 |
| dbClusterParameterGroupName Optional | string 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: * If supplied, must match the name of an existing DB cluster parameter group. |
| dbClusterParameterGroupRef Optional | 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 |
| dbClusterParameterGroupRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| dbClusterParameterGroupRef.from.name Optional | string |
| dbClusterParameterGroupRef.from.namespace Optional | string |
| dbSubnetGroupName Optional | string A DB subnet group to associate with this DB cluster. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: * Must match the name of an existing DB subnet group. Example: mydbsubnetgroup |
| dbSubnetGroupRef Optional | 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 |
| dbSubnetGroupRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| dbSubnetGroupRef.from.name Optional | string |
| dbSubnetGroupRef.from.namespace Optional | string |
| dbSystemID Optional | string Reserved for future use. |
| deletionProtection Optional | boolean Specifies whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
| destinationRegion Optional | string DestinationRegion is used for presigning the request to a given region. |
| domain Optional | string 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 |
| domainIAMRoleName Optional | string The name of the IAM role to use when making API calls to the Directory Service. Valid for Cluster Type: Aurora DB clusters only |
| enableCloudwatchLogsExports Optional | array 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 |
| enableCloudwatchLogsExports.[] Required | string |
| enableHTTPEndpoint Optional | boolean 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 |
| enableIAMDatabaseAuthentication Optional | 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 (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 |
| enablePerformanceInsights Optional | boolean 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 |
| engine Required | string 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). |
| engineMode Optional | string 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 |
| engineVersion Optional | string 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 |
| globalClusterIdentifier Optional | string 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 |
| iops Optional | integer 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/CHAP_Storage.html#USER_PIOPS) 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: * Must be a multiple between .5 and 50 of the storage amount for the DB cluster. |
| kmsKeyID Optional | string 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 |
| kmsKeyRef Optional | 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 |
| kmsKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsKeyRef.from.name Optional | string |
| kmsKeyRef.from.namespace Optional | string |
| manageMasterUserPassword Optional | 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 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: * Can’t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified. |
| masterUserPassword Optional | object 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. |
| masterUserPassword.key Required | string Key is the key within the secret |
| masterUserPassword.name Optional | string name is unique within a namespace to reference a secret resource. |
| masterUserPassword.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| masterUserSecretKMSKeyID Optional | 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 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 |
| masterUserSecretKMSKeyRef Optional | 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 |
| masterUserSecretKMSKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| masterUserSecretKMSKeyRef.from.name Optional | string |
| masterUserSecretKMSKeyRef.from.namespace Optional | string |
| masterUsername Optional | string The name of the master user for the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: * Must be 1 to 16 letters or numbers. * First character must be a letter. * Can’t be a reserved word for the chosen database engine. |
| monitoringInterval Optional | integer 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 |
| monitoringRoleARN Optional | string 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/USER_Monitoring.OS.html#USER_Monitoring.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 |
| networkType Optional | string 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 |
| optionGroupName Optional | string The option group to associate the DB cluster with. DB clusters are associated with a default option group that can’t be modified. |
| performanceInsightsKMSKeyID Optional | 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. Valid for Cluster Type: Multi-AZ DB clusters only |
| performanceInsightsRetentionPeriod Optional | integer 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. |
| port Optional | integer The port number on which the instances in the DB cluster accept connections. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: 1150-65535 Default: * RDS for MySQL and Aurora MySQL - 3306 * RDS for PostgreSQL and Aurora PostgreSQL - 5432 |
| preSignedURL Optional | string 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 |
| preferredBackupWindow Optional | string 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. |
| preferredMaintenanceWindow Optional | string 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 |
| publiclyAccessible Optional | boolean 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. |
| replicationSourceIdentifier Optional | string 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 |
| restoreToTime Optional | string 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 |
| restoreType Optional | string 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 |
| scalingConfiguration Optional | object For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for Cluster Type: Aurora DB clusters only |
| scalingConfiguration.autoPause Optional | boolean |
| scalingConfiguration.maxCapacity Optional | integer |
| scalingConfiguration.minCapacity Optional | integer |
| scalingConfiguration.secondsBeforeTimeout Optional | integer |
| scalingConfiguration.secondsUntilAutoPause Optional | integer |
| scalingConfiguration.timeoutAction Optional | string |
| serverlessV2ScalingConfiguration Optional | object 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. |
| serverlessV2ScalingConfiguration.maxCapacity Optional | number |
| serverlessV2ScalingConfiguration.minCapacity Optional | number |
| serverlessV2ScalingConfiguration.secondsUntilAutoPause Optional | integer |
| snapshotIdentifier Optional | string 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: * Must match the identifier of an existing Snapshot. Valid for: Aurora DB clusters and Multi-AZ DB clusters |
| sourceDBClusterIdentifier Optional | string The identifier of the source DB cluster from which to restore. Constraints: * Must match the identifier of an existing DBCluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters |
| sourceRegion Optional | 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. |
| storageEncrypted Optional | boolean Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
| storageType Optional | string 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 |
| tags Optional | array Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
| tags.[] Required | 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/USER_Tagging.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. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
| useLatestRestorableTime
Optional | boolean
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 |
| vpcSecurityGroupIDs
Optional | array
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 |
| vpcSecurityGroupIDs.[]
Required | string
|| vpcSecurityGroupRefs
Optional | array
|
| vpcSecurityGroupRefs.[]
Required | 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 || **vpcSecurityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| vpcSecurityGroupRefs.[].from.name
Optional | string
|
| vpcSecurityGroupRefs.[].from.namespace
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
activityStreamKMSKeyID: string
activityStreamKinesisStreamName: string
activityStreamMode: string
activityStreamStatus: string
associatedRoles:
- featureName: string
roleARN: string
status: string
automaticRestartTime: string
backtrackConsumedChangeRecords: integer
capacity: integer
cloneGroupID: string
clusterCreateTime: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
crossAccountClone: boolean
customEndpoints:
- string
dbClusterMembers:
- dbClusterParameterGroupStatus: string
dbInstanceIdentifier: string
isClusterWriter: boolean
promotionTier: integer
dbClusterOptionGroupMemberships:
- dbClusterOptionGroupName: string
status: string
dbClusterParameterGroup: string
dbClusterResourceID: string
dbSubnetGroup: string
domainMemberships:
- domain: string
fQDN: string
iamRoleName: string
status: string
earliestBacktrackTime: string
earliestRestorableTime: string
enabledCloudwatchLogsExports:
- string
endpoint: string
globalWriteForwardingRequested: boolean
globalWriteForwardingStatus: string
hostedZoneID: string
httpEndpointEnabled: boolean
iamDatabaseAuthenticationEnabled: boolean
latestRestorableTime: string
masterUserSecret:
kmsKeyID: string
secretARN: string
secretStatus: string
multiAZ: boolean
pendingModifiedValues:
allocatedStorage: integer
backupRetentionPeriod: integer
dbClusterIdentifier: string
engineVersion: string
iamDatabaseAuthenticationEnabled: boolean
iops: integer
masterUserPassword: string
pendingCloudwatchLogsExports:
logTypesToDisable:
- string
logTypesToEnable:
- string
percentProgress: string
performanceInsightsEnabled: boolean
readReplicaIdentifiers:
- string
readerEndpoint: string
status: string
tagList:
- key: string
value: string
vpcSecurityGroups:
- status: string
vpcSecurityGroupID: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | 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 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| activityStreamKMSKeyID Optional | 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. |
| activityStreamKinesisStreamName Optional | string The name of the Amazon Kinesis data stream used for the database activity stream. |
| activityStreamMode Optional | string 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. |
| activityStreamStatus Optional | string The status of the database activity stream. |
| associatedRoles Optional | array 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. |
| associatedRoles.[] Required | object Describes an Amazon Web Services Identity and Access Management (IAM) role |
| that is associated with a DB cluster. | |
| associatedRoles.[].roleARN Optional | string |
| associatedRoles.[].status Optional | string |
| automaticRestartTime Optional | string The time when a stopped DB cluster is restarted automatically. |
| backtrackConsumedChangeRecords Optional | integer The number of change records stored for Backtrack. |
| capacity Optional | integer 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. |
| cloneGroupID Optional | string The ID of the clone group with which the DB cluster is associated. |
| clusterCreateTime Optional | string The time when the DB cluster was created, in Universal Coordinated Time (UTC). |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | 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 | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| crossAccountClone Optional | boolean Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. |
| customEndpoints Optional | array The custom endpoints associated with the DB cluster. |
| customEndpoints.[] Required | string |
| dbClusterMembers.[] Required | object Contains information about an instance that is part of a DB cluster. |
| dbClusterMembers.[].dbInstanceIdentifier Optional | string |
| dbClusterMembers.[].isClusterWriter Optional | boolean |
| dbClusterMembers.[].promotionTier Optional | integer |
| dbClusterOptionGroupMemberships Optional | array The list of option group memberships for this DB cluster. |
| dbClusterOptionGroupMemberships.[] Required | object Contains status information for a DB cluster option group. |
| dbClusterOptionGroupMemberships.[].status Optional | string |
| dbClusterParameterGroup Optional | string The name of the DB cluster parameter group for the DB cluster. |
| dbClusterResourceID Optional | string 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. |
| dbSubnetGroup Optional | string Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. |
| domainMemberships Optional | array The Active Directory Domain membership records associated with the DB cluster. |
| domainMemberships.[] Required | object An Active Directory Domain membership record associated with the DB instance |
| or cluster. | |
| domainMemberships.[].fQDN Optional | string |
| domainMemberships.[].iamRoleName Optional | string |
| domainMemberships.[].status Optional | string |
| earliestBacktrackTime Optional | string The earliest time to which a DB cluster can be backtracked. |
| earliestRestorableTime Optional | string The earliest time to which a database can be restored with point-in-time restore. |
| enabledCloudwatchLogsExports Optional | array 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. |
| enabledCloudwatchLogsExports.[] Required | string |
| globalWriteForwardingRequested Optional | boolean 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. |
| globalWriteForwardingStatus Optional | string The status of write forwarding for a secondary cluster in an Aurora global database. |
| hostedZoneID Optional | string The ID that Amazon Route 53 assigns when you create a hosted zone. |
| httpEndpointEnabled Optional | boolean 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. |
| iamDatabaseAuthenticationEnabled Optional | boolean Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. |
| latestRestorableTime Optional | string The latest time to which a database can be restored with point-in-time restore. |
| masterUserSecret Optional | 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 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. |
| masterUserSecret.kmsKeyID Optional | string |
| masterUserSecret.secretARN Optional | string |
| masterUserSecret.secretStatus Optional | string |
| multiAZ Optional | boolean Indicates whether the DB cluster has instances in multiple Availability Zones. |
| pendingModifiedValues Optional | object Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. |
| pendingModifiedValues.allocatedStorage Optional | integer |
| pendingModifiedValues.backupRetentionPeriod Optional | integer |
| pendingModifiedValues.dbClusterIdentifier Optional | string |
| pendingModifiedValues.engineVersion Optional | string |
| pendingModifiedValues.iamDatabaseAuthenticationEnabled Optional | boolean |
| pendingModifiedValues.iops Optional | integer |
| pendingModifiedValues.masterUserPassword Optional | string |
| pendingModifiedValues.pendingCloudwatchLogsExports Optional | 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. |
| pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable Optional | array |
| pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[] Required | string |
| pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[] Required | string |
| performanceInsightsEnabled Optional | boolean Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. |
| readReplicaIdentifiers Optional | array Contains one or more identifiers of the read replicas associated with this DB cluster. |
| readReplicaIdentifiers.[] Required | string |
| status Optional | string The current state of this DB cluster. |
| tagList Optional | array |
| tagList.[] Required | 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/USER_Tagging.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. || tagList.[].key
Optional | string
|
| tagList.[].value
Optional | string
|
| vpcSecurityGroups
Optional | array
The list of VPC security groups that the DB cluster belongs to. |
| vpcSecurityGroups.[]
Required | object
This data type is used as a response element for queries on VPC security
group membership. || vpcSecurityGroups.[].status
Optional | string
|
| vpcSecurityGroups.[].vpcSecurityGroupID
Optional | string
|