aws-sdk-rds 1.293.0 → 1.295.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.
@@ -90,12 +90,6 @@ module Aws::RDS
90
90
  data[:status]
91
91
  end
92
92
 
93
- # The time when a stopped DB cluster is restarted automatically.
94
- # @return [Time]
95
- def automatic_restart_time
96
- data[:automatic_restart_time]
97
- end
98
-
99
93
  # The progress of the operation as a percentage.
100
94
  # @return [String]
101
95
  def percent_progress
@@ -353,6 +347,14 @@ module Aws::RDS
353
347
  data[:capacity]
354
348
  end
355
349
 
350
+ # Information about pending changes to the DB cluster. This information
351
+ # is returned only when there are pending changes. Specific changes are
352
+ # identified by subelements.
353
+ # @return [Types::ClusterPendingModifiedValues]
354
+ def pending_modified_values
355
+ data[:pending_modified_values]
356
+ end
357
+
356
358
  # The DB engine mode of the DB cluster, either `provisioned` or
357
359
  # `serverless`.
358
360
  #
@@ -386,6 +388,84 @@ module Aws::RDS
386
388
  data[:rds_custom_cluster_configuration]
387
389
  end
388
390
 
391
+ # The name of the compute and memory capacity class of the DB instance.
392
+ #
393
+ # This setting is only for non-Aurora Multi-AZ DB clusters.
394
+ # @return [String]
395
+ def db_cluster_instance_class
396
+ data[:db_cluster_instance_class]
397
+ end
398
+
399
+ # The storage type associated with the DB cluster.
400
+ # @return [String]
401
+ def storage_type
402
+ data[:storage_type]
403
+ end
404
+
405
+ # The Provisioned IOPS (I/O operations per second) value.
406
+ #
407
+ # This setting is only for non-Aurora Multi-AZ DB clusters.
408
+ # @return [Integer]
409
+ def iops
410
+ data[:iops]
411
+ end
412
+
413
+ # The storage throughput for the DB cluster. The throughput is
414
+ # automatically set based on the IOPS that you provision, and is not
415
+ # configurable.
416
+ #
417
+ # This setting is only for non-Aurora Multi-AZ DB clusters.
418
+ # @return [Integer]
419
+ def storage_throughput
420
+ data[:storage_throughput]
421
+ end
422
+
423
+ # The next time you can modify the DB cluster to use the `aurora-iopt1`
424
+ # storage type.
425
+ #
426
+ # This setting is only for Aurora DB clusters.
427
+ # @return [Time]
428
+ def io_optimized_next_allowed_modification_time
429
+ data[:io_optimized_next_allowed_modification_time]
430
+ end
431
+
432
+ # Indicates whether the DB cluster is publicly accessible.
433
+ #
434
+ # When the DB cluster is publicly accessible and you connect from
435
+ # outside of the DB cluster's virtual private cloud (VPC), its Domain
436
+ # Name System (DNS) endpoint resolves to the public IP address. When you
437
+ # connect from within the same VPC as the DB cluster, the endpoint
438
+ # resolves to the private IP address. Access to the DB cluster is
439
+ # ultimately controlled by the security group it uses. That public
440
+ # access isn't permitted if the security group assigned to the DB
441
+ # cluster doesn't permit it.
442
+ #
443
+ # When the DB cluster isn't publicly accessible, it is an internal DB
444
+ # cluster with a DNS name that resolves to a private IP address.
445
+ #
446
+ # For more information, see CreateDBCluster.
447
+ #
448
+ # This setting is only for non-Aurora Multi-AZ DB clusters.
449
+ # @return [Boolean]
450
+ def publicly_accessible
451
+ data[:publicly_accessible]
452
+ end
453
+
454
+ # Indicates whether minor version patches are applied automatically.
455
+ #
456
+ # This setting is for Aurora DB clusters and Multi-AZ DB clusters.
457
+ #
458
+ # For more information about automatic minor version upgrades, see
459
+ # [Automatically upgrading the minor engine version][1].
460
+ #
461
+ #
462
+ #
463
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
464
+ # @return [Boolean]
465
+ def auto_minor_version_upgrade
466
+ data[:auto_minor_version_upgrade]
467
+ end
468
+
389
469
  # Indicates whether the DB cluster has deletion protection enabled. The
390
470
  # database can't be deleted when deletion protection is enabled.
391
471
  # @return [Boolean]
@@ -505,71 +585,56 @@ module Aws::RDS
505
585
  data[:global_write_forwarding_requested]
506
586
  end
507
587
 
508
- # Information about pending changes to the DB cluster. This information
509
- # is returned only when there are pending changes. Specific changes are
510
- # identified by subelements.
511
- # @return [Types::ClusterPendingModifiedValues]
512
- def pending_modified_values
513
- data[:pending_modified_values]
514
- end
515
-
516
- # The name of the compute and memory capacity class of the DB instance.
588
+ # The network type of the DB instance.
517
589
  #
