Skip to content

rds.v1alpha1.dbCluster

"DBCluster is the Schema for the DBClusters API"

Index

Fields

fn new

new(name)

new returns an instance of DBCluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"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."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"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."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"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."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"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.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

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

fn metadata.withLabels

withLabels(labels)

"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: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"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: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

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

fn metadata.withNamespace

withNamespace(namespace)

"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.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"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."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"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."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"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.\n\nPopulated 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"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"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.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"DBClusterSpec defines the desired state of DBCluster"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

"DBClusterParameters defines the desired state of DBCluster"

fn spec.forProvider.withAllocatedStorage

withAllocatedStorage(allocatedStorage)

"The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. \n This setting is required to create a Multi-AZ DB cluster. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withAllowMajorVersionUpgrade

withAllowMajorVersionUpgrade(allowMajorVersionUpgrade)

"A value that indicates whether major version upgrades are allowed. \n Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withApplyImmediately

withApplyImmediately(applyImmediately)

"A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. \n The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. \n By default, this parameter is disabled."

fn spec.forProvider.withAutoMinorVersionUpgrade

withAutoMinorVersionUpgrade(autoMinorVersionUpgrade)

"A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withAutogeneratePassword

withAutogeneratePassword(autogeneratePassword)

"AutogeneratePassword indicates whether the controller should generate a random password for the master user if one is not provided via MasterUserPasswordSecretRef. \n If a password is generated, it will be stored as a secret at the location specified by MasterUserPasswordSecretRef."

fn spec.forProvider.withAvailabilityZones

withAvailabilityZones(availabilityZones)

"A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. \n For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withAvailabilityZonesMixin

withAvailabilityZonesMixin(availabilityZones)

"A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. \n For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters only"

Note: This function appends passed data to existing values

fn spec.forProvider.withBacktrackWindow

withBacktrackWindow(backtrackWindow)

"The target backtrack window, in seconds. To disable backtracking, set this value to 0. \n Default: 0 \n Constraints: \n * If specified, this value must be set to a number from 0 to 259,200 (72 hours). \n Valid for: Aurora MySQL DB clusters only"

fn spec.forProvider.withBackupRetentionPeriod

withBackupRetentionPeriod(backupRetentionPeriod)

"The number of days for which automated backups are retained. \n Default: 1 \n Constraints: \n * Must be a value from 1 to 35 \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withCharacterSetName

withCharacterSetName(characterSetName)

"A value that indicates that the DB cluster should be associated with the specified CharacterSet. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withCopyTagsToSnapshot

withCopyTagsToSnapshot(copyTagsToSnapshot)

"A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withDatabaseName

withDatabaseName(databaseName)

"The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withDbClusterInstanceClass

withDbClusterInstanceClass(dbClusterInstanceClass)

"The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. \n 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. \n This setting is required to create a Multi-AZ DB cluster. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withDbClusterParameterGroupName

withDbClusterParameterGroupName(dbClusterParameterGroupName)

"The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. \n Constraints: \n * If supplied, must match the name of an existing DB cluster parameter group. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withDbSubnetGroupName

withDbSubnetGroupName(dbSubnetGroupName)

"A DB subnet group to associate with this DB cluster. \n This setting is required to create a Multi-AZ DB cluster. \n Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. \n Example: mydbsubnetgroup \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withDeletionProtection

withDeletionProtection(deletionProtection)

"A value that indicates 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. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withDestinationRegion

withDestinationRegion(destinationRegion)

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

fn spec.forProvider.withDomain

withDomain(domain)

"The Active Directory directory ID to create the DB cluster in. \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. \n For more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withDomainIAMRoleName

withDomainIAMRoleName(domainIAMRoleName)

"Specify the name of the IAM role to be used when making API calls to the Directory Service. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withEnableCloudwatchLogsExports

withEnableCloudwatchLogsExports(enableCloudwatchLogsExports)

"The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. \n RDS for MySQL \n Possible values are error, general, and slowquery. \n RDS for PostgreSQL \n Possible values are postgresql and upgrade. \n Aurora MySQL \n Possible values are audit, error, general, and slowquery. \n Aurora PostgreSQL \n Possible value is postgresql. \n 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/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide. \n 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/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withEnableCloudwatchLogsExportsMixin

