aws-sdk-docdb 1.45.0 → 1.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,14 +12,6 @@ module Aws::DocDB
12
12
 
13
13
  # Represents the input to AddSourceIdentifierToSubscription.
14
14
  #
15
- # @note When making an API call, you may pass AddSourceIdentifierToSubscriptionMessage
16
- # data as a hash:
17
- #
18
- # {
19
- # subscription_name: "String", # required
20
- # source_identifier: "String", # required
21
- # }
22
- #
23
15
  # @!attribute [rw] subscription_name
24
16
  # The name of the Amazon DocumentDB event notification subscription
25
17
  # that you want to add a source identifier to.
@@ -64,19 +56,6 @@ module Aws::DocDB
64
56
 
65
57
  # Represents the input to AddTagsToResource.
66
58
  #
67
- # @note When making an API call, you may pass AddTagsToResourceMessage
68
- # data as a hash:
69
- #
70
- # {
71
- # resource_name: "String", # required
72
- # tags: [ # required
73
- # {
74
- # key: "String",
75
- # value: "String",
76
- # },
77
- # ],
78
- # }
79
- #
80
59
  # @!attribute [rw] resource_name
81
60
  # The Amazon DocumentDB resource that the tags are added to. This
82
61
  # value is an Amazon Resource Name .
@@ -97,15 +76,6 @@ module Aws::DocDB
97
76
 
98
77
  # Represents the input to ApplyPendingMaintenanceAction.
99
78
  #
100
- # @note When making an API call, you may pass ApplyPendingMaintenanceActionMessage
101
- # data as a hash:
102
- #
103
- # {
104
- # resource_identifier: "String", # required
105
- # apply_action: "String", # required
106
- # opt_in_type: "String", # required
107
- # }
108
- #
109
79
  # @!attribute [rw] resource_identifier
110
80
  # The Amazon Resource Name (ARN) of the resource that the pending
111
81
  # maintenance action applies to.
@@ -263,14 +233,6 @@ module Aws::DocDB
263
233
  # are exported (or not exported) to CloudWatch Logs. The values within
264
234
  # these arrays depend on the engine that is being used.
265
235
  #
266
- # @note When making an API call, you may pass CloudwatchLogsExportConfiguration
267
- # data as a hash:
268
- #
269
- # {
270
- # enable_log_types: ["String"],
271
- # disable_log_types: ["String"],
272
- # }
273
- #
274
236
  # @!attribute [rw] enable_log_types
275
237
  # The list of log types to enable.
276
238
  # @return [Array<String>]
@@ -290,21 +252,6 @@ module Aws::DocDB
290
252
 
291
253
  # Represents the input to CopyDBClusterParameterGroup.
292
254
  #
293
- # @note When making an API call, you may pass CopyDBClusterParameterGroupMessage
294
- # data as a hash:
295
- #
296
- # {
297
- # source_db_cluster_parameter_group_identifier: "String", # required
298
- # target_db_cluster_parameter_group_identifier: "String", # required
299
- # target_db_cluster_parameter_group_description: "String", # required
300
- # tags: [
301
- # {
302
- # key: "String",
303
- # value: "String",
304
- # },
305
- # ],
306
- # }
307
- #
308
255
  # @!attribute [rw] source_db_cluster_parameter_group_identifier
309
256
  # The identifier or Amazon Resource Name (ARN) for the source cluster
310
257
  # parameter group.
@@ -373,24 +320,6 @@ module Aws::DocDB
373
320
 
374
321
  # Represents the input to CopyDBClusterSnapshot.
375
322
  #
376
- # @note When making an API call, you may pass CopyDBClusterSnapshotMessage
377
- # data as a hash:
378
- #
379
- # {
380
- # source_db_cluster_snapshot_identifier: "String", # required
381
- # target_db_cluster_snapshot_identifier: "String", # required
382
- # kms_key_id: "String",
383
- # pre_signed_url: "String",
384
- # copy_tags: false,
385
- # tags: [
386
- # {
387
- # key: "String",
388
- # value: "String",
389
- # },
390
- # ],
391
- # source_region: "String",
392
- # }
393
- #
394
323
  # @!attribute [rw] source_db_cluster_snapshot_identifier
395
324
  # The identifier of the cluster snapshot to copy. This parameter is
396
325
  # not case sensitive.
@@ -530,38 +459,6 @@ module Aws::DocDB
530
459
 
531
460
  # Represents the input to CreateDBCluster.
532
461
  #
533
- # @note When making an API call, you may pass CreateDBClusterMessage
534
- # data as a hash:
535
- #
536
- # {
537
- # availability_zones: ["String"],
538
- # backup_retention_period: 1,
539
- # db_cluster_identifier: "String", # required
540
- # db_cluster_parameter_group_name: "String",
541
- # vpc_security_group_ids: ["String"],
542
- # db_subnet_group_name: "String",
543
- # engine: "String", # required
544
- # engine_version: "String",
545
- # port: 1,
546
- # master_username: "String",
547
- # master_user_password: "String",
548
- # preferred_backup_window: "String",
549
- # preferred_maintenance_window: "String",
550
- # tags: [
551
- # {
552
- # key: "String",
553
- # value: "String",
554
- # },
555
- # ],
556
- # storage_encrypted: false,
557
- # kms_key_id: "String",
558
- # pre_signed_url: "String",
559
- # enable_cloudwatch_logs_exports: ["String"],
560
- # deletion_protection: false,
561
- # global_cluster_identifier: "GlobalClusterIdentifier",
562
- # source_region: "String",
563
- # }
564
- #
565
462
  # @!attribute [rw] availability_zones