518
- # This setting is only for non-Aurora Multi-AZ DB clusters.
519
- # @return [String]
520
- def db_cluster_instance_class
521
- data[:db_cluster_instance_class]
522
- end
523
-
524
- # The storage type associated with the DB cluster.
590
+ # The network type is determined by the `DBSubnetGroup` specified for
591
+ # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
592
+ # or the IPv4 and the IPv6 protocols (`DUAL`).
593
+ #
594
+ # For more information, see [ Working with a DB instance in a VPC][1] in
595
+ # the *Amazon Aurora User Guide.*
596
+ #
597
+ # This setting is only for Aurora DB clusters.
598
+ #
599
+ # Valid Values: `IPV4 | DUAL`
600
+ #
601
+ #
602
+ #
603
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
525
604
  # @return [String]
526
- def storage_type
527
- data[:storage_type]
605
+ def network_type
606
+ data[:network_type]
528
607
  end
529
608
 
530
- # The Provisioned IOPS (I/O operations per second) value.
531
- #
532
- # This setting is only for non-Aurora Multi-AZ DB clusters.
533
- # @return [Integer]
534
- def iops
535
- data[:iops]
609
+ # The time when a stopped DB cluster is restarted automatically.
610
+ # @return [Time]
611
+ def automatic_restart_time
612
+ data[:automatic_restart_time]
536
613
  end
537
614
 
538
- # Indicates whether the DB cluster is publicly accessible.
615
+ # The scaling configuration for an Aurora Serverless v2 DB cluster.
539
616
  #
540
- # When the DB cluster is publicly accessible and you connect from
541
- # outside of the DB cluster's virtual private cloud (VPC), its Domain
542
- # Name System (DNS) endpoint resolves to the public IP address. When you
543
- # connect from within the same VPC as the DB cluster, the endpoint
544
- # resolves to the private IP address. Access to the DB cluster is
545
- # ultimately controlled by the security group it uses. That public
546
- # access isn't permitted if the security group assigned to the DB
547
- # cluster doesn't permit it.
617
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
618
+ # the *Amazon Aurora User Guide*.
548
619
  #
549
- # When the DB cluster isn't publicly accessible, it is an internal DB
550
- # cluster with a DNS name that resolves to a private IP address.
551
620
  #
552
- # For more information, see CreateDBCluster.
553
621
  #
554
- # This setting is only for non-Aurora Multi-AZ DB clusters.
555
- # @return [Boolean]
556
- def publicly_accessible
557
- data[:publicly_accessible]
622
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
623
+ # @return [Types::ServerlessV2ScalingConfigurationInfo]
624
+ def serverless_v2_scaling_configuration
625
+ data[:serverless_v2_scaling_configuration]
558
626
  end
559
627
 
560
- # Indicates whether minor version patches are applied automatically.
561
- #
562
- # This setting is for Aurora DB clusters and Multi-AZ DB clusters.
563
- #
564
- # For more information about automatic minor version upgrades, see
565
- # [Automatically upgrading the minor engine version][1].
628
+ # The version of the Aurora Serverless V2 platform used by the DB
629
+ # cluster. For more information, see [Using Aurora Serverless v2][1] in
630
+ # the *Amazon Aurora User Guide*.
566
631
  #
567
632
  #
568
633
  #
569
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
570
- # @return [Boolean]
571
- def auto_minor_version_upgrade
572
- data[:auto_minor_version_upgrade]
634
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
635
+ # @return [String]
636
+ def serverless_v2_platform_version
637
+ data[:serverless_v2_platform_version]
573
638
  end
574
639
 
575
640
  # The interval, in seconds, between points when Enhanced Monitoring
@@ -636,52 +701,6 @@ module Aws::RDS
636
701
  data[:performance_insights_retention_period]
637
702
  end
638
703
 
639
- # The scaling configuration for an Aurora Serverless v2 DB cluster.
640
- #
641
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
642
- # the *Amazon Aurora User Guide*.
643
- #
644
- #
645
- #
646
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
647
- # @return [Types::ServerlessV2ScalingConfigurationInfo]
648
- def serverless_v2_scaling_configuration
649
- data[:serverless_v2_scaling_configuration]
650
- end
651
-
652
- # The version of the Aurora Serverless V2 platform used by the DB
653
- # cluster. For more information, see [Using Aurora Serverless v2][1] in
654
- # the *Amazon Aurora User Guide*.
655
- #
656
- #
657
- #
658
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
659
- # @return [String]
660
- def serverless_v2_platform_version
661
- data[:serverless_v2_platform_version]
662
- end
663
-
664
- # The network type of the DB instance.
665
- #
666
- # The network type is determined by the `DBSubnetGroup` specified for
667
- # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
668
- # or the IPv4 and the IPv6 protocols (`DUAL`).
669
- #
670
- # For more information, see [ Working with a DB instance in a VPC][1] in
671
- # the *Amazon Aurora User Guide.*
672
- #
673
- # This setting is only for Aurora DB clusters.
674
- #
675
- # Valid Values: `IPV4 | DUAL`
676
- #
677
- #
678
- #
679
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
680
- # @return [String]
681
- def network_type
682
- data[:network_type]
683
- end
684
-
685
704
  # Reserved for future use.
