@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
33kind : CustomResourceDefinition
44metadata :
55 annotations :
6- controller-gen.kubebuilder.io/version : v0.9.2
7- creationTimestamp : null
6+ controller-gen.kubebuilder.io/version : v0.14.0
87 name : dbclusterparametergroups.rds.services.k8s.aws
98spec :
109 group : rds.services.k8s.aws
@@ -22,72 +21,146 @@ spec:
2221 API
2322 properties :
2423 apiVersion :
25- description : ' APIVersion defines the versioned schema of this representation
26- of an object. Servers should convert recognized schemas to the latest
27- internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
24+ description : |-
25+ APIVersion defines the versioned schema of this representation of an object.
26+ Servers should convert recognized schemas to the latest internal value, and
27+ may reject unrecognized values.
28+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2829 type : string
2930 kind :
30- description : ' Kind is a string value representing the REST resource this
31- object represents. Servers may infer this from the endpoint the client
32- submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
31+ description : |-
32+ Kind is a string value representing the REST resource this object represents.
33+ Servers may infer this from the endpoint the client submits requests to.
34+ Cannot be updated.
35+ In CamelCase.
36+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
3337 type : string
3438 metadata :
3539 type : object
3640 spec :
37- description : " DBClusterParameterGroupSpec defines the desired state of
38- DBClusterParameterGroup. \n Contains the details of an Amazon RDS DB
39- cluster parameter group. \n This data type is used as a response element
40- in the DescribeDBClusterParameterGroups action."
41+ description : |-
42+ DBClusterParameterGroupSpec defines the desired state of DBClusterParameterGroup.
43+
44+
45+ Contains the details of an Amazon RDS DB cluster parameter group.
46+
47+
48+ This data type is used as a response element in the DescribeDBClusterParameterGroups
49+ action.
4150 properties :
4251 description :
4352 description : The description for the DB cluster parameter group.
4453 type : string
4554 family :
46- description : " The DB cluster parameter group family name. A DB cluster
47- parameter group can be associated with one and only one DB cluster
48- parameter group family, and can be applied only to a DB cluster
49- running a database engine and engine version compatible with that
50- DB cluster parameter group family. \n # Aurora MySQL \n Example:
51- aurora5.6, aurora-mysql5.7, aurora-mysql8.0 \n # Aurora PostgreSQL
52- \n Example: aurora-postgresql9.6 \n # RDS for MySQL \n Example:
53- mysql8.0 \n # RDS for PostgreSQL \n Example: postgres12 \n To list
54- all of the available parameter group families for a DB engine, use
55- the following command: \n aws rds describe-db-engine-versions --query
56- \" DBEngineVersions[].DBParameterGroupFamily\" --engine <engine>
57- \n For example, to list all of the available parameter group families
58- for the Aurora PostgreSQL DB engine, use the following command:
59- \n aws rds describe-db-engine-versions --query \" DBEngineVersions[].DBParameterGroupFamily\"
60- --engine aurora-postgresql \n The output contains duplicates. \n
61- The following are the valid DB engine values: \n - aurora (for MySQL
62- 5.6-compatible Aurora) \n - aurora-mysql (for MySQL 5.7-compatible
63- and MySQL 8.0-compatible Aurora) \n - aurora-postgresql \n - mysql
64- \n - postgres"
55+ description : |-
56+ The DB cluster parameter group family name. A DB cluster parameter group
57+ can be associated with one and only one DB cluster parameter group family,
58+ and can be applied only to a DB cluster running a database engine and engine
59+ version compatible with that DB cluster parameter group family.
60+
61+
62+ # Aurora MySQL
63+
64+
65+ Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0
66+
67+
68+ # Aurora PostgreSQL
69+
70+
71+ Example: aurora-postgresql9.6
72+
73+
74+ # RDS for MySQL
75+
76+
77+ Example: mysql8.0
78+
79+
80+ # RDS for PostgreSQL
81+
82+
83+ Example: postgres12
84+
85+
86+ To list all of the available parameter group families for a DB engine, use
87+ the following command:
88+
89+
90+ aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
91+ --engine <engine>
92+
93+
94+ For example, to list all of the available parameter group families for the
95+ Aurora PostgreSQL DB engine, use the following command:
96+
97+
98+ aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
99+ --engine aurora-postgresql
100+
101+
102+ The output contains duplicates.
103+
104+
105+ The following are the valid DB engine values:
106+
107+
108+ - aurora (for MySQL 5.6-compatible Aurora)
109+
110+
111+ - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
112+
113+
114+ - aurora-postgresql
115+
116+
117+ - mysql
118+
119+
120+ - postgres
65121 type : string
66122 name :
67- description : " The name of the DB cluster parameter group. \n Constraints:
68- \n - Must not match the name of an existing DB cluster parameter
69- group. \n This value is stored as a lowercase string."
123+ description : |-
124+ The name of the DB cluster parameter group.
125+
126+
127+ Constraints:
128+
129+
130+ - Must not match the name of an existing DB cluster parameter group.
131+
132+
133+ This value is stored as a lowercase string.
70134 type : string
71135 parameterOverrides :
72136 additionalProperties :
73137 type : string
74138 type : object
75139 parameters :
76- description : " A list of parameters in the DB cluster parameter group
77- to modify. \n Valid Values (for the application method): immediate
78- | pending-reboot \n You can use the immediate value with dynamic
79- parameters only. You can use the pending-reboot value for both dynamic
80- and static parameters. \n When the application method is immediate,
81- changes to dynamic parameters are applied immediately to the DB
82- clusters associated with the parameter group. When the application
83- method is pending-reboot, changes to dynamic and static parameters
84- are applied after a reboot without failover to the DB clusters associated
85- with the parameter group."
140+ description : |-
141+ A list of parameters in the DB cluster parameter group to modify.
142+
143+
144+ Valid Values (for the application method): immediate | pending-reboot
145+
146+
147+ You can use the immediate value with dynamic parameters only. You can use
148+ the pending-reboot value for both dynamic and static parameters.
149+
150+
151+ When the application method is immediate, changes to dynamic parameters are
152+ applied immediately to the DB clusters associated with the parameter group.
153+ When the application method is pending-reboot, changes to dynamic and static
154+ parameters are applied after a reboot without failover to the DB clusters
155+ associated with the parameter group.
86156 items :
87- description : " This data type is used as a request parameter in the
88- ModifyDBParameterGroup and ResetDBParameterGroup actions. \n This
89- data type is used as a response element in the DescribeEngineDefaultParameters
90- and DescribeDBParameters actions."
157+ description : |-
158+ This data type is used as a request parameter in the ModifyDBParameterGroup
159+ and ResetDBParameterGroup actions.
160+
161+
162+ This data type is used as a response element in the DescribeEngineDefaultParameters
163+ and DescribeDBParameters actions.
91164 properties :
92165 allowedValues :
93166 type : string
@@ -118,10 +191,12 @@ spec:
118191 tags :
119192 description : Tags to assign to the DB cluster parameter group.
120193 items :
121- description : " Metadata assigned to an Amazon RDS resource consisting
122- of a key-value pair. \n For more information, see Tagging Amazon
123- RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
124- in the Amazon RDS User Guide."
194+ description : |-
195+ Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
196+
197+
198+ For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
199+ in the Amazon RDS User Guide.
125200 properties :
126201 key :
127202 type : string
@@ -139,24 +214,26 @@ spec:
139214 of DBClusterParameterGroup
140215 properties :
141216 ackResourceMetadata :
142- description : All CRs managed by ACK have a common `Status.ACKResourceMetadata`
143- member that is used to contain resource sync state, account ownership,
217+ description : |-
218+ All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
219+ that is used to contain resource sync state, account ownership,
144220 constructed ARN for the resource
145221 properties :
146222 arn :
147- description : ' ARN is the Amazon Resource Name for the resource.
148- This is a globally-unique identifier and is set only by the
149- ACK service controller once the controller has orchestrated
150- the creation of the resource OR when it has verified that an
151- "adopted" resource (a resource where the ARN annotation was
152- set by the Kubernetes user on the CR) exists and matches the
153- supplied CR'' s Spec field values. TODO(vijat@): Find a better
154- strategy for resources that do not have ARN in CreateOutputResponse
155- https://github.com/aws/aws-controllers-k8s/issues/270'
223+ description : |-
224+ ARN is the Amazon Resource Name for the resource. This is a
225+ globally-unique identifier and is set only by the ACK service controller
226+ once the controller has orchestrated the creation of the resource OR
227+ when it has verified that an "adopted" resource (a resource where the
228+ ARN annotation was set by the Kubernetes user on the CR) exists and
229+ matches the supplied CR's Spec field values.
230+ TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse
231+ https://github.com/aws/aws-controllers-k8s/issues/270
156232 type : string
157233 ownerAccountID :
158- description : OwnerAccountID is the AWS Account ID of the account
159- that owns the backend AWS service API resource.
234+ description : |-
235+ OwnerAccountID is the AWS Account ID of the account that owns the
236+ backend AWS service API resource.
160237 type : string
161238 region :
162239 description : Region is the AWS region in which the resource exists
@@ -167,14 +244,16 @@ spec:
167244 - region
168245 type : object
169246 conditions :
170- description : All CRS managed by ACK have a common `Status.Conditions`
171- member that contains a collection of `ackv1alpha1.Condition` objects
172- that describe the various terminal states of the CR and its backend
173- AWS service API resource
247+ description : |-
248+ All CRS managed by ACK have a common `Status.Conditions` member that
249+ contains a collection of `ackv1alpha1.Condition` objects that describe
250+ the various terminal states of the CR and its backend AWS service API
251+ resource
174252 items :
175- description : Condition is the common struct used by all CRDs managed
176- by ACK service controllers to indicate terminal states of the
177- CR and its backend AWS service API resource
253+ description : |-
254+ Condition is the common struct used by all CRDs managed by ACK service
255+ controllers to indicate terminal states of the CR and its backend AWS
256+ service API resource
178257 properties :
179258 lastTransitionTime :
180259 description : Last time the condition transitioned from one status
@@ -203,10 +282,13 @@ spec:
203282 description : Provides a list of parameters for the DB cluster parameter
204283 group.
205284 items :
206- description : " This data type is used as a request parameter in the
207- ModifyDBParameterGroup and ResetDBParameterGroup actions. \n This
208- data type is used as a response element in the DescribeEngineDefaultParameters
209- and DescribeDBParameters actions."
285+ description : |-
286+ This data type is used as a request parameter in the ModifyDBParameterGroup
287+ and ResetDBParameterGroup actions.
288+
289+
290+ This data type is used as a response element in the DescribeEngineDefaultParameters
291+ and DescribeDBParameters actions.
210292 properties :
211293 allowedValues :
212294 type : string
0 commit comments