aws-sdk-rds 1.290.0 → 1.300.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +50 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1558 -1397
- data/lib/aws-sdk-rds/client_api.rb +238 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +383 -345
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +55 -55
- data/lib/aws-sdk-rds/db_instance.rb +351 -318
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +74 -74
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/errors.rb +11 -0
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +239 -227
- data/lib/aws-sdk-rds/types.rb +1296 -1066
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +113 -104
- data/sig/db_cluster.rbs +69 -64
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +50 -45
- data/sig/db_snapshot.rbs +14 -14
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +23 -21
- data/sig/types.rbs +136 -118
- metadata +3 -3
data/lib/aws-sdk-rds/resource.rb
CHANGED
|
@@ -50,7 +50,7 @@ module Aws::RDS
|
|
|
50
50
|
# engine_version: "String",
|
|
51
51
|
# port: 1,
|
|
52
52
|
# master_username: "String",
|
|
53
|
-
# master_user_password: "
|
|
53
|
+
# master_user_password: "SensitiveString",
|
|
54
54
|
# option_group_name: "String",
|
|
55
55
|
# preferred_backup_window: "String",
|
|
56
56
|
# preferred_maintenance_window: "String",
|
|
@@ -63,7 +63,7 @@ module Aws::RDS
|
|
|
63
63
|
# ],
|
|
64
64
|
# storage_encrypted: false,
|
|
65
65
|
# kms_key_id: "String",
|
|
66
|
-
# pre_signed_url: "
|
|
66
|
+
# pre_signed_url: "SensitiveString",
|
|
67
67
|
# enable_iam_database_authentication: false,
|
|
68
68
|
# backtrack_window: 1,
|
|
69
69
|
# enable_cloudwatch_logs_exports: ["String"],
|
|
@@ -81,19 +81,25 @@ module Aws::RDS
|
|
|
81
81
|
# transit_gateway_multicast_domain_id: "String",
|
|
82
82
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
83
83
|
# },
|
|
84
|
-
# deletion_protection: false,
|
|
85
|
-
# global_cluster_identifier: "String",
|
|
86
|
-
# enable_http_endpoint: false,
|
|
87
|
-
# copy_tags_to_snapshot: false,
|
|
88
|
-
# domain: "String",
|
|
89
|
-
# domain_iam_role_name: "String",
|
|
90
|
-
# enable_global_write_forwarding: false,
|
|
91
84
|
# db_cluster_instance_class: "String",
|
|
92
85
|
# allocated_storage: 1,
|
|
93
86
|
# storage_type: "String",
|
|
94
87
|
# iops: 1,
|
|
95
88
|
# publicly_accessible: false,
|
|
96
89
|
# auto_minor_version_upgrade: false,
|
|
90
|
+
# deletion_protection: false,
|
|
91
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
|
92
|
+
# enable_http_endpoint: false,
|
|
93
|
+
# copy_tags_to_snapshot: false,
|
|
94
|
+
# domain: "String",
|
|
95
|
+
# domain_iam_role_name: "String",
|
|
96
|
+
# enable_global_write_forwarding: false,
|
|
97
|
+
# network_type: "String",
|
|
98
|
+
# serverless_v2_scaling_configuration: {
|
|
99
|
+
# min_capacity: 1.0,
|
|
100
|
+
# max_capacity: 1.0,
|
|
101
|
+
# seconds_until_auto_pause: 1,
|
|
102
|
+
# },
|
|
97
103
|
# monitoring_interval: 1,
|
|
98
104
|
# monitoring_role_arn: "String",
|
|
99
105
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
@@ -101,19 +107,14 @@ module Aws::RDS
|
|
|
101
107
|
# performance_insights_kms_key_id: "String",
|
|
102
108
|
# performance_insights_retention_period: 1,
|
|
103
109
|
# enable_limitless_database: false,
|
|
104
|
-
# serverless_v2_scaling_configuration: {
|
|
105
|
-
# min_capacity: 1.0,
|
|
106
|
-
# max_capacity: 1.0,
|
|
107
|
-
# seconds_until_auto_pause: 1,
|
|
108
|
-
# },
|
|
109
|
-
# network_type: "String",
|
|
110
110
|
# cluster_scalability_type: "standard", # accepts standard, limitless
|
|
111
111
|
# db_system_id: "String",
|
|
112
112
|
# manage_master_user_password: false,
|
|
113
|
-
# master_user_secret_kms_key_id: "String",
|
|
114
113
|
# enable_local_write_forwarding: false,
|
|
114
|
+
# master_user_secret_kms_key_id: "String",
|
|
115
115
|
# ca_certificate_identifier: "String",
|
|
116
116
|
# engine_lifecycle_support: "String",
|
|
117
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
117
118
|
# source_region: "String",
|
|
118
119
|
# })
|
|
119
120
|
# @param [Hash] options ({})
|
|
@@ -563,73 +564,6 @@ module Aws::RDS
|
|
|
563
564
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
564
565
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
565
566
|
# Reserved for future use.
|
|
566
|
-
# @option options [Boolean] :deletion_protection
|
|
567
|
-
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
568
|
-
# database can't be deleted when deletion protection is enabled. By
|
|
569
|
-
# default, deletion protection isn't enabled.
|
|
570
|
-
#
|
|
571
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
572
|
-
# @option options [String] :global_cluster_identifier
|
|
573
|
-
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
574
|
-
# cluster in the new global database cluster.
|
|
575
|
-
#
|
|
576
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
577
|
-
# @option options [Boolean] :enable_http_endpoint
|
|
578
|
-
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
579
|
-
# default, the HTTP endpoint isn't enabled.
|
|
580
|
-
#
|
|
581
|
-
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
582
|
-
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
583
|
-
# also query your database from inside the RDS console with the RDS
|
|
584
|
-
# query editor.
|
|
585
|
-
#
|
|
586
|
-
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
587
|
-
# Aurora User Guide*.
|
|
588
|
-
#
|
|
589
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
590
|
-
#
|
|
591
|
-
#
|
|
592
|
-
#
|
|
593
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
594
|
-
# @option options [Boolean] :copy_tags_to_snapshot
|
|
595
|
-
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
596
|
-
# the DB cluster. The default is not to copy them.
|
|
597
|
-
#
|
|
598
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
599
|
-
# @option options [String] :domain
|
|
600
|
-
# The Active Directory directory ID to create the DB cluster in.
|
|
601
|
-
#
|
|
602
|
-
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
603
|
-
# authentication to authenticate users that connect to the DB cluster.
|
|
604
|
-
#
|
|
605
|
-
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
606
|
-
# Aurora User Guide*.
|
|
607
|
-
#
|
|
608
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
609
|
-
#
|
|
610
|
-
#
|
|
611
|
-
#
|
|
612
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
613
|
-
# @option options [String] :domain_iam_role_name
|
|
614
|
-
# The name of the IAM role to use when making API calls to the Directory
|
|
615
|
-
# Service.
|
|
616
|
-
#
|
|
617
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
618
|
-
# @option options [Boolean] :enable_global_write_forwarding
|
|
619
|
-
# Specifies whether to enable this DB cluster to forward write
|
|
620
|
-
# operations to the primary cluster of a global cluster (Aurora global
|
|
621
|
-
# database). By default, write operations are not allowed on Aurora DB
|
|
622
|
-
# clusters that are secondary clusters in an Aurora global database.
|
|
623
|
-
#
|
|
624
|
-
# You can set this value only on Aurora DB clusters that are members of
|
|
625
|
-
# an Aurora global database. With this parameter enabled, a secondary
|
|
626
|
-
# cluster can forward writes to the current primary cluster, and the
|
|
627
|
-
# resulting changes are replicated back to this cluster. For the primary
|
|
628
|
-
# DB cluster of an Aurora global database, this value is used
|
|
629
|
-
# immediately if the primary is demoted by a global cluster API
|
|
630
|
-
# operation, but it does nothing until then.
|
|
631
|
-
#
|
|
632
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
633
567
|
# @option options [String] :db_cluster_instance_class
|
|
634
568
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
635
569
|
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
@@ -715,40 +649,31 @@ module Aws::RDS
|
|
|
715
649
|
# @option options [Boolean] :publicly_accessible
|
|
716
650
|
# Specifies whether the DB cluster is publicly accessible.
|
|
717
651
|
#
|
|
652
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
653
|
+
#
|
|
718
654
|
# When the DB cluster is publicly accessible and you connect from
|
|
719
|
-
# outside of the DB cluster's virtual private cloud (VPC), its
|
|
720
|
-
#
|
|
655
|
+
# outside of the DB cluster's virtual private cloud (VPC), its domain
|
|
656
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
721
657
|
# connect from within the same VPC as the DB cluster, the endpoint
|
|
722
658
|
# resolves to the private IP address. Access to the DB cluster is
|
|
723
|
-
#
|
|
724
|
-
# access isn't permitted if the security group assigned to the DB
|
|
725
|
-
# cluster doesn't permit it.
|
|
659
|
+
# controlled by its security group settings.
|
|
726
660
|
#
|
|
727
661
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
728
662
|
# cluster with a DNS name that resolves to a private IP address.
|
|
729
663
|
#
|
|
730
|
-
#
|
|
731
|
-
#
|
|
732
|
-
# Default: The default behavior varies depending on whether
|
|
733
|
-
# `DBSubnetGroupName` is specified.
|
|
734
|
-
#
|
|
735
|
-
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
|
736
|
-
# isn't specified, the following applies:
|
|
737
|
-
#
|
|
738
|
-
# * If the default VPC in the target Region doesn’t have an internet
|
|
739
|
-
# gateway attached to it, the DB cluster is private.
|
|
664
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
665
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
740
666
|
#
|
|
741
|
-
#
|
|
742
|
-
#
|
|
667
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
668
|
+
# `true`.
|
|
743
669
|
#
|
|
744
|
-
# If `
|
|
745
|
-
#
|
|
670
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
671
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
672
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
746
673
|
#
|
|
747
|
-
#
|
|
748
|
-
#
|
|
749
|
-
#
|
|
750
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
751
|
-
# attached to it, the DB cluster is public.
|
|
674
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
675
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
676
|
+
# returns an error.
|
|
752
677
|
# @option options [Boolean] :auto_minor_version_upgrade
|
|
753
678
|
# Specifies whether minor engine upgrades are applied automatically to
|
|
754
679
|
# the DB cluster during the maintenance window. By default, minor engine
|
|
@@ -762,6 +687,100 @@ module Aws::RDS
|
|
|
762
687
|
#
|
|
763
688
|
#
|
|
764
689
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
|
|
690
|
+
# @option options [Boolean] :deletion_protection
|
|
691
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
692
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
693
|
+
# default, deletion protection isn't enabled.
|
|
694
|
+
#
|
|
695
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
696
|
+
# @option options [String] :global_cluster_identifier
|
|
697
|
+
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
698
|
+
# cluster in the new global database cluster.
|
|
699
|
+
#
|
|
700
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
701
|
+
# @option options [Boolean] :enable_http_endpoint
|
|
702
|
+
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
703
|
+
# default, the HTTP endpoint isn't enabled.
|
|
704
|
+
#
|
|
705
|
+
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
706
|
+
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
707
|
+
# also query your database from inside the RDS console with the RDS
|
|
708
|
+
# query editor.
|
|
709
|
+
#
|
|
710
|
+
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
711
|
+
# Aurora User Guide*.
|
|
712
|
+
#
|
|
713
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
714
|
+
#
|
|
715
|
+
#
|
|
716
|
+
#
|
|
717
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
718
|
+
# @option options [Boolean] :copy_tags_to_snapshot
|
|
719
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
720
|
+
# the DB cluster. The default is not to copy them.
|
|
721
|
+
#
|
|
722
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
723
|
+
# @option options [String] :domain
|
|
724
|
+
# The Active Directory directory ID to create the DB cluster in.
|
|
725
|
+
#
|
|
726
|
+
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
727
|
+
# authentication to authenticate users that connect to the DB cluster.
|
|
728
|
+
#
|
|
729
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
730
|
+
# Aurora User Guide*.
|
|
731
|
+
#
|
|
732
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
733
|
+
#
|
|
734
|
+
#
|
|
735
|
+
#
|
|
736
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
737
|
+
# @option options [String] :domain_iam_role_name
|
|
738
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
739
|
+
# Service.
|
|
740
|
+
#
|
|
741
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
742
|
+
# @option options [Boolean] :enable_global_write_forwarding
|
|
743
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
744
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
745
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
746
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
747
|
+
#
|
|
748
|
+
# You can set this value only on Aurora DB clusters that are members of
|
|
749
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
|
750
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
751
|
+
# resulting changes are replicated back to this cluster. For the primary
|
|
752
|
+
# DB cluster of an Aurora global database, this value is used
|
|
753
|
+
# immediately if the primary is demoted by a global cluster API
|
|
754
|
+
# operation, but it does nothing until then.
|
|
755
|
+
#
|
|
756
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
757
|
+
# @option options [String] :network_type
|
|
758
|
+
# The network type of the DB cluster.
|
|
759
|
+
#
|
|
760
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
761
|
+
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
762
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
763
|
+
#
|
|
764
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
765
|
+
# the *Amazon Aurora User Guide.*
|
|
766
|
+
#
|
|
767
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
768
|
+
#
|
|
769
|
+
# Valid Values: `IPV4 | DUAL`
|
|
770
|
+
#
|
|
771
|
+
#
|
|
772
|
+
#
|
|
773
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
774
|
+
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
775
|
+
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
776
|
+
# cluster.
|
|
777
|
+
#
|
|
778
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
779
|
+
# the *Amazon Aurora User Guide*.
|
|
780
|
+
#
|
|
781
|
+
#
|
|
782
|
+
#
|
|
783
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
765
784
|
# @option options [Integer] :monitoring_interval
|
|
766
785
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
767
786
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -851,33 +870,6 @@ module Aws::RDS
|
|
|
851
870
|
# `ClusterScalabilityType` setting.
|
|
852
871
|
#
|
|
853
872
|
# </note>
|
|
854
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
855
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
856
|
-
# cluster.
|
|
857
|
-
#
|
|
858
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
859
|
-
# the *Amazon Aurora User Guide*.
|
|
860
|
-
#
|
|
861
|
-
#
|
|
862
|
-
#
|
|
863
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
864
|
-
# @option options [String] :network_type
|
|
865
|
-
# The network type of the DB cluster.
|
|
866
|
-
#
|
|
867
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
868
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
869
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
870
|
-
#
|
|
871
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
872
|
-
# the *Amazon Aurora User Guide.*
|
|
873
|
-
#
|
|
874
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
875
|
-
#
|
|
876
|
-
# Valid Values: `IPV4 | DUAL`
|
|
877
|
-
#
|
|
878
|
-
#
|
|
879
|
-
#
|
|
880
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
881
873
|
# @option options [String] :cluster_scalability_type
|
|
882
874
|
# Specifies the scalability mode of the Aurora DB cluster. When set to
|
|
883
875
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
@@ -913,6 +905,12 @@ module Aws::RDS
|
|
|
913
905
|
#
|
|
914
906
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
915
907
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
908
|
+
# @option options [Boolean] :enable_local_write_forwarding
|
|
909
|
+
# Specifies whether read replicas can forward write operations to the
|
|
910
|
+
# writer DB instance in the DB cluster. By default, write operations
|
|
911
|
+
# aren't allowed on reader DB instances.
|
|
912
|
+
#
|
|
913
|
+
# Valid for: Aurora DB clusters only
|
|
916
914
|
# @option options [String] :master_user_secret_kms_key_id
|
|
917
915
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
918
916
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -937,12 +935,6 @@ module Aws::RDS
|
|
|
937
935
|
# Amazon Web Services Region.
|
|
938
936
|
#
|
|
939
937
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
940
|
-
# @option options [Boolean] :enable_local_write_forwarding
|
|
941
|
-
# Specifies whether read replicas can forward write operations to the
|
|
942
|
-
# writer DB instance in the DB cluster. By default, write operations
|
|
943
|
-
# aren't allowed on reader DB instances.
|
|
944
|
-
#
|
|
945
|
-
# Valid for: Aurora DB clusters only
|
|
946
938
|
# @option options [String] :ca_certificate_identifier
|
|
947
939
|
# The CA certificate identifier to use for the DB cluster's server
|
|
948
940
|
# certificate.
|
|
@@ -990,6 +982,21 @@ module Aws::RDS
|
|
|
990
982
|
#
|
|
991
983
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
|
|
992
984
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
985
|
+
# @option options [String] :master_user_authentication_type
|
|
986
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
987
|
+
# user authentication, you can configure the master DB user with IAM
|
|
988
|
+
# database authentication when you create a DB cluster.
|
|
989
|
+
#
|
|
990
|
+
# You can specify one of the following values:
|
|
991
|
+
#
|
|
992
|
+
# * `password` - Use standard database authentication with a password.
|
|
993
|
+
#
|
|
994
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
995
|
+
#
|
|
996
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
997
|
+
#
|
|
998
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
999
|
+
# engines.
|
|
993
1000
|
# @option options [String] :source_region
|
|
994
1001
|
# The source region of the snapshot. This is only needed when the
|
|
995
1002
|
# shapshot is encrypted and in a different region.
|
|
@@ -1105,7 +1112,7 @@ module Aws::RDS
|
|
|
1105
1112
|
# db_instance_class: "String", # required
|
|
1106
1113
|
# engine: "String", # required
|
|
1107
1114
|
# master_username: "String",
|
|
1108
|
-
# master_user_password: "
|
|
1115
|
+
# master_user_password: "SensitiveString",
|
|
1109
1116
|
# db_security_groups: ["String"],
|
|
1110
1117
|
# vpc_security_group_ids: ["String"],
|
|
1111
1118
|
# availability_zone: "String",
|
|
@@ -1120,6 +1127,7 @@ module Aws::RDS
|
|
|
1120
1127
|
# auto_minor_version_upgrade: false,
|
|
1121
1128
|
# license_model: "String",
|
|
1122
1129
|
# iops: 1,
|
|
1130
|
+
# storage_throughput: 1,
|
|
1123
1131
|
# option_group_name: "String",
|
|
1124
1132
|
# character_set_name: "String",
|
|
1125
1133
|
# nchar_character_set_name: "String",
|
|
@@ -1133,7 +1141,7 @@ module Aws::RDS
|
|
|
1133
1141
|
# db_cluster_identifier: "String",
|
|
1134
1142
|
# storage_type: "String",
|
|
1135
1143
|
# tde_credential_arn: "String",
|
|
1136
|
-
# tde_credential_password: "
|
|
1144
|
+
# tde_credential_password: "SensitiveString",
|
|
1137
1145
|
# storage_encrypted: false,
|
|
1138
1146
|
# kms_key_id: "String",
|
|
1139
1147
|
# domain: "String",
|
|
@@ -1162,17 +1170,17 @@ module Aws::RDS
|
|
|
1162
1170
|
# deletion_protection: false,
|
|
1163
1171
|
# max_allocated_storage: 1,
|
|
1164
1172
|
# enable_customer_owned_ip: false,
|
|
1165
|
-
# custom_iam_instance_profile: "String",
|
|
1166
|
-
# backup_target: "String",
|
|
1167
1173
|
# network_type: "String",
|
|
1168
|
-
#
|
|
1174
|
+
# backup_target: "String",
|
|
1175
|
+
# custom_iam_instance_profile: "String",
|
|
1176
|
+
# db_system_id: "String",
|
|
1177
|
+
# ca_certificate_identifier: "String",
|
|
1169
1178
|
# manage_master_user_password: false,
|
|
1170
1179
|
# master_user_secret_kms_key_id: "String",
|
|
1171
|
-
# ca_certificate_identifier: "String",
|
|
1172
|
-
# db_system_id: "String",
|
|
1173
|
-
# dedicated_log_volume: false,
|
|
1174
1180
|
# multi_tenant: false,
|
|
1181
|
+
# dedicated_log_volume: false,
|
|
1175
1182
|
# engine_lifecycle_support: "String",
|
|
1183
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
1176
1184
|
# })
|
|
1177
1185
|
# @param [Hash] options ({})
|
|
1178
1186
|
# @option options [String] :db_name
|
|
@@ -1847,6 +1855,14 @@ module Aws::RDS
|
|
|
1847
1855
|
#
|
|
1848
1856
|
#
|
|
1849
1857
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
1858
|
+
# @option options [Integer] :storage_throughput
|
|
1859
|
+
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
1860
|
+
# DB instance.
|
|
1861
|
+
#
|
|
1862
|
+
# This setting applies only to the `gp3` storage type.
|
|
1863
|
+
#
|
|
1864
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
1865
|
+
# instances.
|
|
1850
1866
|
# @option options [String] :option_group_name
|
|
1851
1867
|
# The option group to associate the DB instance with.
|
|
1852
1868
|
#
|
|
@@ -1876,37 +1892,28 @@ module Aws::RDS
|
|
|
1876
1892
|
# Specifies whether the DB instance is publicly accessible.
|
|
1877
1893
|
#
|
|
1878
1894
|
# When the DB instance is publicly accessible and you connect from
|
|
1879
|
-
# outside of the DB instance's virtual private cloud (VPC), its
|
|
1880
|
-
#
|
|
1895
|
+
# outside of the DB instance's virtual private cloud (VPC), its domain
|
|
1896
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
1881
1897
|
# connect from within the same VPC as the DB instance, the endpoint
|
|
1882
1898
|
# resolves to the private IP address. Access to the DB instance is
|
|
1883
|
-
#
|
|
1884
|
-
# access is not permitted if the security group assigned to the DB
|
|
1885
|
-
# instance doesn't permit it.
|
|
1899
|
+
# controlled by its security group settings.
|
|
1886
1900
|
#
|
|
1887
1901
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
|
1888
1902
|
# instance with a DNS name that resolves to a private IP address.
|
|
1889
1903
|
#
|
|
1890
|
-
#
|
|
1891
|
-
# `
|
|
1892
|
-
#
|
|
1893
|
-
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
|
1894
|
-
# isn't specified, the following applies:
|
|
1895
|
-
#
|
|
1896
|
-
# * If the default VPC in the target Region doesn’t have an internet
|
|
1897
|
-
# gateway attached to it, the DB instance is private.
|
|
1904
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
1905
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
1898
1906
|
#
|
|
1899
|
-
#
|
|
1900
|
-
#
|
|
1907
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
1908
|
+
# `false` for Aurora instances and `true` for non-Aurora instances.
|
|
1901
1909
|
#
|
|
1902
|
-
# If `
|
|
1903
|
-
#
|
|
1910
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
1911
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
1912
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
1904
1913
|
#
|
|
1905
|
-
#
|
|
1906
|
-
#
|
|
1907
|
-
#
|
|
1908
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
1909
|
-
# attached to it, the DB instance is public.
|
|
1914
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
1915
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
1916
|
+
# returns an error.
|
|
1910
1917
|
# @option options [Array<Types::Tag>] :tags
|
|
1911
1918
|
# Tags to assign to the DB instance.
|
|
1912
1919
|
# @option options [String] :db_cluster_identifier
|
|
@@ -2250,28 +2257,21 @@ module Aws::RDS
|
|
|
2250
2257
|
#
|
|
2251
2258
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2252
2259
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2253
|
-
# @option options [String] :
|
|
2254
|
-
# The
|
|
2255
|
-
# instance of an RDS Custom DB instance.
|
|
2256
|
-
#
|
|
2257
|
-
# This setting is required for RDS Custom.
|
|
2258
|
-
#
|
|
2259
|
-
# Constraints:
|
|
2260
|
-
#
|
|
2261
|
-
# * The profile must exist in your account.
|
|
2260
|
+
# @option options [String] :network_type
|
|
2261
|
+
# The network type of the DB instance.
|
|
2262
2262
|
#
|
|
2263
|
-
#
|
|
2264
|
-
#
|
|
2263
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2264
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2265
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2265
2266
|
#
|
|
2266
|
-
#
|
|
2267
|
-
#
|
|
2267
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2268
|
+
# the *Amazon RDS User Guide.*
|
|
2268
2269
|
#
|
|
2269
|
-
#
|
|
2270
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2270
|
+
# Valid Values: `IPV4 | DUAL`
|
|
2271
2271
|
#
|
|
2272
2272
|
#
|
|
2273
2273
|
#
|
|
2274
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2274
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2275
2275
|
# @option options [String] :backup_target
|
|
2276
2276
|
# The location for storing automated backups and manual snapshots.
|
|
2277
2277
|
#
|
|
@@ -2291,29 +2291,50 @@ module Aws::RDS
|
|
|
2291
2291
|
#
|
|
2292
2292
|
#
|
|
2293
2293
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2294
|
-
# @option options [String] :
|
|
2295
|
-
# The
|
|
2294
|
+
# @option options [String] :custom_iam_instance_profile
|
|
2295
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
2296
|
+
# instance of an RDS Custom DB instance.
|
|
2296
2297
|
#
|
|
2297
|
-
#
|
|
2298
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2299
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2298
|
+
# This setting is required for RDS Custom.
|
|
2300
2299
|
#
|
|
2301
|
-
#
|
|
2302
|
-
# the *Amazon RDS User Guide.*
|
|
2300
|
+
# Constraints:
|
|
2303
2301
|
#
|
|
2304
|
-
#
|
|
2302
|
+
# * The profile must exist in your account.
|
|
2305
2303
|
#
|
|
2304
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2305
|
+
# assume.
|
|
2306
2306
|
#
|
|
2307
|
+
# * The instance profile name and the associated IAM role name must
|
|
2308
|
+
# start with the prefix `AWSRDSCustom`.
|
|
2307
2309
|
#
|
|
2308
|
-
# [
|
|
2309
|
-
#
|
|
2310
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
2311
|
-
# DB instance.
|
|
2310
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
2311
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2312
2312
|
#
|
|
2313
|
-
# This setting applies only to the `gp3` storage type.
|
|
2314
2313
|
#
|
|
2315
|
-
#
|
|
2316
|
-
#
|
|
2314
|
+
#
|
|
2315
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2316
|
+
# @option options [String] :db_system_id
|
|
2317
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2318
|
+
# database instance that manages your database files. In this context,
|
|
2319
|
+
# the term "Oracle database instance" refers exclusively to the system
|
|
2320
|
+
# global area (SGA) and Oracle background processes. If you don't
|
|
2321
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2322
|
+
# the name of your CDB.
|
|
2323
|
+
# @option options [String] :ca_certificate_identifier
|
|
2324
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
2325
|
+
# certificate.
|
|
2326
|
+
#
|
|
2327
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
2328
|
+
#
|
|
2329
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2330
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2331
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2332
|
+
# Guide*.
|
|
2333
|
+
#
|
|
2334
|
+
#
|
|
2335
|
+
#
|
|
2336
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2337
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2317
2338
|
# @option options [Boolean] :manage_master_user_password
|
|
2318
2339
|
# Specifies whether to manage the master user password with Amazon Web
|
|
2319
2340
|
# Services Secrets Manager.
|
|
@@ -2353,31 +2374,6 @@ module Aws::RDS
|
|
|
2353
2374
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
2354
2375
|
# Amazon Web Services account has a different default KMS key for each
|
|
2355
2376
|
# Amazon Web Services Region.
|
|
2356
|
-
# @option options [String] :ca_certificate_identifier
|
|
2357
|
-
# The CA certificate identifier to use for the DB instance's server
|
|
2358
|
-
# certificate.
|
|
2359
|
-
#
|
|
2360
|
-
# This setting doesn't apply to RDS Custom DB instances.
|
|
2361
|
-
#
|
|
2362
|
-
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2363
|
-
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2364
|
-
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2365
|
-
# Guide*.
|
|
2366
|
-
#
|
|
2367
|
-
#
|
|
2368
|
-
#
|
|
2369
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2370
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2371
|
-
# @option options [String] :db_system_id
|
|
2372
|
-
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2373
|
-
# database instance that manages your database files. In this context,
|
|
2374
|
-
# the term "Oracle database instance" refers exclusively to the system
|
|
2375
|
-
# global area (SGA) and Oracle background processes. If you don't
|
|
2376
|
-
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2377
|
-
# the name of your CDB.
|
|
2378
|
-
# @option options [Boolean] :dedicated_log_volume
|
|
2379
|
-
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2380
|
-
# enabled.
|
|
2381
2377
|
# @option options [Boolean] :multi_tenant
|
|
2382
2378
|
# Specifies whether to use the multi-tenant configuration or the
|
|
2383
2379
|
# single-tenant configuration (default). This parameter only applies to
|
|
@@ -2393,6 +2389,9 @@ module Aws::RDS
|
|
|
2393
2389
|
# * If you specify the multi-tenant configuration when you create your
|
|
2394
2390
|
# DB instance, you can't later modify this DB instance to use the
|
|
2395
2391
|
# single-tenant configuration.
|
|
2392
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
2393
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2394
|
+
# enabled.
|
|
2396
2395
|
# @option options [String] :engine_lifecycle_support
|
|
2397
2396
|
# The life cycle type for this DB instance.
|
|
2398
2397
|
#
|
|
@@ -2424,6 +2423,19 @@ module Aws::RDS
|
|
|
2424
2423
|
#
|
|
2425
2424
|
#
|
|
2426
2425
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
2426
|
+
# @option options [String] :master_user_authentication_type
|
|
2427
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
2428
|
+
# user authentication, you can configure the master DB user with IAM
|
|
2429
|
+
# database authentication when you create a DB instance.
|
|
2430
|
+
#
|
|
2431
|
+
# You can specify one of the following values:
|
|
2432
|
+
#
|
|
2433
|
+
# * `password` - Use standard database authentication with a password.
|
|
2434
|
+
#
|
|
2435
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
2436
|
+
#
|
|
2437
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
2438
|
+
# engines.
|
|
2427
2439
|
# @return [DBInstance]
|
|
2428
2440
|
def create_db_instance(options = {})
|
|
2429
2441
|
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
@@ -3666,7 +3678,7 @@ module Aws::RDS
|
|
|
3666
3678
|
#
|
|
3667
3679
|
# events = rds.events({
|
|
3668
3680
|
# source_identifier: "String",
|
|
3669
|
-
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version, db-proxy, blue-green-deployment
|
|
3681
|
+
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version, db-proxy, blue-green-deployment, db-shard-group, zero-etl
|
|
3670
3682
|
# start_time: Time.now,
|
|
3671
3683
|
# end_time: Time.now,
|
|
3672
3684
|
# duration: 1,
|