aws-sdk-rds 1.290.0 → 1.294.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,19 +986,14 @@ 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
+ # master_user_authentication_type: "password", # accepts password, iam-db-auth
996
997
  # source_region: "String",
997
998
  # })
998
999
  # @param [Hash] options ({})
@@ -1426,73 +1427,6 @@ module Aws::RDS
1426
1427
  # Valid for Cluster Type: Aurora DB clusters only
1427
1428
  # @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
1428
1429
  # Reserved for future use.
1429
- # @option options [Boolean] :deletion_protection
1430
- # Specifies whether the DB cluster has deletion protection enabled. The
1431
- # database can't be deleted when deletion protection is enabled. By
1432
- # default, deletion protection isn't enabled.
1433
- #
1434
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1435
- # @option options [String] :global_cluster_identifier
1436
- # The global cluster ID of an Aurora cluster that becomes the primary
1437
- # cluster in the new global database cluster.
1438
- #
1439
- # Valid for Cluster Type: Aurora DB clusters only
1440
- # @option options [Boolean] :enable_http_endpoint
1441
- # Specifies whether to enable the HTTP endpoint for the DB cluster. By
1442
- # default, the HTTP endpoint isn't enabled.
1443
- #
1444
- # When enabled, the HTTP endpoint provides a connectionless web service
1445
- # API (RDS Data API) for running SQL queries on the DB cluster. You can
1446
- # also query your database from inside the RDS console with the RDS
1447
- # query editor.
1448
- #
1449
- # For more information, see [Using RDS Data API][1] in the *Amazon
1450
- # Aurora User Guide*.
1451
- #
1452
- # Valid for Cluster Type: Aurora DB clusters only
1453
- #
1454
- #
1455
- #
1456
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1457
- # @option options [Boolean] :copy_tags_to_snapshot
1458
- # Specifies whether to copy all tags from the DB cluster to snapshots of
1459
- # the DB cluster. The default is not to copy them.
1460
- #
1461
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1462
- # @option options [String] :domain
1463
- # The Active Directory directory ID to create the DB cluster in.
1464
- #
1465
- # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
1466
- # authentication to authenticate users that connect to the DB cluster.
1467
- #
1468
- # For more information, see [Kerberos authentication][1] in the *Amazon
1469
- # Aurora User Guide*.
1470
- #
1471
- # Valid for Cluster Type: Aurora DB clusters only
1472
- #
1473
- #
1474
- #
1475
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1476
- # @option options [String] :domain_iam_role_name
1477
- # The name of the IAM role to use when making API calls to the Directory
1478
- # Service.
1479
- #
1480
- # Valid for Cluster Type: Aurora DB clusters only
1481
- # @option options [Boolean] :enable_global_write_forwarding
1482
- # Specifies whether to enable this DB cluster to forward write
1483
- # operations to the primary cluster of a global cluster (Aurora global
1484
- # database). By default, write operations are not allowed on Aurora DB
1485
- # clusters that are secondary clusters in an Aurora global database.
1486
- #
1487
- # You can set this value only on Aurora DB clusters that are members of
1488
- # an Aurora global database. With this parameter enabled, a secondary
1489
- # cluster can forward writes to the current primary cluster, and the
1490
- # resulting changes are replicated back to this cluster. For the primary
1491
- # DB cluster of an Aurora global database, this value is used
1492
- # immediately if the primary is demoted by a global cluster API
1493
- # operation, but it does nothing until then.
1494
- #
1495
- # Valid for Cluster Type: Aurora DB clusters only
1496
1430
  # @option options [String] :db_cluster_instance_class
1497
1431
  # The compute and memory capacity of each DB instance in the Multi-AZ DB
1498
1432
  # cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
@@ -1590,41 +1524,135 @@ module Aws::RDS
1590
1524
  # When the DB cluster isn't publicly accessible, it is an internal DB
1591
1525
  # cluster with a DNS name that resolves to a private IP address.