686
705
  # @return [String]
687
706
  def db_system_id
@@ -705,15 +724,6 @@ module Aws::RDS
705
724
  data[:master_user_secret]
706
725
  end
707
726
 
708
- # The next time you can modify the DB cluster to use the `aurora-iopt1`
709
- # storage type.
710
- #
711
- # This setting is only for Aurora DB clusters.
712
- # @return [Time]
713
- def io_optimized_next_allowed_modification_time
714
- data[:io_optimized_next_allowed_modification_time]
715
- end
716
-
717
727
  # Indicates whether an Aurora DB cluster has in-cluster write forwarding
718
728
  # enabled, not enabled, requested, or is in the process of enabling it.
719
729
  # @return [String]
@@ -734,16 +744,6 @@ module Aws::RDS
734
744
  data[:limitless_database]
735
745
  end
736
746
 
737
- # The storage throughput for the DB cluster. The throughput is
738
- # automatically set based on the IOPS that you provision, and is not
739
- # configurable.
740
- #
741
- # This setting is only for non-Aurora Multi-AZ DB clusters.
742
- # @return [Integer]
743
- def storage_throughput
744
- data[:storage_throughput]
745
- end
746
-
747
747
  # The scalability mode of the Aurora DB cluster. When set to
748
748
  # `limitless`, the cluster operates as an Aurora Limitless Database.
749
749
  # When set to `standard` (the default), the cluster uses normal DB
@@ -929,7 +929,7 @@ module Aws::RDS
929
929
  # engine_version: "String",
930
930
  # port: 1,
931
931
  # master_username: "String",
932
- # master_user_password: "String",
932
+ # master_user_password: "SensitiveString",
933
933
  # option_group_name: "String",
934
934
  # preferred_backup_window: "String",
935
935
  # preferred_maintenance_window: "String",
@@ -942,7 +942,7 @@ module Aws::RDS
942
942
  # ],
943
943
  # storage_encrypted: false,
944
944
  # kms_key_id: "String",
945
- # pre_signed_url: "String",
945
+ # pre_signed_url: "SensitiveString",
946
946
  # enable_iam_database_authentication: false,
947
947
  # backtrack_window: 1,
948
948
  # enable_cloudwatch_logs_exports: ["String"],
@@ -960,19 +960,25 @@ module Aws::RDS
960
960
  # transit_gateway_multicast_domain_id: "String",
961
961
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
962
962
  # },
963
- # deletion_protection: false,
964
- # global_cluster_identifier: "String",
965
- # enable_http_endpoint: false,
966
- # copy_tags_to_snapshot: false,
967
- # domain: "String",
968
- # domain_iam_role_name: "String",
969
- # enable_global_write_forwarding: false,
970
963
  # db_cluster_instance_class: "String",
971
964
  # allocated_storage: 1,
972
965
  # storage_type: "String",
973
966
  # iops: 1,
974
967
  # publicly_accessible: false,
975
968
  # auto_minor_version_upgrade: false,
969
+ # deletion_protection: false,
970
+ # global_cluster_identifier: "GlobalClusterIdentifier",
971
+ # enable_http_endpoint: false,
972
+ # copy_tags_to_snapshot: false,
973
+ # domain: "String",
974
+ # domain_iam_role_name: "String",
975
+ # enable_global_write_forwarding: false,
976
+ # network_type: "String",
977
+ # serverless_v2_scaling_configuration: {
978
+ # min_capacity: 1.0,
979
+ # max_capacity: 1.0,
980
+ # seconds_until_auto_pause: 1,
981
+ # },
976
982
  # monitoring_interval: 1,
977
983
  # monitoring_role_arn: "String",
978
984
  # database_insights_mode: "standard", # accepts standard, advanced
@@ -980,17 +986,11 @@ module Aws::RDS
980
986
  # performance_insights_kms_key_id: "String",
981
987
  # performance_insights_retention_period: 1,
982
988
  # enable_limitless_database: false,
983
- # serverless_v2_scaling_configuration: {
984
- # min_capacity: 1.0,
985
- # max_capacity: 1.0,
986
- # seconds_until_auto_pause: 1,
987
- # },
988
- # network_type: "String",
989
- # cluster_scalability_type: "standard", # accepts standard, limitless
989
+ # cluster_scalability_type: "standard", # accepts standard, limitless, scaleout
990
990
  # db_system_id: "String",
991
991
  # manage_master_user_password: false,
992
- # master_user_secret_kms_key_id: "String",
993
992
  # enable_local_write_forwarding: false,
993
+ # master_user_secret_kms_key_id: "String",
994
994
  # ca_certificate_identifier: "String",
995
995
  # engine_lifecycle_support: "String",
996
996
  # master_user_authentication_type: "password", # accepts password, iam-db-auth