566
463
  # A list of Amazon EC2 Availability Zones that instances in the
567
464
  # cluster can be created in.
@@ -777,21 +674,6 @@ module Aws::DocDB
777
674
 
778
675
  # Represents the input of CreateDBClusterParameterGroup.
779
676
  #
780
- # @note When making an API call, you may pass CreateDBClusterParameterGroupMessage
781
- # data as a hash:
782
- #
783
- # {
784
- # db_cluster_parameter_group_name: "String", # required
785
- # db_parameter_group_family: "String", # required
786
- # description: "String", # required
787
- # tags: [
788
- # {
789
- # key: "String",
790
- # value: "String",
791
- # },
792
- # ],
793
- # }
794
- #
795
677
  # @!attribute [rw] db_cluster_parameter_group_name
796
678
  # The name of the cluster parameter group.
797
679
  #
@@ -855,20 +737,6 @@ module Aws::DocDB
855
737
 
856
738
  # Represents the input of CreateDBClusterSnapshot.
857
739
  #
858
- # @note When making an API call, you may pass CreateDBClusterSnapshotMessage
859
- # data as a hash:
860
- #
861
- # {
862
- # db_cluster_snapshot_identifier: "String", # required
863
- # db_cluster_identifier: "String", # required
864
- # tags: [
865
- # {
866
- # key: "String",
867
- # value: "String",
868
- # },
869
- # ],
870
- # }
871
- #
872
740
  # @!attribute [rw] db_cluster_snapshot_identifier
873
741
  # The identifier of the cluster snapshot. This parameter is stored as
874
742
  # a lowercase string.
@@ -925,29 +793,6 @@ module Aws::DocDB
925
793
 
926
794
  # Represents the input to CreateDBInstance.
927
795
  #
928
- # @note When making an API call, you may pass CreateDBInstanceMessage
929
- # data as a hash:
930
- #
931
- # {
932
- # db_instance_identifier: "String", # required
933
- # db_instance_class: "String", # required
934
- # engine: "String", # required
935
- # availability_zone: "String",
936
- # preferred_maintenance_window: "String",
937
- # auto_minor_version_upgrade: false,
938
- # tags: [
939
- # {
940
- # key: "String",
941
- # value: "String",
942
- # },
943
- # ],
944
- # db_cluster_identifier: "String", # required
945
- # copy_tags_to_snapshot: false,
946
- # promotion_tier: 1,
947
- # enable_performance_insights: false,
948
- # performance_insights_kms_key_id: "String",
949
- # }
950
- #
951
796
  # @!attribute [rw] db_instance_identifier
952
797
  # The instance identifier. This parameter is stored as a lowercase
953
798
  # string.
@@ -1086,21 +931,6 @@ module Aws::DocDB
1086
931
 
1087
932
  # Represents the input to CreateDBSubnetGroup.
1088
933
  #
1089
- # @note When making an API call, you may pass CreateDBSubnetGroupMessage
1090
- # data as a hash:
1091
- #
1092
- # {
1093
- # db_subnet_group_name: "String", # required
1094
- # db_subnet_group_description: "String", # required
1095
- # subnet_ids: ["String"], # required
1096
- # tags: [
1097
- # {
1098
- # key: "String",
1099
- # value: "String",
1100
- # },
1101
- # ],
1102
- # }
1103
- #
1104
934
  # @!attribute [rw] db_subnet_group_name
1105
935
  # The name for the subnet group. This value is stored as a lowercase
1106
936
  # string.
@@ -1148,24 +978,6 @@ module Aws::DocDB
1148
978
 
1149
979
  # Represents the input to CreateEventSubscription.
1150
980
  #
1151
- # @note When making an API call, you may pass CreateEventSubscriptionMessage
1152
- # data as a hash:
1153
- #
1154
- # {
1155
- # subscription_name: "String", # required
1156
- # sns_topic_arn: "String", # required
1157
- # source_type: "String",
1158
- # event_categories: ["String"],
1159
- # source_ids: ["String"],
1160
- # enabled: false,
1161
- # tags: [
1162
- # {
1163
- # key: "String",
1164
- # value: "String",
1165
- # },
1166
- # ],
1167
- # }
1168
- #
1169
981
  # @!attribute [rw] subscription_name
1170
982
  # The name of the subscription.
1171
983
  #
@@ -1254,19 +1066,6 @@ module Aws::DocDB
1254
1066
 
1255
1067
  # Represents the input to CreateGlobalCluster.
1256
1068
  #
1257
- # @note When making an API call, you may pass CreateGlobalClusterMessage
1258
- # data as a hash:
1259
- #
1260
- # {
1261
- # global_cluster_identifier: "GlobalClusterIdentifier", # required
1262
- # source_db_cluster_identifier: "String",
1263
- # engine: "String",
1264
- # engine_version: "String",
1265
- # deletion_protection: false,
1266
- # database_name: "String",
1267
- # storage_encrypted: false,
1268
- # }
1269
- #
1270
1069
  # @!attribute [rw] global_cluster_identifier
1271
1070
  # The cluster identifier of the new global cluster.
1272
1071
  # @return [String]
@@ -2385,15 +2184,6 @@ module Aws::DocDB
2385
2184
 
2386
2185
  # Represents the input to DeleteDBCluster.
2387
2186
  #
2388
- # @note When making an API call, you may pass DeleteDBClusterMessage
2389
- # data as a hash:
2390
- #
2391
- # {
2392
- # db_cluster_identifier: "String", # required
2393
- # skip_final_snapshot: false,
2394
- # final_db_snapshot_identifier: "String",
2395
- # }
2396
- #
2397
2187
  # @!attribute [rw] db_cluster_identifier