1592
1526
  #
1593
- # Valid for Cluster Type: Multi-AZ DB clusters only
1527
+ # Valid for Cluster Type: Multi-AZ DB clusters only
1528
+ #
1529
+ # Default: The default behavior varies depending on whether
1530
+ # `DBSubnetGroupName` is specified.
1531
+ #
1532
+ # If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
1533
+ # isn't specified, the following applies:
1534
+ #
1535
+ # * If the default VPC in the target Region doesn’t have an internet
1536
+ # gateway attached to it, the DB cluster is private.
1537
+ #
1538
+ # * If the default VPC in the target Region has an internet gateway
1539
+ # attached to it, the DB cluster is public.
1540
+ #
1541
+ # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
1542
+ # specified, the following applies:
1543
+ #
1544
+ # * If the subnets are part of a VPC that doesn’t have an internet
1545
+ # gateway attached to it, the DB cluster is private.
1546
+ #
1547
+ # * If the subnets are part of a VPC that has an internet gateway
1548
+ # attached to it, the DB cluster is public.
1549
+ # @option options [Boolean] :auto_minor_version_upgrade
1550
+ # Specifies whether minor engine upgrades are applied automatically to
1551
+ # the DB cluster during the maintenance window. By default, minor engine
1552
+ # upgrades are applied automatically.
1553
+ #
1554
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
1555
+ #
1556
+ # For more information about automatic minor version upgrades, see
1557
+ # [Automatically upgrading the minor engine version][1].
1558
+ #
1559
+ #
1560
+ #
1561
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
1562
+ # @option options [Boolean] :deletion_protection
1563
+ # Specifies whether the DB cluster has deletion protection enabled. The
1564
+ # database can't be deleted when deletion protection is enabled. By
1565
+ # default, deletion protection isn't enabled.
1566
+ #
1567
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1568
+ # @option options [String] :global_cluster_identifier
1569
+ # The global cluster ID of an Aurora cluster that becomes the primary
1570
+ # cluster in the new global database cluster.
1571
+ #
1572
+ # Valid for Cluster Type: Aurora DB clusters only
1573
+ # @option options [Boolean] :enable_http_endpoint
1574
+ # Specifies whether to enable the HTTP endpoint for the DB cluster. By
1575
+ # default, the HTTP endpoint isn't enabled.
1576
+ #
1577
+ # When enabled, the HTTP endpoint provides a connectionless web service
1578
+ # API (RDS Data API) for running SQL queries on the DB cluster. You can
1579
+ # also query your database from inside the RDS console with the RDS
1580
+ # query editor.
1581
+ #
1582
+ # For more information, see [Using RDS Data API][1] in the *Amazon
1583
+ # Aurora User Guide*.
1584
+ #
1585
+ # Valid for Cluster Type: Aurora DB clusters only
1586
+ #
1587
+ #
1588
+ #
1589
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1590
+ # @option options [Boolean] :copy_tags_to_snapshot
1591
+ # Specifies whether to copy all tags from the DB cluster to snapshots of
1592
+ # the DB cluster. The default is not to copy them.
1593
+ #
1594
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1595
+ # @option options [String] :domain
1596
+ # The Active Directory directory ID to create the DB cluster in.
1597
+ #
1598
+ # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
1599
+ # authentication to authenticate users that connect to the DB cluster.
1600
+ #
1601
+ # For more information, see [Kerberos authentication][1] in the *Amazon
1602
+ # Aurora User Guide*.
1603
+ #
1604
+ # Valid for Cluster Type: Aurora DB clusters only
1605
+ #
1606
+ #
1607
+ #
1608
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1609
+ # @option options [String] :domain_iam_role_name
1610
+ # The name of the IAM role to use when making API calls to the Directory
1611
+ # Service.
1612
+ #
1613
+ # Valid for Cluster Type: Aurora DB clusters only
1614
+ # @option options [Boolean] :enable_global_write_forwarding
1615
+ # Specifies whether to enable this DB cluster to forward write
1616
+ # operations to the primary cluster of a global cluster (Aurora global
1617
+ # database). By default, write operations are not allowed on Aurora DB
1618
+ # clusters that are secondary clusters in an Aurora global database.
1619
+ #
1620
+ # You can set this value only on Aurora DB clusters that are members of
1621
+ # an Aurora global database. With this parameter enabled, a secondary
1622
+ # cluster can forward writes to the current primary cluster, and the
1623
+ # resulting changes are replicated back to this cluster. For the primary
1624
+ # DB cluster of an Aurora global database, this value is used
1625
+ # immediately if the primary is demoted by a global cluster API
1626
+ # operation, but it does nothing until then.
1594
1627
  #