@@ -1427,73 +1427,6 @@ module Aws::RDS
1427
1427
  # Valid for Cluster Type: Aurora DB clusters only
1428
1428
  # @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
1429
1429
  # Reserved for future use.
1430
- # @option options [Boolean] :deletion_protection
1431
- # Specifies whether the DB cluster has deletion protection enabled. The
1432
- # database can't be deleted when deletion protection is enabled. By
1433
- # default, deletion protection isn't enabled.
1434
- #
1435
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1436
- # @option options [String] :global_cluster_identifier
1437
- # The global cluster ID of an Aurora cluster that becomes the primary
1438
- # cluster in the new global database cluster.
1439
- #
1440
- # Valid for Cluster Type: Aurora DB clusters only
1441
- # @option options [Boolean] :enable_http_endpoint
1442
- # Specifies whether to enable the HTTP endpoint for the DB cluster. By
1443
- # default, the HTTP endpoint isn't enabled.
1444
- #
1445
- # When enabled, the HTTP endpoint provides a connectionless web service
1446
- # API (RDS Data API) for running SQL queries on the DB cluster. You can
1447
- # also query your database from inside the RDS console with the RDS
1448
- # query editor.
1449
- #
1450
- # For more information, see [Using RDS Data API][1] in the *Amazon
1451
- # Aurora User Guide*.
1452
- #
1453
- # Valid for Cluster Type: Aurora DB clusters only
1454
- #
1455
- #
1456
- #
1457
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1458
- # @option options [Boolean] :copy_tags_to_snapshot
1459
- # Specifies whether to copy all tags from the DB cluster to snapshots of
1460
- # the DB cluster. The default is not to copy them.
1461
- #
1462
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1463
- # @option options [String] :domain
1464
- # The Active Directory directory ID to create the DB cluster in.
1465
- #
1466
- # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
1467
- # authentication to authenticate users that connect to the DB cluster.
1468
- #
1469
- # For more information, see [Kerberos authentication][1] in the *Amazon
1470
- # Aurora User Guide*.
1471
- #
1472
- # Valid for Cluster Type: Aurora DB clusters only
1473
- #
1474
- #
1475
- #
1476
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1477
- # @option options [String] :domain_iam_role_name
1478
- # The name of the IAM role to use when making API calls to the Directory
1479
- # Service.
1480
- #
1481
- # Valid for Cluster Type: Aurora DB clusters only
1482
- # @option options [Boolean] :enable_global_write_forwarding
1483
- # Specifies whether to enable this DB cluster to forward write
1484
- # operations to the primary cluster of a global cluster (Aurora global
1485
- # database). By default, write operations are not allowed on Aurora DB
1486
- # clusters that are secondary clusters in an Aurora global database.
1487
- #
1488
- # You can set this value only on Aurora DB clusters that are members of
1489
- # an Aurora global database. With this parameter enabled, a secondary
1490
- # cluster can forward writes to the current primary cluster, and the
1491
- # resulting changes are replicated back to this cluster. For the primary
1492
- # DB cluster of an Aurora global database, this value is used
1493
- # immediately if the primary is demoted by a global cluster API
1494
- # operation, but it does nothing until then.
1495
- #
1496
- # Valid for Cluster Type: Aurora DB clusters only
1497
1430
  # @option options [String] :db_cluster_instance_class
1498
1431
  # The compute and memory capacity of each DB instance in the Multi-AZ DB
1499
1432
  # cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
@@ -1579,53 +1512,138 @@ module Aws::RDS
1579
1512
  # @option options [Boolean] :publicly_accessible
1580
1513
  # Specifies whether the DB cluster is publicly accessible.
1581
1514
  #
