1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: bigquerydatatransferconfigs.bigquerydatatransfer.cnrm.cloud.google.com
13spec:
14 group: bigquerydatatransfer.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: BigQueryDataTransferConfig
19 plural: bigquerydatatransferconfigs
20 shortNames:
21 - gcpbigquerydatatransferconfig
22 - gcpbigquerydatatransferconfigs
23 singular: bigquerydatatransferconfig
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 dataRefreshWindowDays:
62 description: |-
63 The number of days to look back to automatically refresh the data.
64 For example, if dataRefreshWindowDays = 10, then every day BigQuery
65 reingests data for [today-10, today-1], rather than ingesting data for
66 just [today-1]. Only valid if the data source supports the feature.
67 Set the value to 0 to use the default value.
68 type: integer
69 dataSourceId:
70 description: Immutable. The data source id. Cannot be changed once
71 the transfer config is created.
72 type: string
73 destinationDatasetId:
74 description: The BigQuery target dataset id.
75 type: string
76 disabled:
77 description: When set to true, no runs are scheduled for a given transfer.
78 type: boolean
79 displayName:
80 description: The user specified display name for the transfer config.
81 type: string
82 emailPreferences:
83 description: |-
84 Email notifications will be sent according to these preferences to the
85 email address of the user who owns this transfer config.
86 properties:
87 enableFailureEmail:
88 description: If true, email notifications will be sent on transfer
89 run failures.
90 type: boolean
91 required:
92 - enableFailureEmail
93 type: object
94 location:
95 description: |-
96 Immutable. The geographic location where the transfer config should reside.
97 Examples: US, EU, asia-northeast1. The default value is US.
98 type: string
99 notificationPubsubTopic:
100 description: |-
101 Pub/Sub topic where notifications will be sent after transfer runs
102 associated with this transfer config finish.
103 type: string
104 params:
105 additionalProperties:
106 type: string
107 type: object
108 projectRef:
109 description: The project that this resource belongs to.
110 oneOf:
111 - not:
112 required:
113 - external
114 required:
115 - name
116 - not:
117 anyOf:
118 - required:
119 - name
120 - required:
121 - namespace
122 required:
123 - external
124 properties:
125 external:
126 description: 'Allowed value: The `name` field of a `Project` resource.'
127 type: string
128 name:
129 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
130 type: string
131 namespace:
132 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
133 type: string
134 type: object
135 resourceID:
136 description: Immutable. Optional. The service-generated name of the
137 resource. Used for acquisition only. Leave unset to create a new
138 resource.
139 type: string
140 schedule:
141 description: |-
142 Data transfer schedule. If the data source does not support a custom
143 schedule, this should be empty. If it is empty, the default value for
144 the data source will be used. The specified times are in UTC. Examples
145 of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,
146 jun 13:15, and first sunday of quarter 00:00. See more explanation
147 about the format here:
148 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
149 NOTE: the granularity should be at least 8 hours, or less frequent.
150 type: string
151 scheduleOptions:
152 description: Options customizing the data transfer schedule.
153 properties:
154 disableAutoScheduling:
155 description: |-
156 If true, automatic scheduling of data transfer runs for this
157 configuration will be disabled. The runs can be started on ad-hoc
158 basis using transferConfigs.startManualRuns API. When automatic
159 scheduling is disabled, the TransferConfig.schedule field will
160 be ignored.
161 type: boolean
162 endTime:
163 description: |-
164 Defines time to stop scheduling transfer runs. A transfer run cannot be
165 scheduled at or after the end time. The end time can be changed at any
166 moment. The time when a data transfer can be triggered manually is not
167 limited by this option.
168 type: string
169 startTime:
170 description: |-
171 Specifies time to start scheduling transfer runs. The first run will be
172 scheduled at or after the start time according to a recurrence pattern
173 defined in the schedule string. The start time can be changed at any
174 moment. The time when a data transfer can be triggered manually is not
175 limited by this option.
176 type: string
177 type: object
178 sensitiveParams:
179 description: |-
180 Different parameters are configured primarily using the the 'params' field on this
181 resource. This block contains the parameters which contain secrets or passwords so that they can be marked
182 sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key
183 in the 'params' map in the api request.
184
185 Credentials may not be specified in both locations and will cause an error. Changing from one location
186 to a different credential configuration in the config will require an apply to update state.
187 properties:
188 secretAccessKey:
189 description: The Secret Access Key of the AWS account transferring
190 data from.
191 oneOf:
192 - not:
193 required:
194 - valueFrom
195 required:
196 - value
197 - not:
198 required:
199 - value
200 required:
201 - valueFrom
202 properties:
203 value:
204 description: Value of the field. Cannot be used if 'valueFrom'
205 is specified.
206 type: string
207 valueFrom:
208 description: Source for the field's value. Cannot be used
209 if 'value' is specified.
210 properties:
211 secretKeyRef:
212 description: Reference to a value with the given key in
213 the given Secret in the resource's namespace.
214 properties:
215 key:
216 description: Key that identifies the value to be extracted.
217 type: string
218 name:
219 description: Name of the Secret to extract a value
220 from.
221 type: string
222 required:
223 - name
224 - key
225 type: object
226 type: object
227 type: object
228 required:
229 - secretAccessKey
230 type: object
231 serviceAccountName:
232 description: |-
233 Immutable. Service account email. If this field is set, transfer config will
234 be created with this service account credentials. It requires that
235 requesting user calling this API has permissions to act as this service account.
236 type: string
237 required:
238 - dataSourceId
239 - displayName
240 - params
241 - projectRef
242 type: object
243 status:
244 properties:
245 conditions:
246 description: Conditions represent the latest available observation
247 of the resource's current state.
248 items:
249 properties:
250 lastTransitionTime:
251 description: Last time the condition transitioned from one status
252 to another.
253 type: string
254 message:
255 description: Human-readable message indicating details about
256 last transition.
257 type: string
258 reason:
259 description: Unique, one-word, CamelCase reason for the condition's
260 last transition.
261 type: string
262 status:
263 description: Status is the status of the condition. Can be True,
264 False, Unknown.
265 type: string
266 type:
267 description: Type is the type of the condition.
268 type: string
269 type: object
270 type: array
271 name:
272 description: |-
273 The resource name of the transfer config. Transfer config names have the
274 form projects/{projectId}/locations/{location}/transferConfigs/{configId}.
275 Where configId is usually a uuid, but this is not required.
276 The name is ignored when creating a transfer config.
277 type: string
278 observedGeneration:
279 description: ObservedGeneration is the generation of the resource
280 that was most recently observed by the Config Connector controller.
281 If this is equal to metadata.generation, then that means that the
282 current reported status reflects the most recent desired state of
283 the resource.
284 type: integer
285 type: object
286 required:
287 - spec
288 type: object
289 served: true
290 storage: true
291 subresources:
292 status: {}
293status:
294 acceptedNames:
295 kind: ""
296 plural: ""
297 conditions: []
298 storedVersions: []
View as plain text