1595
- # Default: The default behavior varies depending on whether
1596
- # `DBSubnetGroupName` is specified.
1628
+ # Valid for Cluster Type: Aurora DB clusters only
1629
+ # @option options [String] :network_type
1630
+ # The network type of the DB cluster.
1597
1631
  #
1598
- # If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
1599
- # isn't specified, the following applies:
1632
+ # The network type is determined by the `DBSubnetGroup` specified for
1633
+ # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
1634
+ # or the IPv4 and the IPv6 protocols (`DUAL`).
1600
1635
  #
1601
- # * If the default VPC in the target Region doesn’t have an internet
1602
- # gateway attached to it, the DB cluster is private.
1636
+ # For more information, see [ Working with a DB instance in a VPC][1] in
1637
+ # the *Amazon Aurora User Guide.*
1603
1638
  #
1604
- # * If the default VPC in the target Region has an internet gateway
1605
- # attached to it, the DB cluster is public.
1639
+ # Valid for Cluster Type: Aurora DB clusters only
1606
1640
  #
1607
- # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
1608
- # specified, the following applies:
1641
+ # Valid Values: `IPV4 | DUAL`
1609
1642
  #
1610
- # * If the subnets are part of a VPC that doesn’t have an internet
1611
- # gateway attached to it, the DB cluster is private.
1612
1643
  #
1613
- # * If the subnets are part of a VPC that has an internet gateway
1614
- # attached to it, the DB cluster is public.
1615
- # @option options [Boolean] :auto_minor_version_upgrade
1616
- # Specifies whether minor engine upgrades are applied automatically to
1617
- # the DB cluster during the maintenance window. By default, minor engine
1618
- # upgrades are applied automatically.
1619
1644
  #
1620
- # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
1645
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
1646
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
1647
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
1648
+ # cluster.
1621
1649
  #
1622
- # For more information about automatic minor version upgrades, see
1623
- # [Automatically upgrading the minor engine version][1].
1650
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
1651
+ # the *Amazon Aurora User Guide*.
1624
1652
  #
1625
1653
  #
1626
1654
  #
1627
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
1655
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
1628
1656
  # @option options [Integer] :monitoring_interval
1629
1657
  # The interval, in seconds, between points when Enhanced Monitoring
1630
1658
  # metrics are collected for the DB cluster. To turn off collecting
@@ -1714,33 +1742,6 @@ module Aws::RDS
1714
1742
  # `ClusterScalabilityType` setting.
1715
1743
  #
1716
1744
  # </note>
1717
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
1718
- # Contains the scaling configuration of an Aurora Serverless v2 DB
1719
- # cluster.
1720
- #
1721
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
1722
- # the *Amazon Aurora User Guide*.
1723
- #
1724
- #
1725
- #
1726
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
1727
- # @option options [String] :network_type
1728
- # The network type of the DB cluster.
1729
- #
1730
- # The network type is determined by the `DBSubnetGroup` specified for
1731
- # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
1732
- # or the IPv4 and the IPv6 protocols (`DUAL`).
1733
- #
1734
- # For more information, see [ Working with a DB instance in a VPC][1] in
1735
- # the *Amazon Aurora User Guide.*
1736
- #
1737
- # Valid for Cluster Type: Aurora DB clusters only
1738
- #
1739
- # Valid Values: `IPV4 | DUAL`
1740
- #
1741
- #
1742
- #
1743
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
1744
1745
  # @option options [String] :cluster_scalability_type