1582
- # When the DB cluster is publicly accessible and you connect from
1583
- # outside of the DB cluster's virtual private cloud (VPC), its Domain
1584
- # Name System (DNS) endpoint resolves to the public IP address. When you
1585
- # connect from within the same VPC as the DB cluster, the endpoint
1586
- # resolves to the private IP address. Access to the DB cluster is
1587
- # ultimately controlled by the security group it uses. That public
1588
- # access isn't permitted if the security group assigned to the DB
1589
- # cluster doesn't permit it.
1515
+ # Valid for Cluster Type: Multi-AZ DB clusters only
1516
+ #
1517
+ # When the DB cluster is publicly accessible and you connect from
1518
+ # outside of the DB cluster's virtual private cloud (VPC), its domain
1519
+ # name system (DNS) endpoint resolves to the public IP address. When you
1520
+ # connect from within the same VPC as the DB cluster, the endpoint
1521
+ # resolves to the private IP address. Access to the DB cluster is
1522
+ # controlled by its security group settings.
1523
+ #
1524
+ # When the DB cluster isn't publicly accessible, it is an internal DB
1525
+ # cluster with a DNS name that resolves to a private IP address.
1526
+ #
1527
+ # The default behavior when `PubliclyAccessible` is not specified
1528
+ # depends on whether a `DBSubnetGroup` is specified.
1529
+ #
1530
+ # If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
1531
+ # `true`.
1532
+ #
1533
+ # If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
1534
+ # `false` unless the value of `DBSubnetGroup` is `default`, in which
1535
+ # case `PubliclyAccessible` defaults to `true`.
1536
+ #
1537
+ # If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
1538
+ # is in doesn't have an internet gateway attached to it, Amazon RDS
1539
+ # returns an error.
1540
+ # @option options [Boolean] :auto_minor_version_upgrade
1541
+ # Specifies whether minor engine upgrades are applied automatically to
1542
+ # the DB cluster during the maintenance window. By default, minor engine
1543
+ # upgrades are applied automatically.
1544
+ #
1545
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
1546
+ #
1547
+ # For more information about automatic minor version upgrades, see
1548
+ # [Automatically upgrading the minor engine version][1].
1549
+ #
1550
+ #
1551
+ #
1552
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
1553
+ # @option options [Boolean] :deletion_protection
1554
+ # Specifies whether the DB cluster has deletion protection enabled. The
1555
+ # database can't be deleted when deletion protection is enabled. By
1556
+ # default, deletion protection isn't enabled.
1557
+ #
1558
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1559
+ # @option options [String] :global_cluster_identifier
1560
+ # The global cluster ID of an Aurora cluster that becomes the primary
1561
+ # cluster in the new global database cluster.
1562
+ #
1563
+ # Valid for Cluster Type: Aurora DB clusters only
1564
+ # @option options [Boolean] :enable_http_endpoint
1565
+ # Specifies whether to enable the HTTP endpoint for the DB cluster. By
1566
+ # default, the HTTP endpoint isn't enabled.
1567
+ #
1568
+ # When enabled, the HTTP endpoint provides a connectionless web service
1569
+ # API (RDS Data API) for running SQL queries on the DB cluster. You can
1570
+ # also query your database from inside the RDS console with the RDS
1571
+ # query editor.
1572
+ #
1573
+ # For more information, see [Using RDS Data API][1] in the *Amazon
1574
+ # Aurora User Guide*.
1575
+ #
1576
+ # Valid for Cluster Type: Aurora DB clusters only
1577
+ #
1578
+ #
1579
+ #
1580
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1581
+ # @option options [Boolean] :copy_tags_to_snapshot
1582
+ # Specifies whether to copy all tags from the DB cluster to snapshots of
1583
+ # the DB cluster. The default is not to copy them.
1584
+ #
1585
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1586
+ # @option options [String] :domain
1587
+ # The Active Directory directory ID to create the DB cluster in.
1588
+ #
1589
+ # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
1590
+ # authentication to authenticate users that connect to the DB cluster.
1591
+ #
1592
+ # For more information, see [Kerberos authentication][1] in the *Amazon
1593
+ # Aurora User Guide*.
1594
+ #
1595
+ # Valid for Cluster Type: Aurora DB clusters only
1596
+ #
1597
+ #
1590
1598
  #
1591
- # When the DB cluster isn't publicly accessible, it is an internal DB
1592
- # cluster with a DNS name that resolves to a private IP address.
1599
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1600
+ # @option options [String] :domain_iam_role_name
1601
+ # The name of the IAM role to use when making API calls to the Directory
1602
+ # Service.
1593
1603
  #
1594
- # Valid for Cluster Type: Multi-AZ DB clusters only
1604
+ # Valid for Cluster Type: Aurora DB clusters only
1605
+ # @option options [Boolean] :enable_global_write_forwarding
1606
+ # Specifies whether to enable this DB cluster to forward write
1607
+ # operations to the primary cluster of a global cluster (Aurora global
1608
+ # database). By default, write operations are not allowed on Aurora DB
1609
+ # clusters that are secondary clusters in an Aurora global database.
1595
1610
  #
1596
- # Default: The default behavior varies depending on whether
1597
- # `DBSubnetGroupName` is specified.
1611
+ # You can set this value only on Aurora DB clusters that are members of
1612
+ # an Aurora global database. With this parameter enabled, a secondary
1613
+ # cluster can forward writes to the current primary cluster, and the
1614
+ # resulting changes are replicated back to this cluster. For the primary
1615
+ # DB cluster of an Aurora global database, this value is used
1616
+ # immediately if the primary is demoted by a global cluster API
1617
+ # operation, but it does nothing until then.
1598
1618
  #
1599
- # If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
1600
- # isn't specified, the following applies:
1619
+ # Valid for Cluster Type: Aurora DB clusters only
1620
+ # @option options [String] :network_type
1621
+ # The network type of the DB cluster.
1601
1622
  #
1602
- # * If the default VPC in the target Region doesn’t have an internet
1603
- # gateway attached to it, the DB cluster is private.
1623
+ # The network type is determined by the `DBSubnetGroup` specified for
1624
+ # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
1625
+ # or the IPv4 and the IPv6 protocols (`DUAL`).
1604
1626
  #