2398
2188
  # The cluster identifier for the cluster to be deleted. This parameter
2399
2189
  # isn't case sensitive.
@@ -2449,13 +2239,6 @@ module Aws::DocDB
2449
2239
 
2450
2240
  # Represents the input to DeleteDBClusterParameterGroup.
2451
2241
  #
2452
- # @note When making an API call, you may pass DeleteDBClusterParameterGroupMessage
2453
- # data as a hash:
2454
- #
2455
- # {
2456
- # db_cluster_parameter_group_name: "String", # required
2457
- # }
2458
- #
2459
2242
  # @!attribute [rw] db_cluster_parameter_group_name
2460
2243
  # The name of the cluster parameter group.
2461
2244
  #
@@ -2490,13 +2273,6 @@ module Aws::DocDB
2490
2273
 
2491
2274
  # Represents the input to DeleteDBClusterSnapshot.
2492
2275
  #
2493
- # @note When making an API call, you may pass DeleteDBClusterSnapshotMessage
2494
- # data as a hash:
2495
- #
2496
- # {
2497
- # db_cluster_snapshot_identifier: "String", # required
2498
- # }
2499
- #
2500
2276
  # @!attribute [rw] db_cluster_snapshot_identifier
2501
2277
  # The identifier of the cluster snapshot to delete.
2502
2278
  #
@@ -2526,13 +2302,6 @@ module Aws::DocDB
2526
2302
 
2527
2303
  # Represents the input to DeleteDBInstance.
2528
2304
  #
2529
- # @note When making an API call, you may pass DeleteDBInstanceMessage
2530
- # data as a hash:
2531
- #
2532
- # {
2533
- # db_instance_identifier: "String", # required
2534
- # }
2535
- #
2536
2305
  # @!attribute [rw] db_instance_identifier
2537
2306
  # The instance identifier for the instance to be deleted. This
2538
2307
  # parameter isn't case sensitive.
@@ -2566,13 +2335,6 @@ module Aws::DocDB
2566
2335
 
2567
2336
  # Represents the input to DeleteDBSubnetGroup.
2568
2337
  #
2569
- # @note When making an API call, you may pass DeleteDBSubnetGroupMessage
2570
- # data as a hash:
2571
- #
2572
- # {
2573
- # db_subnet_group_name: "String", # required
2574
- # }
2575
- #
2576
2338
  # @!attribute [rw] db_subnet_group_name
2577
2339
  # The name of the database subnet group to delete.
2578
2340
  #
@@ -2598,13 +2360,6 @@ module Aws::DocDB
2598
2360
 
2599
2361
  # Represents the input to DeleteEventSubscription.
2600
2362
  #
2601
- # @note When making an API call, you may pass DeleteEventSubscriptionMessage
2602
- # data as a hash:
2603
- #
2604
- # {
2605
- # subscription_name: "String", # required
2606
- # }
2607
- #
2608
2363
  # @!attribute [rw] subscription_name
2609
2364
  # The name of the Amazon DocumentDB event notification subscription
2610
2365
  # that you want to delete.
@@ -2632,13 +2387,6 @@ module Aws::DocDB
2632
2387
 
2633
2388
  # Represents the input to DeleteGlobalCluster.
2634
2389
  #
2635
- # @note When making an API call, you may pass DeleteGlobalClusterMessage
2636
- # data as a hash:
2637
- #
2638
- # {
2639
- # global_cluster_identifier: "GlobalClusterIdentifier", # required
2640
- # }
2641
- #
2642
2390
  # @!attribute [rw] global_cluster_identifier
2643
2391
  # The cluster identifier of the global cluster being deleted.
2644
2392
  # @return [String]
@@ -2663,21 +2411,6 @@ module Aws::DocDB
2663
2411
  include Aws::Structure
2664
2412
  end
2665
2413
 
2666
- # @note When making an API call, you may pass DescribeCertificatesMessage
2667
- # data as a hash:
2668
- #
2669
- # {
2670
- # certificate_identifier: "String",
2671
- # filters: [
2672
- # {
2673
- # name: "String", # required
2674
- # values: ["String"], # required
2675
- # },
2676
- # ],
2677
- # max_records: 1,
2678
- # marker: "String",
2679
- # }
2680
- #
2681
2414
  # @!attribute [rw] certificate_identifier
2682
2415
  # The user-supplied certificate identifier. If this parameter is
2683
2416
  # specified, information for only the specified certificate is
@@ -2730,21 +2463,6 @@ module Aws::DocDB
2730
2463
 
2731
2464
  # Represents the input to DescribeDBClusterParameterGroups.
2732
2465
  #
2733
- # @note When making an API call, you may pass DescribeDBClusterParameterGroupsMessage
2734
- # data as a hash:
2735
- #
2736
- # {
2737
- # db_cluster_parameter_group_name: "String",
2738
- # filters: [
2739
- # {
2740
- # name: "String", # required
2741
- # values: ["String"], # required
2742
- # },
2743
- # ],
2744
- # max_records: 1,
2745
- # marker: "String",
2746
- # }
2747
- #
2748
2466
  # @!attribute [rw] db_cluster_parameter_group_name
2749
2467
  # The name of a specific cluster parameter group to return details
2750
2468
  # for.
@@ -2791,22 +2509,6 @@ module Aws::DocDB
2791
2509
 
2792
2510
  # Represents the input to DescribeDBClusterParameters.
2793
2511
  #