1745
1746
  # Specifies the scalability mode of the Aurora DB cluster. When set to
1746
1747
  # `limitless`, the cluster operates as an Aurora Limitless Database.
@@ -1776,6 +1777,12 @@ module Aws::RDS
1776
1777
  #
1777
1778
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
1778
1779
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
1780
+ # @option options [Boolean] :enable_local_write_forwarding
1781
+ # Specifies whether read replicas can forward write operations to the
1782
+ # writer DB instance in the DB cluster. By default, write operations
1783
+ # aren't allowed on reader DB instances.
1784
+ #
1785
+ # Valid for: Aurora DB clusters only
1779
1786
  # @option options [String] :master_user_secret_kms_key_id
1780
1787
  # The Amazon Web Services KMS key identifier to encrypt a secret that is
1781
1788
  # automatically generated and managed in Amazon Web Services Secrets
@@ -1800,12 +1807,6 @@ module Aws::RDS
1800
1807
  # Amazon Web Services Region.
1801
1808
  #
1802
1809
  # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1803
- # @option options [Boolean] :enable_local_write_forwarding
1804
- # Specifies whether read replicas can forward write operations to the
1805
- # writer DB instance in the DB cluster. By default, write operations
1806
- # aren't allowed on reader DB instances.
1807
- #
1808
- # Valid for: Aurora DB clusters only
1809
1810
  # @option options [String] :ca_certificate_identifier
1810
1811
  # The CA certificate identifier to use for the DB cluster's server
1811
1812
  # certificate.
@@ -1853,6 +1854,21 @@ module Aws::RDS
1853
1854
  #
1854
1855
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
1855
1856
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
1857
+ # @option options [String] :master_user_authentication_type
1858
+ # Specifies the authentication type for the master user. With IAM master
1859
+ # user authentication, you can configure the master DB user with IAM
1860
+ # database authentication when you create a DB cluster.
1861
+ #
1862
+ # You can specify one of the following values:
1863
+ #
1864
+ # * `password` - Use standard database authentication with a password.
1865
+ #
1866
+ # * `iam-db-auth` - Use IAM database authentication for the master user.
1867
+ #
1868
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1869
+ #
1870
+ # This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
1871
+ # engines.
1856
1872
  # @option options [String] :source_region
1857
1873
  # The source region of the snapshot. This is only needed when the
1858
1874
  # shapshot is encrypted and in a different region.
@@ -2002,7 +2018,7 @@ module Aws::RDS
2002
2018
  # db_cluster_parameter_group_name: "String",
2003
2019
  # vpc_security_group_ids: ["String"],
2004
2020
  # port: 1,
2005
- # master_user_password: "String",
2021
+ # master_user_password: "SensitiveString",
2006
2022
  # option_group_name: "String",
2007
2023
  # preferred_backup_window: "String",
2008
2024
  # preferred_maintenance_window: "String",
@@ -2034,27 +2050,28 @@ module Aws::RDS
2034
2050
  # storage_type: "String",
2035
2051
  # iops: 1,
2036
2052
  # auto_minor_version_upgrade: false,
2053
+ # network_type: "String",
2054
+ # serverless_v2_scaling_configuration: {
2055
+ # min_capacity: 1.0,
2056
+ # max_capacity: 1.0,
2057
+ # seconds_until_auto_pause: 1,
2058
+ # },
2037
2059
  # monitoring_interval: 1,
2038
2060
  # monitoring_role_arn: "String",
2039
2061
  # database_insights_mode: "standard", # accepts standard, advanced
2040
2062
  # enable_performance_insights: false,