1605
- # * If the default VPC in the target Region has an internet gateway
1606
- # attached to it, the DB cluster is public.
1627
+ # For more information, see [ Working with a DB instance in a VPC][1] in
1628
+ # the *Amazon Aurora User Guide.*
1607
1629
  #
1608
- # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
1609
- # specified, the following applies:
1630
+ # Valid for Cluster Type: Aurora DB clusters only
1610
1631
  #
1611
- # * If the subnets are part of a VPC that doesn’t have an internet
1612
- # gateway attached to it, the DB cluster is private.
1632
+ # Valid Values: `IPV4 | DUAL`
1613
1633
  #
1614
- # * If the subnets are part of a VPC that has an internet gateway
1615
- # attached to it, the DB cluster is public.
1616
- # @option options [Boolean] :auto_minor_version_upgrade
1617
- # Specifies whether minor engine upgrades are applied automatically to
1618
- # the DB cluster during the maintenance window. By default, minor engine
1619
- # upgrades are applied automatically.
1620
1634
  #
1621
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
1622
1635
  #
1623
- # For more information about automatic minor version upgrades, see
1624
- # [Automatically upgrading the minor engine version][1].
1636
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
1637
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
1638
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
1639
+ # cluster.
1640
+ #
1641
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
1642
+ # the *Amazon Aurora User Guide*.
1625
1643
  #
1626
1644
  #
1627
1645
  #
1628
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
1646
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
1629
1647
  # @option options [Integer] :monitoring_interval
1630
1648
  # The interval, in seconds, between points when Enhanced Monitoring
1631
1649
  # metrics are collected for the DB cluster. To turn off collecting
@@ -1715,33 +1733,6 @@ module Aws::RDS
1715
1733
  # `ClusterScalabilityType` setting.
1716
1734
  #
1717
1735
  # </note>
1718
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
1719
- # Contains the scaling configuration of an Aurora Serverless v2 DB
1720
- # cluster.
1721
- #
1722
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
1723
- # the *Amazon Aurora User Guide*.
1724
- #
1725
- #
1726
- #
1727
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
1728
- # @option options [String] :network_type
1729
- # The network type of the DB cluster.
1730
- #
1731
- # The network type is determined by the `DBSubnetGroup` specified for
1732
- # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
1733
- # or the IPv4 and the IPv6 protocols (`DUAL`).
1734
- #
1735
- # For more information, see [ Working with a DB instance in a VPC][1] in
1736
- # the *Amazon Aurora User Guide.*
1737
- #
1738
- # Valid for Cluster Type: Aurora DB clusters only
1739
- #
1740
- # Valid Values: `IPV4 | DUAL`
1741
- #
1742
- #
1743
- #
1744
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
1745
1736
  # @option options [String] :cluster_scalability_type
1746
1737
  # Specifies the scalability mode of the Aurora DB cluster. When set to
1747
1738
  # `limitless`, the cluster operates as an Aurora Limitless Database.
@@ -1777,6 +1768,12 @@ module Aws::RDS
1777
1768
  #
1778
1769
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
1779
1770
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
1771
+ # @option options [Boolean] :enable_local_write_forwarding
1772
+ # Specifies whether read replicas can forward write operations to the
1773
+ # writer DB instance in the DB cluster. By default, write operations
1774
+ # aren't allowed on reader DB instances.
1775
+ #
1776
+ # Valid for: Aurora DB clusters only
1780
1777
  # @option options [String] :master_user_secret_kms_key_id
1781
1778
  # The Amazon Web Services KMS key identifier to encrypt a secret that is
1782
1779
  # automatically generated and managed in Amazon Web Services Secrets
@@ -1801,12 +1798,6 @@ module Aws::RDS
1801
1798
  # Amazon Web Services Region.
1802
1799
  #
1803
1800
  # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1804
- # @option options [Boolean] :enable_local_write_forwarding
1805
- # Specifies whether read replicas can forward write operations to the
1806
- # writer DB instance in the DB cluster. By default, write operations
1807
- # aren't allowed on reader DB instances.
1808
- #
1809
- # Valid for: Aurora DB clusters only
1810
1801
  # @option options [String] :ca_certificate_identifier
1811
1802
  # The CA certificate identifier to use for the DB cluster's server
1812
1803
  # certificate.
@@ -2018,7 +2009,7 @@ module Aws::RDS
2018
2009
  # db_cluster_parameter_group_name: "String",
2019
2010
  # vpc_security_group_ids: ["String"],
2020
2011
  # port: 1,
2021
- # master_user_password: "String",
2012
+ # master_user_password: "SensitiveString",
2022
2013
  # option_group_name: "String",
2023
2014
  # preferred_backup_window: "String",
2024
2015
  # preferred_maintenance_window: "String",
@@ -2050,24 +2041,24 @@ module Aws::RDS
2050
2041
  # storage_type: "String",
2051
2042
  # iops: 1,
2052
2043
  # auto_minor_version_upgrade: false,
2044
+ # network_type: "String",
2045
+ # serverless_v2_scaling_configuration: {
2046
+ # min_capacity: 1.0,
2047
+ # max_capacity: 1.0,
2048
+ # seconds_until_auto_pause: 1,
2049
+ # },
2053
2050
  # monitoring_interval: 1,