withEnableCloudwatchLogsExportsMixin(enableCloudwatchLogsExports)

"The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. \n RDS for MySQL \n Possible values are error, general, and slowquery. \n RDS for PostgreSQL \n Possible values are postgresql and upgrade. \n Aurora MySQL \n Possible values are audit, error, general, and slowquery. \n Aurora PostgreSQL \n Possible value is postgresql. \n 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/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide. \n 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/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

Note: This function appends passed data to existing values

fn spec.forProvider.withEnableGlobalWriteForwarding

withEnableGlobalWriteForwarding(enableGlobalWriteForwarding)

"A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. \n 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 the FailoverGlobalCluster API operation, but it does nothing until then. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withEnableHTTPEndpoint

withEnableHTTPEndpoint(enableHTTPEndpoint)

"A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. \n When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor. \n For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the Amazon Aurora User Guide. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withEnableIAMDatabaseAuthentication

withEnableIAMDatabaseAuthentication(enableIAMDatabaseAuthentication)

"A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. \n For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon Aurora User Guide.. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withEnablePerformanceInsights

withEnablePerformanceInsights(enablePerformanceInsights)

"A value that indicates whether to turn on Performance Insights for the DB cluster. \n 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. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withEngine

withEngine(engine)

"The name of the database engine to be used for this DB cluster. \n Valid Values: \n * aurora (for MySQL 5.6-compatible Aurora) \n * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) \n * aurora-postgresql \n * mysql \n * postgres \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withEngineMode

withEngineMode(engineMode)

"The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. \n The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. \n The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. \n The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. \n For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. \n Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: \n * Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n * Limitations of Parallel Query (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n * Limitations of Aurora Global Databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n * Limitations of Multi-Master Clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withEngineVersion

withEngineVersion(engineVersion)

"The version number of the database engine to use. \n To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\" \n To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command: \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" \n To list all of the available engine versions for Aurora PostgreSQL, use the following command: \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\" \n To list all of the available engine versions for RDS for MySQL, use the following command: \n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\" \n To list all of the available engine versions for RDS for PostgreSQL, use the following command: \n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\" \n Aurora MySQL \n For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the Amazon Aurora User Guide. \n Aurora PostgreSQL \n For information, 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. \n MySQL \n For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the Amazon RDS User Guide. \n PostgreSQL \n For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the Amazon RDS User Guide. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withFinalDBSnapshotIdentifier

withFinalDBSnapshotIdentifier(finalDBSnapshotIdentifier)

"The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled. \n Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error. \n Constraints: \n * Must be 1 to 255 letters, numbers, or hyphens. \n * First character must be a letter \n * Can't end with a hyphen or contain two consecutive hyphens"

fn spec.forProvider.withGlobalClusterIdentifier

withGlobalClusterIdentifier(globalClusterIdentifier)

"The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withIops

withIops(iops)

"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. \n For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide. \n This setting is required to create a Multi-AZ DB cluster. \n Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withKmsKeyID

withKmsKeyID(kmsKeyID)

"The Amazon Web Services KMS key identifier for an encrypted DB cluster. \n 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. \n When a KMS key isn't specified in KmsKeyId: \n * If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. \n * If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key. \n 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. \n If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must 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. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withMasterUsername

withMasterUsername(masterUsername)

"The name of the master user for the DB cluster. \n Constraints: \n * Must be 1 to 16 letters or numbers. \n * First character must be a letter. \n * Can't be a reserved word for the chosen database engine. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withMonitoringInterval

withMonitoringInterval(monitoringInterval)

"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. The default is 0. \n If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0. \n Valid Values: 0, 1, 5, 10, 15, 30, 60 \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withMonitoringRoleARN

withMonitoringRoleARN(monitoringRoleARN)

"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. \n If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withOptionGroupName

withOptionGroupName(optionGroupName)

"A value that indicates that the DB cluster should be associated with the specified option group. \n DB clusters are associated with a default option group that can't be modified."

fn spec.forProvider.withPerformanceInsightsKMSKeyID

withPerformanceInsightsKMSKeyID(performanceInsightsKMSKeyID)

"The Amazon Web Services KMS key identifier for encryption of Performance Insights data. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n 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. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withPerformanceInsightsRetentionPeriod