2041
2063
  # performance_insights_kms_key_id: "String",
2042
2064
  # performance_insights_retention_period: 1,
2043
- # serverless_v2_scaling_configuration: {
2044
- # min_capacity: 1.0,
2045
- # max_capacity: 1.0,
2046
- # seconds_until_auto_pause: 1,
2047
- # },
2048
- # network_type: "String",
2049
2065
  # manage_master_user_password: false,
2050
2066
  # rotate_master_user_password: false,
2067
+ # enable_local_write_forwarding: false,
2051
2068
  # master_user_secret_kms_key_id: "String",
2052
2069
  # engine_mode: "String",
2053
2070
  # allow_engine_mode_change: false,
2054
- # enable_local_write_forwarding: false,
2055
2071
  # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
2056
2072
  # enable_limitless_database: false,
2057
2073
  # ca_certificate_identifier: "String",
2074
+ # master_user_authentication_type: "password", # accepts password, iam-db-auth
2058
2075
  # })
2059
2076
  # @param [Hash] options ({})
2060
2077
  # @option options [String] :new_db_cluster_identifier
@@ -2466,6 +2483,33 @@ module Aws::RDS
2466
2483
  #
2467
2484
  #
2468
2485
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
2486
+ # @option options [String] :network_type
2487
+ # The network type of the DB cluster.
2488
+ #
2489
+ # The network type is determined by the `DBSubnetGroup` specified for
2490
+ # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
2491
+ # or the IPv4 and the IPv6 protocols (`DUAL`).
2492
+ #
2493
+ # For more information, see [ Working with a DB instance in a VPC][1] in
2494
+ # the *Amazon Aurora User Guide.*
2495
+ #
2496
+ # Valid for Cluster Type: Aurora DB clusters only
2497
+ #
2498
+ # Valid Values: `IPV4 | DUAL`
2499
+ #
2500
+ #
2501
+ #
2502
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2503
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
2504
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
2505
+ # cluster.
2506
+ #
2507
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
2508
+ # the *Amazon Aurora User Guide*.
2509
+ #
2510
+ #
2511
+ #
2512
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
2469
2513
  # @option options [Integer] :monitoring_interval
2470
2514
  # The interval, in seconds, between points when Enhanced Monitoring
2471
2515
  # metrics are collected for the DB cluster. To turn off collecting
@@ -2501,8 +2545,9 @@ module Aws::RDS
2501
2545
  # the `PerformanceInsightsEnabled` parameter to `true` and the
2502
2546
  # `PerformanceInsightsRetentionPeriod` parameter to 465.
2503
2547
  #
2504
- # If you change the value from `advanced` to `standard`, you must set
2505
- # the `PerformanceInsightsEnabled` parameter to `false`.
2548
+ # If you change the value from `advanced` to `standard`, you can set the
2549
+ # `PerformanceInsightsEnabled` parameter to `true` to collect detailed
2550
+ # database counter and per-query metrics.
2506
2551
  #
2507
2552
  # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2508
2553
  # @option options [Boolean] :enable_performance_insights
@@ -2548,33 +2593,6 @@ module Aws::RDS
2548
2593
  #
2549
2594
  # If you specify a retention period that isn't valid, such as `94`,
2550
2595
  # Amazon RDS issues an error.
2551
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
2552
- # Contains the scaling configuration of an Aurora Serverless v2 DB
2553
- # cluster.
2554
- #
2555
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
2556
- # the *Amazon Aurora User Guide*.
2557
- #
2558
- #
2559
- #
2560
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
2561
- # @option options [String] :network_type
2562
- # The network type of the DB cluster.
2563
- #
2564
- # The network type is determined by the `DBSubnetGroup` specified for
2565
- # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
2566
- # or the IPv4 and the IPv6 protocols (`DUAL`).
2567
- #
2568
- # For more information, see [ Working with a DB instance in a VPC][1] in
2569
- # the *Amazon Aurora User Guide.*
2570
- #
2571
- # Valid for Cluster Type: Aurora DB clusters only
2572
- #
2573
- # Valid Values: `IPV4 | DUAL`
2574
- #
2575
- #
2576
- #
2577
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2578
2596
  # @option options [Boolean] :manage_master_user_password
