-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
datamigration_v1.projects.locations.connectionProfiles.html
1225 lines (1166 loc) 路 170 KB
/
datamigration_v1.projects.locations.connectionProfiles.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="datamigration_v1.html">Database Migration API</a> . <a href="datamigration_v1.projects.html">projects</a> . <a href="datamigration_v1.projects.locations.html">locations</a> . <a href="datamigration_v1.projects.locations.connectionProfiles.html">connectionProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new connection profile in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single connection profile.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of all connection profiles in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the configuration of a single connection profile.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new connection profile in a given project and location.
Args:
parent: string, Required. The parent which owns this collection of connection profiles. (required)
body: object, The request body.
The object takes the form of:
{ # A connection profile definition.
"alloydb": { # Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. # An AlloyDB cluster connection profile.
"clusterId": "A String", # Required. The AlloyDB cluster ID that this connection profile is associated with.
"settings": { # Settings for creating an AlloyDB cluster. # Immutable. Metadata used to create the destination AlloyDB cluster.
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Required. Input only. Initial user to setup during cluster creation. Required.
"password": "A String", # The initial password for the user.
"passwordSet": True or False, # Output only. Indicates if the initial_user.password field has been set.
"user": "A String", # The database username.
},
"labels": { # Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"primaryInstanceSettings": { # Settings for the cluster's primary instance
"databaseFlags": { # Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.
"a_key": "A String",
},
"id": "A String", # Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".
"labels": { # Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configuration for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"privateIp": "A String", # Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
},
"vpcNetwork": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
},
},
"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.
"additionalPublicIp": "A String", # Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.
"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.
"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.
"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.
"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
"availabilityType": "A String", # Optional. Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data availability. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
"cmekKeyName": "A String", # The KMS key name used for the csql instance.
"collation": "A String", # The Cloud SQL default instance level collation.
"dataCacheConfig": { # Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. # Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation.
"dataCacheEnabled": True or False, # Optional. Whether data cache is enabled for the instance.
},
"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.
"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"databaseVersion": "A String", # The database engine type and version.
"edition": "A String", # Optional. The edition of the given Cloud SQL instance.
"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
"allocatedIpRange": "A String", # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).
{ # An entry for an Access Control list.
"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.
"label": "A String", # A label to identify this entry.
"ttl": "A String", # Input only. The time-to-leave of this access control entry.
"value": "A String", # The allowlisted value for the access control list.
},
],
"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.
"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.
"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
},
"rootPassword": "A String", # Input only. Initial root password.
"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.
"secondaryZone": "A String", # Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
"a_key": "A String",
},
"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL database instance is located.
},
},
"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
"displayName": "A String", # The connection profile display name.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
"a_key": "A String",
},
"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source MySQL database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source MySQL database.
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
"oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile.
"databaseService": "A String", # Required. Database service for the Oracle connection.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source Oracle database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source Oracle database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"ssl": { # SSL configuration information. # SSL configuration for the connection to the source Oracle database. * Only `SERVER_ONLY` configuration is supported for Oracle SSL. * SSL is supported for Oracle versions 12 and above.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile.
"alloydbClusterId": "A String", # Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source PostgreSQL database.
"networkArchitecture": "A String", # Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source PostgreSQL database.
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"provider": "A String", # The database provider.
"sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source.
"backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
"gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases.
"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups.
},
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source SQL Server database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source SQL Server database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static IP connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).
"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
}
connectionProfileId: string, Required. The connection profile identifier.
requestId: string, Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation: boolean, Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
validateOnly: boolean, Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
<pre>Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Args:
name: string, Required. Name of the connection profile resource to delete. (required)
force: boolean, In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).
requestId: string, A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single connection profile.
Args:
name: string, Required. Name of the connection profile resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A connection profile definition.
"alloydb": { # Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. # An AlloyDB cluster connection profile.
"clusterId": "A String", # Required. The AlloyDB cluster ID that this connection profile is associated with.
"settings": { # Settings for creating an AlloyDB cluster. # Immutable. Metadata used to create the destination AlloyDB cluster.
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Required. Input only. Initial user to setup during cluster creation. Required.
"password": "A String", # The initial password for the user.
"passwordSet": True or False, # Output only. Indicates if the initial_user.password field has been set.
"user": "A String", # The database username.
},
"labels": { # Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"primaryInstanceSettings": { # Settings for the cluster's primary instance
"databaseFlags": { # Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.
"a_key": "A String",
},
"id": "A String", # Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".
"labels": { # Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configuration for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"privateIp": "A String", # Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
},
"vpcNetwork": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
},
},
"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.
"additionalPublicIp": "A String", # Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.
"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.
"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.
"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.
"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
"availabilityType": "A String", # Optional. Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data availability. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
"cmekKeyName": "A String", # The KMS key name used for the csql instance.
"collation": "A String", # The Cloud SQL default instance level collation.
"dataCacheConfig": { # Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. # Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation.
"dataCacheEnabled": True or False, # Optional. Whether data cache is enabled for the instance.
},
"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.
"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"databaseVersion": "A String", # The database engine type and version.
"edition": "A String", # Optional. The edition of the given Cloud SQL instance.
"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
"allocatedIpRange": "A String", # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).
{ # An entry for an Access Control list.
"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.
"label": "A String", # A label to identify this entry.
"ttl": "A String", # Input only. The time-to-leave of this access control entry.
"value": "A String", # The allowlisted value for the access control list.
},
],
"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.
"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.
"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
},
"rootPassword": "A String", # Input only. Initial root password.
"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.
"secondaryZone": "A String", # Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
"a_key": "A String",
},
"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL database instance is located.
},
},
"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
"displayName": "A String", # The connection profile display name.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
"a_key": "A String",
},
"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source MySQL database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source MySQL database.
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
"oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile.
"databaseService": "A String", # Required. Database service for the Oracle connection.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source Oracle database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source Oracle database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"ssl": { # SSL configuration information. # SSL configuration for the connection to the source Oracle database. * Only `SERVER_ONLY` configuration is supported for Oracle SSL. * SSL is supported for Oracle versions 12 and above.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile.
"alloydbClusterId": "A String", # Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source PostgreSQL database.
"networkArchitecture": "A String", # Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source PostgreSQL database.
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"provider": "A String", # The database provider.
"sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source.
"backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
"gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases.
"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups.
},
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source SQL Server database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source SQL Server database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static IP connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).
"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves a list of all connection profiles in a given project and location.
Args:
parent: string, Required. The parent which owns this collection of connection profiles. (required)
filter: string, A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can also filter nested fields. For example, you could specify **mySql.username = %lt;my_username%gt;** to list all connection profiles configured to connect with a specific username.
orderBy: string, A comma-separated list of fields to order results according to.
pageSize: integer, The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
pageToken: string, A page token, received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for 'ListConnectionProfiles' request.
"connectionProfiles": [ # The response list of connection profiles.
{ # A connection profile definition.
"alloydb": { # Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. # An AlloyDB cluster connection profile.
"clusterId": "A String", # Required. The AlloyDB cluster ID that this connection profile is associated with.
"settings": { # Settings for creating an AlloyDB cluster. # Immutable. Metadata used to create the destination AlloyDB cluster.
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Required. Input only. Initial user to setup during cluster creation. Required.
"password": "A String", # The initial password for the user.
"passwordSet": True or False, # Output only. Indicates if the initial_user.password field has been set.
"user": "A String", # The database username.
},
"labels": { # Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"primaryInstanceSettings": { # Settings for the cluster's primary instance
"databaseFlags": { # Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.
"a_key": "A String",
},
"id": "A String", # Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".
"labels": { # Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configuration for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"privateIp": "A String", # Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
},
"vpcNetwork": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
},
},
"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.
"additionalPublicIp": "A String", # Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.
"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.
"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.
"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.
"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
"availabilityType": "A String", # Optional. Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data availability. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
"cmekKeyName": "A String", # The KMS key name used for the csql instance.
"collation": "A String", # The Cloud SQL default instance level collation.
"dataCacheConfig": { # Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. # Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation.
"dataCacheEnabled": True or False, # Optional. Whether data cache is enabled for the instance.
},
"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.
"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"databaseVersion": "A String", # The database engine type and version.
"edition": "A String", # Optional. The edition of the given Cloud SQL instance.
"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
"allocatedIpRange": "A String", # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).
{ # An entry for an Access Control list.
"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.
"label": "A String", # A label to identify this entry.
"ttl": "A String", # Input only. The time-to-leave of this access control entry.
"value": "A String", # The allowlisted value for the access control list.
},
],
"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.
"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.
"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
},
"rootPassword": "A String", # Input only. Initial root password.
"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.
"secondaryZone": "A String", # Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
"a_key": "A String",
},
"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL database instance is located.
},
},
"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
"displayName": "A String", # The connection profile display name.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
"a_key": "A String",
},
"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source MySQL database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source MySQL database.
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
"oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile.
"databaseService": "A String", # Required. Database service for the Oracle connection.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source Oracle database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source Oracle database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"ssl": { # SSL configuration information. # SSL configuration for the connection to the source Oracle database. * Only `SERVER_ONLY` configuration is supported for Oracle SSL. * SSL is supported for Oracle versions 12 and above.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile.
"alloydbClusterId": "A String", # Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source PostgreSQL database.
"networkArchitecture": "A String", # Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source PostgreSQL database.
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"provider": "A String", # The database provider.
"sqlserver": { # Specifies connection parameters required specifically for SQL Server databases. # Connection profile for a SQL Server data source.
"backups": { # Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. # The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.
"gcsBucket": "A String", # Required. The Cloud Storage bucket that stores backups for all replicated databases.
"gcsPrefix": "A String", # Optional. Cloud Storage path inside the bucket that stores backups.
},
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"host": "A String", # Required. The IP or hostname of the source SQL Server database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates whether a new password is included in the request.
"port": 42, # Required. The network port of the source SQL Server database.
"privateConnectivity": { # Private Connectivity. # Private connectivity.
"privateConnection": "A String", # Required. The resource name (URI) of the private connection.
},
"privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity.
"serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}
},
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"staticIpConnectivity": { # The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static IP connectivity data (default, no additional details needed).
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).
"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
},
],
"nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Update the configuration of a single connection profile.
Args:
name: string, The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. (required)
body: object, The request body.
The object takes the form of:
{ # A connection profile definition.
"alloydb": { # Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. # An AlloyDB cluster connection profile.
"clusterId": "A String", # Required. The AlloyDB cluster ID that this connection profile is associated with.
"settings": { # Settings for creating an AlloyDB cluster. # Immutable. Metadata used to create the destination AlloyDB cluster.
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field. If a database version is not supplied at cluster creation time, then a default database version will be used.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Required. Input only. Initial user to setup during cluster creation. Required.
"password": "A String", # The initial password for the user.
"passwordSet": True or False, # Output only. Indicates if the initial_user.password field has been set.
"user": "A String", # The database username.
},
"labels": { # Labels for the AlloyDB cluster created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"primaryInstanceSettings": { # Settings for the cluster's primary instance
"databaseFlags": { # Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used.
"a_key": "A String",
},
"id": "A String", # Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+".
"labels": { # Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs.
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configuration for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"privateIp": "A String", # Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.
},
"vpcNetwork": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
},
},
"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.
"additionalPublicIp": "A String", # Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.
"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.
"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.
"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.
"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
"availabilityType": "A String", # Optional. Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data availability. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
"cmekKeyName": "A String", # The KMS key name used for the csql instance.
"collation": "A String", # The Cloud SQL default instance level collation.
"dataCacheConfig": { # Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. # Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation.
"dataCacheEnabled": True or False, # Optional. Whether data cache is enabled for the instance.
},
"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.
"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
"a_key": "A String",
},
"databaseVersion": "A String", # The database engine type and version.
"edition": "A String", # Optional. The edition of the given Cloud SQL instance.
"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.
"allocatedIpRange": "A String", # Optional. The name of the allocated IP address range for the private IP Cloud SQL instance. This name refers to an already allocated IP range address. If set, the instance IP address will be created in the allocated range. Note that this IP address range can't be modified after the instance is created. If you change the VPC when configuring connectivity settings for the migration job, this field is not relevant.
"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).
{ # An entry for an Access Control list.
"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.
"label": "A String", # A label to identify this entry.
"ttl": "A String", # Input only. The time-to-leave of this access control entry.
"value": "A String", # The allowlisted value for the access control list.
},
],
"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.
"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.
"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
},
"rootPassword": "A String", # Input only. Initial root password.
"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.
"secondaryZone": "A String", # Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`
"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).
"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.
"a_key": "A String",
},
"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL database instance is located.
},
},
"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
"displayName": "A String", # The connection profile display name.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
"a_key": "A String",
},
"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.
"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
"host": "A String", # Required. The IP or hostname of the source MySQL database.
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.
"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.
"port": 42, # Required. The network port of the source MySQL database.
"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.
"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.
"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.
"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.
"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.
},
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.
},
"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
"oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile.
"databaseService": "A String", # Required. Database service for the Oracle connection.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},