DBParameterGroup

rds.services.k8s.aws/v1alpha1

TypeLink
GoDocrds-controller/apis/v1alpha1#DBParameterGroup

Metadata

PropertyValue
ScopeNamespaced
KindDBParameterGroup
ListKindDBParameterGroupList
Pluraldbparametergroups
Singulardbparametergroup

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

Spec

description: string
family: string
name: string
parameterOverrides: {}
tags:
- key: string
  value: string
FieldDescription
description
Required
string
The description for the DB parameter group.
family
Required
string
The DB parameter group family name. A DB parameter group can be associated
with one and only one DB parameter group family, and can be applied only
to a DB instance running a database engine and engine version compatible
with that DB parameter group family.


To list all of the available parameter group families for a DB engine, use
the following command:


aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily”
–engine


For example, to list all of the available parameter group families for the
MySQL DB engine, use the following command:


aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily”
–engine mysql


The output contains duplicates.


The following are the valid DB engine values:


* aurora (for MySQL 5.6-compatible Aurora)


* aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)


* aurora-postgresql


* mariadb


* mysql


* oracle-ee


* oracle-ee-cdb


* oracle-se2


* oracle-se2-cdb


* postgres


* sqlserver-ee


* sqlserver-se


* sqlserver-ex


* sqlserver-web
name
Required
string
The name of the DB parameter group.


Constraints:


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


* First character must be a letter


* Can’t end with a hyphen or contain two consecutive hyphens


This value is stored as a lowercase string.
parameterOverrides
Optional
object
tags
Optional
array
Tags to assign to the DB parameter group.
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. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
parameterOverrideStatuses:
- allowedValues: string
  applyMethod: string
  applyType: string
  dataType: string
  description: string
  isModifiable: boolean
  minimumEngineVersion: string
  parameterName: string
  parameterValue: string
  source: string
  supportedEngineModes:
  - string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
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.
TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse
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.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
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
parameterOverrideStatuses
Optional
array
A list of Parameter values.
parameterOverrideStatuses.[]
Required
object
This data type is used as a request parameter in the ModifyDBParameterGroup
and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions. || parameterOverrideStatuses.[].allowedValues
Optional | string
| | parameterOverrideStatuses.[].applyMethod
Optional | string
| | parameterOverrideStatuses.[].applyType
Optional | string
| | parameterOverrideStatuses.[].dataType
Optional | string
| | parameterOverrideStatuses.[].description
Optional | string
| | parameterOverrideStatuses.[].isModifiable
Optional | boolean
| | parameterOverrideStatuses.[].minimumEngineVersion
Optional | string
| | parameterOverrideStatuses.[].parameterName
Optional | string
| | parameterOverrideStatuses.[].parameterValue
Optional | string
| | parameterOverrideStatuses.[].source
Optional | string
| | parameterOverrideStatuses.[].supportedEngineModes
Optional | array
| | parameterOverrideStatuses.[].supportedEngineModes.[]
Required | string
|