2794
- # @note When making an API call, you may pass DescribeDBClusterParametersMessage
2795
- # data as a hash:
2796
- #
2797
- # {
2798
- # db_cluster_parameter_group_name: "String", # required
2799
- # source: "String",
2800
- # filters: [
2801
- # {
2802
- # name: "String", # required
2803
- # values: ["String"], # required
2804
- # },
2805
- # ],
2806
- # max_records: 1,
2807
- # marker: "String",
2808
- # }
2809
- #
2810
2512
  # @!attribute [rw] db_cluster_parameter_group_name
2811
2513
  # The name of a specific cluster parameter group to return parameter
2812
2514
  # details for.
@@ -2859,13 +2561,6 @@ module Aws::DocDB
2859
2561
 
2860
2562
  # Represents the input to DescribeDBClusterSnapshotAttributes.
2861
2563
  #
2862
- # @note When making an API call, you may pass DescribeDBClusterSnapshotAttributesMessage
2863
- # data as a hash:
2864
- #
2865
- # {
2866
- # db_cluster_snapshot_identifier: "String", # required
2867
- # }
2868
- #
2869
2564
  # @!attribute [rw] db_cluster_snapshot_identifier
2870
2565
  # The identifier for the cluster snapshot to describe the attributes
2871
2566
  # for.
@@ -2894,25 +2589,6 @@ module Aws::DocDB
2894
2589
 
2895
2590
  # Represents the input to DescribeDBClusterSnapshots.
2896
2591
  #
2897
- # @note When making an API call, you may pass DescribeDBClusterSnapshotsMessage
2898
- # data as a hash:
2899
- #
2900
- # {
2901
- # db_cluster_identifier: "String",
2902
- # db_cluster_snapshot_identifier: "String",
2903
- # snapshot_type: "String",
2904
- # filters: [
2905
- # {
2906
- # name: "String", # required
2907
- # values: ["String"], # required
2908
- # },
2909
- # ],
2910
- # max_records: 1,
2911
- # marker: "String",
2912
- # include_shared: false,
2913
- # include_public: false,
2914
- # }
2915
- #
2916
2592
  # @!attribute [rw] db_cluster_identifier
2917
2593
  # The ID of the cluster to retrieve the list of cluster snapshots for.
2918
2594
  # This parameter can't be used with the `DBClusterSnapshotIdentifier`
@@ -3019,21 +2695,6 @@ module Aws::DocDB
3019
2695
 
3020
2696
  # Represents the input to DescribeDBClusters.
3021
2697
  #
3022
- # @note When making an API call, you may pass DescribeDBClustersMessage
3023
- # data as a hash:
3024
- #
3025
- # {
3026
- # db_cluster_identifier: "String",
3027
- # filters: [
3028
- # {
3029
- # name: "String", # required
3030
- # values: ["String"], # required
3031
- # },
3032
- # ],
3033
- # max_records: 1,
3034
- # marker: "String",
3035
- # }
3036
- #
3037
2698
  # @!attribute [rw] db_cluster_identifier
3038
2699
  # The user-provided cluster identifier. If this parameter is
3039
2700
  # specified, information from only the specific cluster is returned.
@@ -3088,26 +2749,6 @@ module Aws::DocDB
3088
2749
 
3089
2750
  # Represents the input to DescribeDBEngineVersions.
3090
2751
  #
3091
- # @note When making an API call, you may pass DescribeDBEngineVersionsMessage
3092
- # data as a hash:
3093
- #
3094
- # {
3095
- # engine: "String",
3096
- # engine_version: "String",
3097
- # db_parameter_group_family: "String",
3098
- # filters: [
3099
- # {
3100
- # name: "String", # required
3101
- # values: ["String"], # required
3102
- # },
3103
- # ],
3104
- # max_records: 1,
3105
- # marker: "String",
3106
- # default_only: false,
3107
- # list_supported_character_sets: false,
3108
- # list_supported_timezones: false,
3109
- # }
3110
- #
3111
2752
  # @!attribute [rw] engine
3112
2753
  # The database engine to return.
3113
2754
  # @return [String]
@@ -3184,21 +2825,6 @@ module Aws::DocDB
3184
2825
 
3185
2826
  # Represents the input to DescribeDBInstances.
3186
2827
  #
3187
- # @note When making an API call, you may pass DescribeDBInstancesMessage
3188
- # data as a hash:
3189
- #
3190
- # {
3191
- # db_instance_identifier: "String",
3192
- # filters: [
3193
- # {
3194
- # name: "String", # required
3195
- # values: ["String"], # required
3196
- # },
3197
- # ],
3198
- # max_records: 1,
3199
- # marker: "String",
3200
- # }
3201
- #
3202
2828
  # @!attribute [rw] db_instance_identifier
3203
2829
  # The user-provided instance identifier. If this parameter is
3204
2830
  # specified, information from only the specific instance is returned.
@@ -3257,21 +2883,6 @@ module Aws::DocDB
3257
2883
 
3258
2884
  # Represents the input to DescribeDBSubnetGroups.
3259
2885
  #
3260
- # @note When making an API call, you may pass DescribeDBSubnetGroupsMessage
3261
- # data as a hash:
3262
- #
3263
- # {
3264
- # db_subnet_group_name: "String",
3265
- # filters: [
3266
- # {
3267
- # name: "String", # required
3268
- # values: ["String"], # required
3269
- # },
3270
- # ],
3271
- # max_records: 1,
3272
- # marker: "String",
3273
- # }
3274
- #
3275
2886
  # @!attribute [rw] db_subnet_group_name
3276
2887
  # The name of the subnet group to return details for.
3277
2888
  # @return [String]
@@ -3310,21 +2921,6 @@ module Aws::DocDB
3310
2921
 
3311
2922
  # Represents the input to DescribeEngineDefaultClusterParameters.