withPerformanceInsightsRetentionPeriod(performanceInsightsRetentionPeriod)

"The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withPort

withPort(port)

"The port number on which the instances in the DB cluster accept connections. \n RDS for MySQL and Aurora MySQL \n Default: 3306 \n Valid values: 1150-65535 \n RDS for PostgreSQL and Aurora PostgreSQL \n Default: 5432 \n Valid values: 1150-65535 \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withPreSignedURL

withPreSignedURL(preSignedURL)

"A URL that contains a Signature Version 4 signed request for the CreateDBCluster action 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. \n The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied. \n The pre-signed URL request must contain the following parameter values: \n * KmsKeyId - The Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. \n * DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in. \n * 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. \n 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). \n 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 pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withPreferredBackupWindow

withPreferredBackupWindow(preferredBackupWindow)

"The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. \n 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. \n Constraints: \n * Must be in the format hh24:mi-hh24:mi. \n * Must be in Universal Coordinated Time (UTC). \n * Must not conflict with the preferred maintenance window. \n * Must be at least 30 minutes. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withPreferredMaintenanceWindow

withPreferredMaintenanceWindow(preferredMaintenanceWindow)

"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). \n Format: ddd:hh24:mi-ddd:hh24:mi \n 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. \n Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. \n Constraints: Minimum 30-minute window. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withPubliclyAccessible

withPubliclyAccessible(publiclyAccessible)

"A value that indicates whether the DB cluster is publicly accessible. \n When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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. \n 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. \n Default: The default behavior varies depending on whether DBSubnetGroupName is specified. \n If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: \n * If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. \n * If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. \n If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: \n * If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. \n * If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withRegion

withRegion(region)

"Region is which region the DBCluster will be created."

fn spec.forProvider.withReplicationSourceIdentifier

withReplicationSourceIdentifier(replicationSourceIdentifier)

"The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.withSkipFinalSnapshot

withSkipFinalSnapshot(skipFinalSnapshot)

"A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled. \n You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled."

fn spec.forProvider.withSourceRegion

withSourceRegion(sourceRegion)

"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."

fn spec.forProvider.withStorageEncrypted

withStorageEncrypted(storageEncrypted)

"A value that indicates whether the DB cluster is encrypted. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withStorageType

withStorageType(storageType)

"Specifies the storage type to be associated with the DB cluster. \n This setting is required to create a Multi-AZ DB cluster. \n Valid values: io1 \n When specified, a value for the Iops parameter is required. \n Default: io1 \n Valid for: Multi-AZ DB clusters only"

fn spec.forProvider.withTags

withTags(tags)

"Tags to assign to the DB cluster. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"Tags to assign to the DB cluster. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

Note: This function appends passed data to existing values

fn spec.forProvider.withVpcSecurityGroupIDRefs

withVpcSecurityGroupIDRefs(vpcSecurityGroupIDRefs)

"VPCSecurityGroupIDRefs are references to VPCSecurityGroups used to set the VPCSecurityGroupIDs."

fn spec.forProvider.withVpcSecurityGroupIDRefsMixin

withVpcSecurityGroupIDRefsMixin(vpcSecurityGroupIDRefs)

"VPCSecurityGroupIDRefs are references to VPCSecurityGroups used to set the VPCSecurityGroupIDs."

Note: This function appends passed data to existing values

fn spec.forProvider.withVpcSecurityGroupIDs

withVpcSecurityGroupIDs(vpcSecurityGroupIDs)

"A list of VPC security groups that the DB cluster will belong to. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.withVpcSecurityGroupIDsMixin

withVpcSecurityGroupIDsMixin(vpcSecurityGroupIDs)

"A list of VPC security groups that the DB cluster will belong to. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

Note: This function appends passed data to existing values

obj spec.forProvider.dbClusterParameterGroupNameRef

"DBClusterParameterGroupNameRef is a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName."

fn spec.forProvider.dbClusterParameterGroupNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.dbClusterParameterGroupNameRef.policy

"Policies for referencing."

fn spec.forProvider.dbClusterParameterGroupNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dbClusterParameterGroupNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.dbClusterParameterGroupNameSelector

"DBClusterParameterGroupNameSelector selects a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName."