2054
2051
  # monitoring_role_arn: "String",
2055
2052
  # database_insights_mode: "standard", # accepts standard, advanced
2056
2053
  # enable_performance_insights: false,
2057
2054
  # performance_insights_kms_key_id: "String",
2058
2055
  # performance_insights_retention_period: 1,
2059
- # serverless_v2_scaling_configuration: {
2060
- # min_capacity: 1.0,
2061
- # max_capacity: 1.0,
2062
- # seconds_until_auto_pause: 1,
2063
- # },
2064
- # network_type: "String",
2065
2056
  # manage_master_user_password: false,
2066
2057
  # rotate_master_user_password: false,
2058
+ # enable_local_write_forwarding: false,
2067
2059
  # master_user_secret_kms_key_id: "String",
2068
2060
  # engine_mode: "String",
2069
2061
  # allow_engine_mode_change: false,
2070
- # enable_local_write_forwarding: false,
2071
2062
  # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
2072
2063
  # enable_limitless_database: false,
2073
2064
  # ca_certificate_identifier: "String",
@@ -2483,6 +2474,33 @@ module Aws::RDS
2483
2474
  #
2484
2475
  #
2485
2476
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
2477
+ # @option options [String] :network_type
2478
+ # The network type of the DB cluster.
2479
+ #
2480
+ # The network type is determined by the `DBSubnetGroup` specified for
2481
+ # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
2482
+ # or the IPv4 and the IPv6 protocols (`DUAL`).
2483
+ #
2484
+ # For more information, see [ Working with a DB instance in a VPC][1] in
2485
+ # the *Amazon Aurora User Guide.*
2486
+ #
2487
+ # Valid for Cluster Type: Aurora DB clusters only
2488
+ #
2489
+ # Valid Values: `IPV4 | DUAL`
2490
+ #
2491
+ #
2492
+ #
2493
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2494
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
2495
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
2496
+ # cluster.
2497
+ #
2498
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
2499
+ # the *Amazon Aurora User Guide*.
2500
+ #
2501
+ #
2502
+ #
2503
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
2486
2504
  # @option options [Integer] :monitoring_interval
2487
2505
  # The interval, in seconds, between points when Enhanced Monitoring
2488
2506
  # metrics are collected for the DB cluster. To turn off collecting
@@ -2566,33 +2584,6 @@ module Aws::RDS
2566
2584
  #
2567
2585
  # If you specify a retention period that isn't valid, such as `94`,
2568
2586
  # Amazon RDS issues an error.
2569
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
2570
- # Contains the scaling configuration of an Aurora Serverless v2 DB
2571
- # cluster.
2572
- #
2573
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
2574
- # the *Amazon Aurora User Guide*.
2575
- #
2576
- #
2577
- #
2578
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
2579
- # @option options [String] :network_type
2580
- # The network type of the DB cluster.
2581
- #
2582
- # The network type is determined by the `DBSubnetGroup` specified for
2583
- # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
2584
- # or the IPv4 and the IPv6 protocols (`DUAL`).
2585
- #
2586
- # For more information, see [ Working with a DB instance in a VPC][1] in
2587
- # the *Amazon Aurora User Guide.*
2588
- #
2589
- # Valid for Cluster Type: Aurora DB clusters only
2590
- #
2591
- # Valid Values: `IPV4 | DUAL`
2592
- #
2593
- #
2594
- #
2595
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2596
2587
  # @option options [Boolean] :manage_master_user_password
2597
2588
  # Specifies whether to manage the master user password with Amazon Web
2598
2589
  # Services Secrets Manager.
@@ -2645,6 +2636,12 @@ module Aws::RDS
2645
2636
  #
2646
2637
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
2647
2638
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
2639
+ # @option options [Boolean] :enable_local_write_forwarding
2640
+ # Specifies whether read replicas can forward write operations to the
2641
+ # writer DB instance in the DB cluster. By default, write operations
2642
+ # aren't allowed on reader DB instances.
2643
+ #
2644
+ # Valid for: Aurora DB clusters only
2648
2645
  # @option options [String] :master_user_secret_kms_key_id
2649
2646
  # The Amazon Web Services KMS key identifier to encrypt a secret that is
2650
2647
  # automatically generated and managed in Amazon Web Services Secrets
@@ -2709,12 +2706,6 @@ module Aws::RDS
2709
2706
  # mode.
2710
2707
  #
2711
2708
  # ^
2712
- # @option options [Boolean] :enable_local_write_forwarding
2713
- # Specifies whether read replicas can forward write operations to the
2714
- # writer DB instance in the DB cluster. By default, write operations
2715
- # aren't allowed on reader DB instances.
2716
- #
2717
- # Valid for: Aurora DB clusters only
2718
2709
  # @option options [String] :aws_backup_recovery_point_arn
2719
2710
  # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
2720
2711
  # Services Backup.