3312
2923
  #
3313
- # @note When making an API call, you may pass DescribeEngineDefaultClusterParametersMessage
3314
- # data as a hash:
3315
- #
3316
- # {
3317
- # db_parameter_group_family: "String", # required
3318
- # filters: [
3319
- # {
3320
- # name: "String", # required
3321
- # values: ["String"], # required
3322
- # },
3323
- # ],
3324
- # max_records: 1,
3325
- # marker: "String",
3326
- # }
3327
- #
3328
2924
  # @!attribute [rw] db_parameter_group_family
3329
2925
  # The name of the cluster parameter group family to return the engine
3330
2926
  # parameter information for.
@@ -3377,19 +2973,6 @@ module Aws::DocDB
3377
2973
 
3378
2974
  # Represents the input to DescribeEventCategories.
3379
2975
  #
3380
- # @note When making an API call, you may pass DescribeEventCategoriesMessage
3381
- # data as a hash:
3382
- #
3383
- # {
3384
- # source_type: "String",
3385
- # filters: [
3386
- # {
3387
- # name: "String", # required
3388
- # values: ["String"], # required
3389
- # },
3390
- # ],
3391
- # }
3392
- #
3393
2976
  # @!attribute [rw] source_type
3394
2977
  # The type of source that is generating the events.
3395
2978
  #
@@ -3412,21 +2995,6 @@ module Aws::DocDB
3412
2995
 
3413
2996
  # Represents the input to DescribeEventSubscriptions.
3414
2997
  #
3415
- # @note When making an API call, you may pass DescribeEventSubscriptionsMessage
3416
- # data as a hash:
3417
- #
3418
- # {
3419
- # subscription_name: "String",
3420
- # filters: [
3421
- # {
3422
- # name: "String", # required
3423
- # values: ["String"], # required
3424
- # },
3425
- # ],
3426
- # max_records: 1,
3427
- # marker: "String",
3428
- # }
3429
- #
3430
2998
  # @!attribute [rw] subscription_name
3431
2999
  # The name of the Amazon DocumentDB event notification subscription
3432
3000
  # that you want to describe.
@@ -3466,26 +3034,6 @@ module Aws::DocDB
3466
3034
 
3467
3035
  # Represents the input to DescribeEvents.
3468
3036
  #
3469
- # @note When making an API call, you may pass DescribeEventsMessage
3470
- # data as a hash:
3471
- #
3472
- # {
3473
- # source_identifier: "String",
3474
- # source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
3475
- # start_time: Time.now,
3476
- # end_time: Time.now,
3477
- # duration: 1,
3478
- # event_categories: ["String"],
3479
- # filters: [
3480
- # {
3481
- # name: "String", # required
3482
- # values: ["String"], # required
3483
- # },
3484
- # ],
3485
- # max_records: 1,
3486
- # marker: "String",
3487
- # }
3488
- #
3489
3037
  # @!attribute [rw] source_identifier
3490
3038
  # The identifier of the event source for which events are returned. If
3491
3039
  # not specified, then all sources are included in the response.
@@ -3577,21 +3125,6 @@ module Aws::DocDB
3577
3125
  include Aws::Structure
3578
3126
  end
3579
3127
 
3580
- # @note When making an API call, you may pass DescribeGlobalClustersMessage
3581
- # data as a hash:
3582
- #
3583
- # {
3584
- # global_cluster_identifier: "GlobalClusterIdentifier",
3585
- # filters: [
3586
- # {
3587
- # name: "String", # required
3588
- # values: ["String"], # required
3589
- # },
3590
- # ],
3591
- # max_records: 1,
3592
- # marker: "String",
3593
- # }
3594
- #
3595
3128
  # @!attribute [rw] global_cluster_identifier
3596
3129
  # The user-supplied cluster identifier. If this parameter is
3597
3130
  # specified, information from only the specific cluster is returned.
@@ -3633,25 +3166,6 @@ module Aws::DocDB
3633
3166
 
3634
3167
  # Represents the input to DescribeOrderableDBInstanceOptions.
3635
3168
  #
3636
- # @note When making an API call, you may pass DescribeOrderableDBInstanceOptionsMessage
3637
- # data as a hash:
3638
- #
3639
- # {
3640
- # engine: "String", # required
3641
- # engine_version: "String",
3642
- # db_instance_class: "String",
3643
- # license_model: "String",
3644
- # vpc: false,
3645
- # filters: [
3646
- # {
3647
- # name: "String", # required
3648
- # values: ["String"], # required
3649
- # },
3650
- # ],
3651
- # max_records: 1,
3652
- # marker: "String",
3653
- # }
3654
- #
3655
3169
  # @!attribute [rw] engine
3656
3170
  # The name of the engine to retrieve instance options for.
3657
3171
  # @return [String]
@@ -3714,21 +3228,6 @@ module Aws::DocDB
3714
3228
 
3715
3229
  # Represents the input to DescribePendingMaintenanceActions.
3716
3230
  #
3717
- # @note When making an API call, you may pass DescribePendingMaintenanceActionsMessage
3718
- # data as a hash:
3719
- #
3720
- # {
3721
- # resource_identifier: "String",
3722
- # filters: [
3723
- # {
3724
- # name: "String", # required
3725
- # values: ["String"], # required
3726
- # },
3727
- # ],
3728
- # marker: "String",
3729
- # max_records: 1,
3730
- # }
3731
- #
3732
3231
  # @!attribute [rw] resource_identifier
3733
3232
  # The ARN of a resource to return pending maintenance actions for.
3734
3233
  # @return [String]
@@ -4029,14 +3528,6 @@ module Aws::DocDB
4029
3528
 