fn spec.forProvider.dbClusterParameterGroupNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.dbClusterParameterGroupNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.dbClusterParameterGroupNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.dbClusterParameterGroupNameSelector.policy

"Policies for selection."

fn spec.forProvider.dbClusterParameterGroupNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dbClusterParameterGroupNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.dbSubnetGroupNameRef

"DBSubnetGroupNameRef is a reference to a DBSubnetGroup used to set DBSubnetGroupName."

fn spec.forProvider.dbSubnetGroupNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.dbSubnetGroupNameRef.policy

"Policies for referencing."

fn spec.forProvider.dbSubnetGroupNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dbSubnetGroupNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.dbSubnetGroupNameSelector

"DBSubnetGroupNameSelector selects a reference to a DBSubnetGroup used to set DBSubnetGroupName."

fn spec.forProvider.dbSubnetGroupNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.dbSubnetGroupNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.dbSubnetGroupNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.dbSubnetGroupNameSelector.policy

"Policies for selection."

fn spec.forProvider.dbSubnetGroupNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.dbSubnetGroupNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.domainIAMRoleNameRef

"DomainIAMRoleNameRef is a reference to an IAMRole used to set DomainIAMRoleName."

fn spec.forProvider.domainIAMRoleNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.domainIAMRoleNameRef.policy

"Policies for referencing."

fn spec.forProvider.domainIAMRoleNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.domainIAMRoleNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.domainIAMRoleNameSelector

"DomainIAMRoleNameSelector selects a reference to an IAMRole used to set DomainIAMRoleName."

fn spec.forProvider.domainIAMRoleNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.domainIAMRoleNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.domainIAMRoleNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.domainIAMRoleNameSelector.policy

"Policies for selection."

fn spec.forProvider.domainIAMRoleNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.domainIAMRoleNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.kmsKeyIDRef

"KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID."

fn spec.forProvider.kmsKeyIDRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.kmsKeyIDRef.policy

"Policies for referencing."

fn spec.forProvider.kmsKeyIDRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.kmsKeyIDRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.kmsKeyIDSelector

"KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID."

fn spec.forProvider.kmsKeyIDSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.kmsKeyIDSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.kmsKeyIDSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.kmsKeyIDSelector.policy

"Policies for selection."

fn spec.forProvider.kmsKeyIDSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.kmsKeyIDSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.masterUserPasswordSecretRef

"The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\". \n Constraints: Must contain from 8 to 41 characters. Required."

fn spec.forProvider.masterUserPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.masterUserPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.masterUserPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.restoreFrom

"RestoreFrom specifies the details of the backup to restore when creating a new DBCluster."

fn spec.forProvider.restoreFrom.withSource

withSource(source)

"Source is the type of the backup to restore when creating a new DBCluster or DBInstance. S3, Snapshot and PointInTime are supported."

obj spec.forProvider.restoreFrom.pointInTime

"PointInTime specifies the details of the point in time restore."

fn spec.forProvider.restoreFrom.pointInTime.withRestoreTime

withRestoreTime(restoreTime)

"RestoreTime is the date and time (UTC) to restore from. Must be before the latest restorable time for the DB instance. Can't be specified if the useLatestRestorableTime parameter is enabled. Example: 2011-09-07T23:45:00Z"

fn spec.forProvider.restoreFrom.pointInTime.withRestoreType

withRestoreType(restoreType)

"The type of restore to be performed. You can specify one of the following values: \n * full-copy - The new DB cluster is restored as a full copy of the source DB cluster. \n * copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. \n Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. \n If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.restoreFrom.pointInTime.withSourceDBClusterIdentifier

withSourceDBClusterIdentifier(sourceDBClusterIdentifier)

"SourceDBClusterIdentifier specifies the identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DB instance."

fn spec.forProvider.restoreFrom.pointInTime.withSourceDBInstanceAutomatedBackupsArn

withSourceDBInstanceAutomatedBackupsArn(sourceDBInstanceAutomatedBackupsArn)

"SourceDBInstanceAutomatedBackupsArn specifies the Amazon Resource Name (ARN) of the replicated automated backups from which to restore. Example: arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE"

fn spec.forProvider.restoreFrom.pointInTime.withSourceDbiResourceId