2579
2597
  # Specifies whether to manage the master user password with Amazon Web
2580
2598
  # Services Secrets Manager.
@@ -2627,6 +2645,12 @@ module Aws::RDS
2627
2645
  #
2628
2646
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
2629
2647
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
2648
+ # @option options [Boolean] :enable_local_write_forwarding
2649
+ # Specifies whether read replicas can forward write operations to the
2650
+ # writer DB instance in the DB cluster. By default, write operations
2651
+ # aren't allowed on reader DB instances.
2652
+ #
2653
+ # Valid for: Aurora DB clusters only
2630
2654
  # @option options [String] :master_user_secret_kms_key_id
2631
2655
  # The Amazon Web Services KMS key identifier to encrypt a secret that is
2632
2656
  # automatically generated and managed in Amazon Web Services Secrets
@@ -2691,12 +2715,6 @@ module Aws::RDS
2691
2715
  # mode.
2692
2716
  #
2693
2717
  # ^
2694
- # @option options [Boolean] :enable_local_write_forwarding
2695
- # Specifies whether read replicas can forward write operations to the
2696
- # writer DB instance in the DB cluster. By default, write operations
2697
- # aren't allowed on reader DB instances.
2698
- #
2699
- # Valid for: Aurora DB clusters only
2700
2718
  # @option options [String] :aws_backup_recovery_point_arn
2701
2719
  # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
2702
2720
  # Services Backup.
@@ -2723,6 +2741,21 @@ module Aws::RDS
2723
2741
  #
2724
2742
  #
2725
2743
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
2744
+ # @option options [String] :master_user_authentication_type
2745
+ # Specifies the authentication type for the master user. With IAM master
2746
+ # user authentication, you can change the master DB user to use IAM
2747
+ # database authentication.
2748
+ #
2749
+ # You can specify one of the following values:
2750
+ #
2751
+ # * `password` - Use standard database authentication with a password.
2752
+ #
2753
+ # * `iam-db-auth` - Use IAM database authentication for the master user.
2754
+ #
2755
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2756
+ #
2757
+ # This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
2758
+ # engines.
2726
2759
  # @return [DBCluster]
2727
2760
  def modify(options = {})
2728
2761
  options = options.merge(db_cluster_identifier: @id)
@@ -2762,26 +2795,26 @@ module Aws::RDS
2762
2795
  # copy_tags_to_snapshot: false,
2763
2796
  # domain: "String",
2764
2797
  # domain_iam_role_name: "String",
2765
- # scaling_configuration: {
2766
- # min_capacity: 1,
2767
- # max_capacity: 1,
2768
- # auto_pause: false,
2769
- # seconds_until_auto_pause: 1,
2770
- # timeout_action: "String",
2771
- # seconds_before_timeout: 1,
2772
- # },
2773
- # engine_mode: "String",
2774
2798
  # db_cluster_instance_class: "String",
2775
2799
  # storage_type: "String",
2776
2800
  # publicly_accessible: false,
2777
2801
  # iops: 1,
2802
+ # network_type: "String",
2803
+ # source_db_cluster_resource_id: "String",
2778
2804
  # serverless_v2_scaling_configuration: {
2779
2805
  # min_capacity: 1.0,
2780
2806
  # max_capacity: 1.0,
2781
2807
  # seconds_until_auto_pause: 1,
2782
2808
  # },