4030
3529
  # Represents the input to FailoverDBCluster.
4031
3530
  #
4032
- # @note When making an API call, you may pass FailoverDBClusterMessage
4033
- # data as a hash:
4034
- #
4035
- # {
4036
- # db_cluster_identifier: "String",
4037
- # target_db_instance_identifier: "String",
4038
- # }
4039
- #
4040
3531
  # @!attribute [rw] db_cluster_identifier
4041
3532
  # A cluster identifier to force a failover for. This parameter is not
4042
3533
  # case sensitive.
@@ -4082,14 +3573,6 @@ module Aws::DocDB
4082
3573
  #
4083
3574
  # Wildcards are not supported in filters.
4084
3575
  #
4085
- # @note When making an API call, you may pass Filter
4086
- # data as a hash:
4087
- #
4088
- # {
4089
- # name: "String", # required
4090
- # values: ["String"], # required
4091
- # }
4092
- #
4093
3576
  # @!attribute [rw] name
4094
3577
  # The name of the filter. Filter names are case sensitive.
4095
3578
  # @return [String]
@@ -4355,19 +3838,6 @@ module Aws::DocDB
4355
3838
 
4356
3839
  # Represents the input to ListTagsForResource.
4357
3840
  #
4358
- # @note When making an API call, you may pass ListTagsForResourceMessage
4359
- # data as a hash:
4360
- #
4361
- # {
4362
- # resource_name: "String", # required
4363
- # filters: [
4364
- # {
4365
- # name: "String", # required
4366
- # values: ["String"], # required
4367
- # },
4368
- # ],
4369
- # }
4370
- #
4371
3841
  # @!attribute [rw] resource_name
4372
3842
  # The Amazon DocumentDB resource with tags to be listed. This value is
4373
3843
  # an Amazon Resource Name (ARN).
@@ -4388,28 +3858,6 @@ module Aws::DocDB
4388
3858
 
4389
3859
  # Represents the input to ModifyDBCluster.
4390
3860
  #
4391
- # @note When making an API call, you may pass ModifyDBClusterMessage
4392
- # data as a hash:
4393
- #
4394
- # {
4395
- # db_cluster_identifier: "String", # required
4396
- # new_db_cluster_identifier: "String",
4397
- # apply_immediately: false,
4398
- # backup_retention_period: 1,
4399
- # db_cluster_parameter_group_name: "String",
4400
- # vpc_security_group_ids: ["String"],
4401
- # port: 1,
4402
- # master_user_password: "String",
4403
- # preferred_backup_window: "String",
4404
- # preferred_maintenance_window: "String",
4405
- # cloudwatch_logs_export_configuration: {
4406
- # enable_log_types: ["String"],
4407
- # disable_log_types: ["String"],
4408
- # },
4409
- # engine_version: "String",
4410
- # deletion_protection: false,
4411
- # }
4412
- #
4413
3861
  # @!attribute [rw] db_cluster_identifier
4414
3862
  # The cluster identifier for the cluster that is being modified. This
4415
3863
  # parameter is not case sensitive.
@@ -4569,27 +4017,6 @@ module Aws::DocDB
4569
4017
 
4570
4018
  # Represents the input to ModifyDBClusterParameterGroup.
4571
4019
  #
4572
- # @note When making an API call, you may pass ModifyDBClusterParameterGroupMessage
4573
- # data as a hash:
4574
- #
4575
- # {
4576
- # db_cluster_parameter_group_name: "String", # required
4577
- # parameters: [ # required
4578
- # {
4579
- # parameter_name: "String",
4580
- # parameter_value: "String",
4581
- # description: "String",
4582
- # source: "String",
4583
- # apply_type: "String",
4584
- # data_type: "String",
4585
- # allowed_values: "String",
4586
- # is_modifiable: false,
4587
- # minimum_engine_version: "String",
4588
- # apply_method: "immediate", # accepts immediate, pending-reboot
4589
- # },
4590
- # ],
4591
- # }
4592
- #
4593
4020
  # @!attribute [rw] db_cluster_parameter_group_name
4594
4021
  # The name of the cluster parameter group to modify.
4595
4022
  # @return [String]
@@ -4621,16 +4048,6 @@ module Aws::DocDB
4621
4048
 
4622
4049
  # Represents the input to ModifyDBClusterSnapshotAttribute.
4623
4050
  #
4624
- # @note When making an API call, you may pass ModifyDBClusterSnapshotAttributeMessage
4625
- # data as a hash:
4626
- #
4627
- # {
4628
- # db_cluster_snapshot_identifier: "String", # required
4629
- # attribute_name: "String", # required
4630
- # values_to_add: ["String"],
4631
- # values_to_remove: ["String"],
4632
- # }
4633
- #
4634
4051
  # @!attribute [rw] db_cluster_snapshot_identifier
4635
4052
  # The identifier for the cluster snapshot to modify the attributes
4636
4053
  # for.
@@ -4697,23 +4114,6 @@ module Aws::DocDB
4697
4114
 
4698
4115
  # Represents the input to ModifyDBInstance.
4699
4116
  #
4700
- # @note When making an API call, you may pass ModifyDBInstanceMessage
4701
- # data as a hash:
4702
- #
4703
- # {
4704
- # db_instance_identifier: "String", # required
4705
- # db_instance_class: "String",
4706
- # apply_immediately: false,
4707
- # preferred_maintenance_window: "String",
4708
- # auto_minor_version_upgrade: false,
4709
- # new_db_instance_identifier: "String",
4710
- # ca_certificate_identifier: "String",
4711
- # copy_tags_to_snapshot: false,
4712
- # promotion_tier: 1,
4713
- # enable_performance_insights: false,
4714
- # performance_insights_kms_key_id: "String",
4715
- # }
4716
- #
4717
4117
  # @!attribute [rw] db_instance_identifier