withSourceDbiResourceId(sourceDbiResourceId)

"SourceDbiResourceID specifies the resource ID of the source DB instance from which to restore."

fn spec.forProvider.restoreFrom.pointInTime.withUseLatestRestorableTime

withUseLatestRestorableTime(useLatestRestorableTime)

"UseLatestRestorableTime indicates that the DB instance is restored from the latest backup Can't be specified if the restoreTime parameter is provided."

obj spec.forProvider.restoreFrom.s3

"S3 specifies the details of the S3 backup to restore from."

fn spec.forProvider.restoreFrom.s3.withBucketName

withBucketName(bucketName)

"BucketName is the name of the S3 bucket containing the backup to restore."

fn spec.forProvider.restoreFrom.s3.withIngestionRoleARN

withIngestionRoleARN(ingestionRoleARN)

"IngestionRoleARN is the IAM role RDS can assume that will allow it to access the contents of the S3 bucket."

fn spec.forProvider.restoreFrom.s3.withPrefix

withPrefix(prefix)

"Prefix is the path prefix of the S3 bucket within which the backup to restore is located."

fn spec.forProvider.restoreFrom.s3.withSourceEngine

withSourceEngine(sourceEngine)

"SourceEngine is the engine used to create the backup. Must be \"mysql\"."

fn spec.forProvider.restoreFrom.s3.withSourceEngineVersion

withSourceEngineVersion(sourceEngineVersion)

"SourceEngineVersion is the version of the engine used to create the backup. Example: \"5.7.30\

obj spec.forProvider.restoreFrom.snapshot

"Snapshot specifies the details of the snapshot to restore from."

fn spec.forProvider.restoreFrom.snapshot.withSnapshotIdentifier

withSnapshotIdentifier(snapshotIdentifier)

"SnapshotIdentifier is the identifier of the snapshot to restore."

obj spec.forProvider.scalingConfiguration

"For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. \n Valid for: Aurora DB clusters only"

fn spec.forProvider.scalingConfiguration.withAutoPause

withAutoPause(autoPause)

fn spec.forProvider.scalingConfiguration.withMaxCapacity

withMaxCapacity(maxCapacity)

fn spec.forProvider.scalingConfiguration.withMinCapacity

withMinCapacity(minCapacity)

fn spec.forProvider.scalingConfiguration.withSecondsBeforeTimeout

withSecondsBeforeTimeout(secondsBeforeTimeout)

fn spec.forProvider.scalingConfiguration.withSecondsUntilAutoPause

withSecondsUntilAutoPause(secondsUntilAutoPause)

fn spec.forProvider.scalingConfiguration.withTimeoutAction

withTimeoutAction(timeoutAction)

obj spec.forProvider.serverlessV2ScalingConfiguration

fn spec.forProvider.serverlessV2ScalingConfiguration.withMaxCapacity

withMaxCapacity(maxCapacity)

fn spec.forProvider.serverlessV2ScalingConfiguration.withMinCapacity

withMinCapacity(minCapacity)

obj spec.forProvider.tags

"Tags to assign to the DB cluster. \n Valid for: Aurora DB clusters and Multi-AZ DB clusters"

fn spec.forProvider.tags.withKey

withKey(key)

fn spec.forProvider.tags.withValue

withValue(value)

obj spec.forProvider.vpcSecurityGroupIDRefs

"VPCSecurityGroupIDRefs are references to VPCSecurityGroups used to set the VPCSecurityGroupIDs."

fn spec.forProvider.vpcSecurityGroupIDRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.vpcSecurityGroupIDRefs.policy

"Policies for referencing."

fn spec.forProvider.vpcSecurityGroupIDRefs.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.vpcSecurityGroupIDRefs.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.vpcSecurityGroupIDSelector

"VPCSecurityGroupIDSelector selects references to VPCSecurityGroups used to set the VPCSecurityGroupIDs."

fn spec.forProvider.vpcSecurityGroupIDSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.vpcSecurityGroupIDSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.vpcSecurityGroupIDSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.vpcSecurityGroupIDSelector.policy

"Policies for selection."

fn spec.forProvider.vpcSecurityGroupIDSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.vpcSecurityGroupIDSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."