@@ -2795,26 +2786,26 @@ module Aws::RDS
2795
2786
  # copy_tags_to_snapshot: false,
2796
2787
  # domain: "String",
2797
2788
  # domain_iam_role_name: "String",
2798
- # scaling_configuration: {
2799
- # min_capacity: 1,
2800
- # max_capacity: 1,
2801
- # auto_pause: false,
2802
- # seconds_until_auto_pause: 1,
2803
- # timeout_action: "String",
2804
- # seconds_before_timeout: 1,
2805
- # },
2806
- # engine_mode: "String",
2807
2789
  # db_cluster_instance_class: "String",
2808
2790
  # storage_type: "String",
2809
2791
  # publicly_accessible: false,
2810
2792
  # iops: 1,
2793
+ # network_type: "String",
2794
+ # source_db_cluster_resource_id: "String",
2811
2795
  # serverless_v2_scaling_configuration: {
2812
2796
  # min_capacity: 1.0,
2813
2797
  # max_capacity: 1.0,
2814
2798
  # seconds_until_auto_pause: 1,
2815
2799
  # },
2816
- # network_type: "String",
2817
- # source_db_cluster_resource_id: "String",
2800
+ # scaling_configuration: {
2801
+ # min_capacity: 1,
2802
+ # max_capacity: 1,
2803
+ # auto_pause: false,
2804
+ # seconds_until_auto_pause: 1,
2805
+ # timeout_action: "String",
2806
+ # seconds_before_timeout: 1,
2807
+ # },
2808
+ # engine_mode: "String",
2818
2809
  # rds_custom_cluster_configuration: {
2819
2810
  # interconnect_subnet_id: "String",
2820
2811
  # transit_gateway_multicast_domain_id: "String",
@@ -3065,22 +3056,6 @@ module Aws::RDS
3065
3056
  # Directory Service.
3066
3057
  #
3067
3058
  # Valid for: Aurora DB clusters only
3068
- # @option options [Types::ScalingConfiguration] :scaling_configuration
3069
- # For DB clusters in `serverless` DB engine mode, the scaling properties
3070
- # of the DB cluster.
3071
- #
3072
- # Valid for: Aurora DB clusters only
3073
- # @option options [String] :engine_mode
3074
- # The engine mode of the new cluster. Specify `provisioned` or
3075
- # `serverless`, depending on the type of the cluster you are creating.
3076
- # You can create an Aurora Serverless v1 clone from a provisioned
3077
- # cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
3078
- # To create a clone that is an Aurora Serverless v1 cluster, the
3079
- # original cluster must be an Aurora Serverless v1 cluster or an
3080
- # encrypted provisioned cluster. To create a full copy that is an Aurora
3081
- # Serverless v1 cluster, specify the engine mode `serverless`.
3082
- #
3083
- # Valid for: Aurora DB clusters only
3084
3059
  # @option options [String] :db_cluster_instance_class
3085
3060
  # The compute and memory capacity of the each DB instance in the
3086
3061
  # Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance
@@ -3159,16 +3134,6 @@ module Aws::RDS
3159
3134
  #
3160
3135
  #
3161
3136
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
3162
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
3163
- # Contains the scaling configuration of an Aurora Serverless v2 DB
3164
- # cluster.
3165
- #
3166
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
3167
- # the *Amazon Aurora User Guide*.
3168
- #
3169
- #
3170
- #
3171
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
3172
3137
  # @option options [String] :network_type
3173
3138
  # The network type of the DB cluster.
3174
3139
  #
@@ -3192,6 +3157,32 @@ module Aws::RDS
3192
3157
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
3193
3158
  # @option options [String] :source_db_cluster_resource_id
3194
3159
  # The resource ID of the source DB cluster from which to restore.
3160
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
3161
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
3162
+ # cluster.
3163
+ #
3164
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
3165
+ # the *Amazon Aurora User Guide*.
3166
+ #
3167
+ #
3168
+ #
3169
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
3170
+ # @option options [Types::ScalingConfiguration] :scaling_configuration
3171
+ # For DB clusters in `serverless` DB engine mode, the scaling properties
3172
+ # of the DB cluster.
3173
+ #
3174
+ # Valid for: Aurora DB clusters only
3175
+ # @option options [String] :engine_mode
3176
+ # The engine mode of the new cluster. Specify `provisioned` or
3177
+ # `serverless`, depending on the type of the cluster you are creating.
3178
+ # You can create an Aurora Serverless v1 clone from a provisioned
3179
+ # cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
3180
+ # To create a clone that is an Aurora Serverless v1 cluster, the
3181
+ # original cluster must be an Aurora Serverless v1 cluster or an
3182
+ # encrypted provisioned cluster. To create a full copy that is an Aurora
3183
+ # Serverless v1 cluster, specify the engine mode `serverless`.
3184
+ #
3185
+ # Valid for: Aurora DB clusters only
3195
3186
  # @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
3196
3187
  # Reserved for future use.
3197
3188
  # @option options [Integer] :monitoring_interval