4718
4118
  # The instance identifier. This value is stored as a lowercase string.
4719
4119
  #
@@ -4869,15 +4269,6 @@ module Aws::DocDB
4869
4269
 
4870
4270
  # Represents the input to ModifyDBSubnetGroup.
4871
4271
  #
4872
- # @note When making an API call, you may pass ModifyDBSubnetGroupMessage
4873
- # data as a hash:
4874
- #
4875
- # {
4876
- # db_subnet_group_name: "String", # required
4877
- # db_subnet_group_description: "String",
4878
- # subnet_ids: ["String"], # required
4879
- # }
4880
- #
4881
4272
  # @!attribute [rw] db_subnet_group_name
4882
4273
  # The name for the subnet group. This value is stored as a lowercase
4883
4274
  # string. You can't modify the default subnet group.
@@ -4920,17 +4311,6 @@ module Aws::DocDB
4920
4311
 
4921
4312
  # Represents the input to ModifyEventSubscription.
4922
4313
  #
4923
- # @note When making an API call, you may pass ModifyEventSubscriptionMessage
4924
- # data as a hash:
4925
- #
4926
- # {
4927
- # subscription_name: "String", # required
4928
- # sns_topic_arn: "String",
4929
- # source_type: "String",
4930
- # event_categories: ["String"],
4931
- # enabled: false,
4932
- # }
4933
- #
4934
4314
  # @!attribute [rw] subscription_name
4935
4315
  # The name of the Amazon DocumentDB event notification subscription.
4936
4316
  # @return [String]
@@ -4986,15 +4366,6 @@ module Aws::DocDB
4986
4366
 
4987
4367
  # Represents the input to ModifyGlobalCluster.
4988
4368
  #
4989
- # @note When making an API call, you may pass ModifyGlobalClusterMessage
4990
- # data as a hash:
4991
- #
4992
- # {
4993
- # global_cluster_identifier: "GlobalClusterIdentifier", # required
4994
- # new_global_cluster_identifier: "GlobalClusterIdentifier",
4995
- # deletion_protection: false,
4996
- # }
4997
- #
4998
4369
  # @!attribute [rw] global_cluster_identifier
4999
4370
  # The identifier for the global cluster being modified. This parameter
5000
4371
  # isn't case-sensitive.
@@ -5109,22 +4480,6 @@ module Aws::DocDB
5109
4480
 
5110
4481
  # Detailed information about an individual parameter.
5111
4482
  #
5112
- # @note When making an API call, you may pass Parameter
5113
- # data as a hash:
5114
- #
5115
- # {
5116
- # parameter_name: "String",
5117
- # parameter_value: "String",
5118
- # description: "String",
5119
- # source: "String",
5120
- # apply_type: "String",
5121
- # data_type: "String",
5122
- # allowed_values: "String",
5123
- # is_modifiable: false,
5124
- # minimum_engine_version: "String",
5125
- # apply_method: "immediate", # accepts immediate, pending-reboot
5126
- # }
5127
- #
5128
4483
  # @!attribute [rw] parameter_name
5129
4484
  # Specifies the name of the parameter.
5130
4485
  # @return [String]
@@ -5371,14 +4726,6 @@ module Aws::DocDB
5371
4726
 
5372
4727
  # Represents the input to RebootDBInstance.
5373
4728
  #
5374
- # @note When making an API call, you may pass RebootDBInstanceMessage
5375
- # data as a hash:
5376
- #
5377
- # {
5378
- # db_instance_identifier: "String", # required
5379
- # force_failover: false,
5380
- # }
5381
- #
5382
4729
  # @!attribute [rw] db_instance_identifier
5383
4730
  # The instance identifier. This parameter is stored as a lowercase
5384
4731
  # string.
@@ -5420,14 +4767,6 @@ module Aws::DocDB
5420
4767
 
5421
4768
  # Represents the input to RemoveFromGlobalCluster.
5422
4769
  #
5423
- # @note When making an API call, you may pass RemoveFromGlobalClusterMessage
5424
- # data as a hash:
5425
- #
5426
- # {
5427
- # global_cluster_identifier: "GlobalClusterIdentifier", # required
5428
- # db_cluster_identifier: "String", # required
5429
- # }
5430
- #
5431
4770
  # @!attribute [rw] global_cluster_identifier
5432
4771
  # The cluster identifier to detach from the Amazon DocumentDB global
5433
4772
  # cluster.
@@ -5461,14 +4800,6 @@ module Aws::DocDB
5461
4800
 
5462
4801
  # Represents the input to RemoveSourceIdentifierFromSubscription.
5463
4802
  #
5464
- # @note When making an API call, you may pass RemoveSourceIdentifierFromSubscriptionMessage
5465
- # data as a hash:
5466
- #
5467
- # {
5468
- # subscription_name: "String", # required
5469
- # source_identifier: "String", # required
5470
- # }
5471
- #
5472
4803
  # @!attribute [rw] subscription_name
5473
4804
  # The name of the Amazon DocumentDB event notification subscription
5474
4805
  # that you want to remove a source identifier from.
@@ -5503,14 +4834,6 @@ module Aws::DocDB
5503
4834
 
5504
4835
  # Represents the input to RemoveTagsFromResource.
5505
4836
  #