2783
- # network_type: "String",
2784
- # source_db_cluster_resource_id: "String",
2809
+ # scaling_configuration: {
2810
+ # min_capacity: 1,
2811
+ # max_capacity: 1,
2812
+ # auto_pause: false,
2813
+ # seconds_until_auto_pause: 1,
2814
+ # timeout_action: "String",
2815
+ # seconds_before_timeout: 1,
2816
+ # },
2817
+ # engine_mode: "String",
2785
2818
  # rds_custom_cluster_configuration: {
2786
2819
  # interconnect_subnet_id: "String",
2787
2820
  # transit_gateway_multicast_domain_id: "String",
@@ -3032,22 +3065,6 @@ module Aws::RDS
3032
3065
  # Directory Service.
3033
3066
  #
3034
3067
  # Valid for: Aurora DB clusters only
3035
- # @option options [Types::ScalingConfiguration] :scaling_configuration
3036
- # For DB clusters in `serverless` DB engine mode, the scaling properties
3037
- # of the DB cluster.
3038
- #
3039
- # Valid for: Aurora DB clusters only
3040
- # @option options [String] :engine_mode
3041
- # The engine mode of the new cluster. Specify `provisioned` or
3042
- # `serverless`, depending on the type of the cluster you are creating.
3043
- # You can create an Aurora Serverless v1 clone from a provisioned
3044
- # cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
3045
- # To create a clone that is an Aurora Serverless v1 cluster, the
3046
- # original cluster must be an Aurora Serverless v1 cluster or an
3047
- # encrypted provisioned cluster. To create a full copy that is an Aurora
3048
- # Serverless v1 cluster, specify the engine mode `serverless`.
3049
- #
3050
- # Valid for: Aurora DB clusters only
3051
3068
  # @option options [String] :db_cluster_instance_class
3052
3069
  # The compute and memory capacity of the each DB instance in the
3053
3070
  # Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance
@@ -3126,16 +3143,6 @@ module Aws::RDS
3126
3143
  #
3127
3144
  #
3128
3145
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
3129
- # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
3130
- # Contains the scaling configuration of an Aurora Serverless v2 DB
3131
- # cluster.
3132
- #
3133
- # For more information, see [Using Amazon Aurora Serverless v2][1] in
3134
- # the *Amazon Aurora User Guide*.
3135
- #
3136
- #
3137
- #
3138
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
3139
3146
  # @option options [String] :network_type
3140
3147
  # The network type of the DB cluster.
3141
3148
  #
@@ -3159,6 +3166,32 @@ module Aws::RDS
3159
3166
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
3160
3167
  # @option options [String] :source_db_cluster_resource_id
3161
3168
  # The resource ID of the source DB cluster from which to restore.
3169
+ # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
3170
+ # Contains the scaling configuration of an Aurora Serverless v2 DB
3171
+ # cluster.
3172
+ #
3173
+ # For more information, see [Using Amazon Aurora Serverless v2][1] in
3174
+ # the *Amazon Aurora User Guide*.
3175
+ #
3176
+ #
3177
+ #
3178
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
3179
+ # @option options [Types::ScalingConfiguration] :scaling_configuration
3180
+ # For DB clusters in `serverless` DB engine mode, the scaling properties
3181
+ # of the DB cluster.
3182
+ #
3183
+ # Valid for: Aurora DB clusters only
3184
+ # @option options [String] :engine_mode
3185
+ # The engine mode of the new cluster. Specify `provisioned` or
3186
+ # `serverless`, depending on the type of the cluster you are creating.
3187
+ # You can create an Aurora Serverless v1 clone from a provisioned
3188
+ # cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
3189
+ # To create a clone that is an Aurora Serverless v1 cluster, the
3190
+ # original cluster must be an Aurora Serverless v1 cluster or an
3191
+ # encrypted provisioned cluster. To create a full copy that is an Aurora
3192
+ # Serverless v1 cluster, specify the engine mode `serverless`.
3193
+ #
3194
+ # Valid for: Aurora DB clusters only
3162
3195
  # @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
3163
3196
  # Reserved for future use.
3164
3197
  # @option options [Integer] :monitoring_interval