5506
- # @note When making an API call, you may pass RemoveTagsFromResourceMessage
5507
- # data as a hash:
5508
- #
5509
- # {
5510
- # resource_name: "String", # required
5511
- # tag_keys: ["String"], # required
5512
- # }
5513
- #
5514
4837
  # @!attribute [rw] resource_name
5515
4838
  # The Amazon DocumentDB resource that the tags are removed from. This
5516
4839
  # value is an Amazon Resource Name (ARN).
@@ -5531,28 +4854,6 @@ module Aws::DocDB
5531
4854
 
5532
4855
  # Represents the input to ResetDBClusterParameterGroup.
5533
4856
  #
5534
- # @note When making an API call, you may pass ResetDBClusterParameterGroupMessage
5535
- # data as a hash:
5536
- #
5537
- # {
5538
- # db_cluster_parameter_group_name: "String", # required
5539
- # reset_all_parameters: false,
5540
- # parameters: [
5541
- # {
5542
- # parameter_name: "String",
5543
- # parameter_value: "String",
5544
- # description: "String",
5545
- # source: "String",
5546
- # apply_type: "String",
5547
- # data_type: "String",
5548
- # allowed_values: "String",
5549
- # is_modifiable: false,
5550
- # minimum_engine_version: "String",
5551
- # apply_method: "immediate", # accepts immediate, pending-reboot
5552
- # },
5553
- # ],
5554
- # }
5555
- #
5556
4857
  # @!attribute [rw] db_cluster_parameter_group_name
5557
4858
  # The name of the cluster parameter group to reset.
5558
4859
  # @return [String]
@@ -5609,29 +4910,6 @@ module Aws::DocDB
5609
4910
 
5610
4911
  # Represents the input to RestoreDBClusterFromSnapshot.
5611
4912
  #
5612
- # @note When making an API call, you may pass RestoreDBClusterFromSnapshotMessage
5613
- # data as a hash:
5614
- #
5615
- # {
5616
- # availability_zones: ["String"],
5617
- # db_cluster_identifier: "String", # required
5618
- # snapshot_identifier: "String", # required
5619
- # engine: "String", # required
5620
- # engine_version: "String",
5621
- # port: 1,
5622
- # db_subnet_group_name: "String",
5623
- # vpc_security_group_ids: ["String"],
5624
- # tags: [
5625
- # {
5626
- # key: "String",
5627
- # value: "String",
5628
- # },
5629
- # ],
5630
- # kms_key_id: "String",
5631
- # enable_cloudwatch_logs_exports: ["String"],
5632
- # deletion_protection: false,
5633
- # }
5634
- #
5635
4913
  # @!attribute [rw] availability_zones
5636
4914
  # Provides the list of Amazon EC2 Availability Zones that instances in
5637
4915
  # the restored DB cluster can be created in.
@@ -5771,29 +5049,6 @@ module Aws::DocDB
5771
5049
 
5772
5050
  # Represents the input to RestoreDBClusterToPointInTime.
5773
5051
  #
5774
- # @note When making an API call, you may pass RestoreDBClusterToPointInTimeMessage
5775
- # data as a hash:
5776
- #
5777
- # {
5778
- # db_cluster_identifier: "String", # required
5779
- # restore_type: "String",
5780
- # source_db_cluster_identifier: "String", # required
5781
- # restore_to_time: Time.now,
5782
- # use_latest_restorable_time: false,
5783
- # port: 1,
5784
- # db_subnet_group_name: "String",
5785
- # vpc_security_group_ids: ["String"],
5786
- # tags: [
5787
- # {
5788
- # key: "String",
5789
- # value: "String",
5790
- # },
5791
- # ],
5792
- # kms_key_id: "String",
5793
- # enable_cloudwatch_logs_exports: ["String"],
5794
- # deletion_protection: false,
5795
- # }
5796
- #
5797
5052
  # @!attribute [rw] db_cluster_identifier
5798
5053
  # The name of the new cluster to be created.
5799
5054
  #
@@ -5998,13 +5253,6 @@ module Aws::DocDB
5998
5253
  #
5999
5254
  class SourceNotFoundFault < Aws::EmptyStructure; end
6000
5255
 
6001
- # @note When making an API call, you may pass StartDBClusterMessage
6002
- # data as a hash:
6003
- #
6004
- # {
6005
- # db_cluster_identifier: "String", # required
6006
- # }
6007
- #
6008
5256
  # @!attribute [rw] db_cluster_identifier
6009
5257
  # The identifier of the cluster to restart. Example:
6010
5258
  # `docdb-2019-05-28-15-24-52`
@@ -6030,13 +5278,6 @@ module Aws::DocDB
6030
5278
  include Aws::Structure
6031
5279
  end
6032
5280
 
6033
- # @note When making an API call, you may pass StopDBClusterMessage
6034
- # data as a hash:
6035
- #
6036
- # {
6037
- # db_cluster_identifier: "String", # required
6038
- # }
6039
- #
6040
5281
  # @!attribute [rw] db_cluster_identifier
6041
5282
  # The identifier of the cluster to stop. Example:
6042
5283
  # `docdb-2019-05-28-15-24-52`
@@ -6127,14 +5368,6 @@ module Aws::DocDB
6127
5368
  # Metadata assigned to an Amazon DocumentDB resource consisting of a
6128
5369
  # key-value pair.
6129
5370
  #
6130
- # @note When making an API call, you may pass Tag
6131
- # data as a hash:
6132
- #
6133
- # {
6134
- # key: "String",
6135
- # value: "String",
6136
- # }
6137
- #
6138
5371
  # @!attribute [rw] key
6139
5372
  # The required name of the tag. The string value can be from 1 to 128
6140
5373
  # Unicode characters in length and can't be prefixed with "`aws:`"