aws-sdk-rds 1.290.0 → 1.302.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 +60 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +2281 -1392
- data/lib/aws-sdk-rds/client_api.rb +346 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +421 -345
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +44 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +71 -55
- data/lib/aws-sdk-rds/db_instance.rb +518 -308
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +117 -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 +295 -227
- data/lib/aws-sdk-rds/types.rb +1945 -1061
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +314 -110
- data/sig/db_cluster.rbs +92 -65
- data/sig/db_cluster_snapshot.rbs +18 -7
- data/sig/db_engine_version.rbs +27 -21
- data/sig/db_instance.rbs +154 -47
- data/sig/db_snapshot.rbs +39 -15
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +55 -21
- data/sig/types.rbs +233 -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,25 @@ 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
|
+
# tag_specifications: [
|
|
118
|
+
# {
|
|
119
|
+
# resource_type: "String",
|
|
120
|
+
# tags: [
|
|
121
|
+
# {
|
|
122
|
+
# key: "String",
|
|
123
|
+
# value: "String",
|
|
124
|
+
# },
|
|
125
|
+
# ],
|
|
126
|
+
# },
|
|
127
|
+
# ],
|
|
128
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
117
129
|
# source_region: "String",
|
|
118
130
|
# })
|
|
119
131
|
# @param [Hash] options ({})
|
|
@@ -563,73 +575,6 @@ module Aws::RDS
|
|
|
563
575
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
564
576
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
565
577
|
# 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
578
|
# @option options [String] :db_cluster_instance_class
|
|
634
579
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
635
580
|
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
@@ -715,40 +660,31 @@ module Aws::RDS
|
|
|
715
660
|
# @option options [Boolean] :publicly_accessible
|
|
716
661
|
# Specifies whether the DB cluster is publicly accessible.
|
|
717
662
|
#
|
|
663
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
664
|
+
#
|
|
718
665
|
# When the DB cluster is publicly accessible and you connect from
|
|
719
|
-
# outside of the DB cluster's virtual private cloud (VPC), its
|
|
720
|
-
#
|
|
666
|
+
# outside of the DB cluster's virtual private cloud (VPC), its domain
|
|
667
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
721
668
|
# connect from within the same VPC as the DB cluster, the endpoint
|
|
722
669
|
# 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.
|
|
670
|
+
# controlled by its security group settings.
|
|
726
671
|
#
|
|
727
672
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
728
673
|
# cluster with a DNS name that resolves to a private IP address.
|
|
729
674
|
#
|
|
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.
|
|
675
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
676
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
740
677
|
#
|
|
741
|
-
#
|
|
742
|
-
#
|
|
678
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
679
|
+
# `true`.
|
|
743
680
|
#
|
|
744
|
-
# If `
|
|
745
|
-
#
|
|
681
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
682
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
683
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
746
684
|
#
|
|
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.
|
|
685
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
686
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
687
|
+
# returns an error.
|
|
752
688
|
# @option options [Boolean] :auto_minor_version_upgrade
|
|
753
689
|
# Specifies whether minor engine upgrades are applied automatically to
|
|
754
690
|
# the DB cluster during the maintenance window. By default, minor engine
|
|
@@ -762,6 +698,100 @@ module Aws::RDS
|
|
|
762
698
|
#
|
|
763
699
|
#
|
|
764
700
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
|
|
701
|
+
# @option options [Boolean] :deletion_protection
|
|
702
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
703
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
704
|
+
# default, deletion protection isn't enabled.
|
|
705
|
+
#
|
|
706
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
707
|
+
# @option options [String] :global_cluster_identifier
|
|
708
|
+
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
709
|
+
# cluster in the new global database cluster.
|
|
710
|
+
#
|
|
711
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
712
|
+
# @option options [Boolean] :enable_http_endpoint
|
|
713
|
+
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
714
|
+
# default, the HTTP endpoint isn't enabled.
|
|
715
|
+
#
|
|
716
|
+
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
717
|
+
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
718
|
+
# also query your database from inside the RDS console with the RDS
|
|
719
|
+
# query editor.
|
|
720
|
+
#
|
|
721
|
+
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
722
|
+
# Aurora User Guide*.
|
|
723
|
+
#
|
|
724
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
725
|
+
#
|
|
726
|
+
#
|
|
727
|
+
#
|
|
728
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
729
|
+
# @option options [Boolean] :copy_tags_to_snapshot
|
|
730
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
731
|
+
# the DB cluster. The default is not to copy them.
|
|
732
|
+
#
|
|
733
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
734
|
+
# @option options [String] :domain
|
|
735
|
+
# The Active Directory directory ID to create the DB cluster in.
|
|
736
|
+
#
|
|
737
|
+
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
738
|
+
# authentication to authenticate users that connect to the DB cluster.
|
|
739
|
+
#
|
|
740
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
741
|
+
# Aurora User Guide*.
|
|
742
|
+
#
|
|
743
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
744
|
+
#
|
|
745
|
+
#
|
|
746
|
+
#
|
|
747
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
748
|
+
# @option options [String] :domain_iam_role_name
|
|
749
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
750
|
+
# Service.
|
|
751
|
+
#
|
|
752
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
753
|
+
# @option options [Boolean] :enable_global_write_forwarding
|
|
754
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
755
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
756
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
757
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
758
|
+
#
|
|
759
|
+
# You can set this value only on Aurora DB clusters that are members of
|
|
760
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
|
761
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
762
|
+
# resulting changes are replicated back to this cluster. For the primary
|
|
763
|
+
# DB cluster of an Aurora global database, this value is used
|
|
764
|
+
# immediately if the primary is demoted by a global cluster API
|
|
765
|
+
# operation, but it does nothing until then.
|
|
766
|
+
#
|
|
767
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
768
|
+
# @option options [String] :network_type
|
|
769
|
+
# The network type of the DB cluster.
|
|
770
|
+
#
|
|
771
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
772
|
+
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
773
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
774
|
+
#
|
|
775
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
776
|
+
# the *Amazon Aurora User Guide.*
|
|
777
|
+
#
|
|
778
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
779
|
+
#
|
|
780
|
+
# Valid Values: `IPV4 | DUAL`
|
|
781
|
+
#
|
|
782
|
+
#
|
|
783
|
+
#
|
|
784
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
785
|
+
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
786
|
+
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
787
|
+
# cluster.
|
|
788
|
+
#
|
|
789
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
790
|
+
# the *Amazon Aurora User Guide*.
|
|
791
|
+
#
|
|
792
|
+
#
|
|
793
|
+
#
|
|
794
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
765
795
|
# @option options [Integer] :monitoring_interval
|
|
766
796
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
767
797
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -851,33 +881,6 @@ module Aws::RDS
|
|
|
851
881
|
# `ClusterScalabilityType` setting.
|
|
852
882
|
#
|
|
853
883
|
# </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
884
|
# @option options [String] :cluster_scalability_type
|
|
882
885
|
# Specifies the scalability mode of the Aurora DB cluster. When set to
|
|
883
886
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
@@ -913,6 +916,12 @@ module Aws::RDS
|
|
|
913
916
|
#
|
|
914
917
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
915
918
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
919
|
+
# @option options [Boolean] :enable_local_write_forwarding
|
|
920
|
+
# Specifies whether read replicas can forward write operations to the
|
|
921
|
+
# writer DB instance in the DB cluster. By default, write operations
|
|
922
|
+
# aren't allowed on reader DB instances.
|
|
923
|
+
#
|
|
924
|
+
# Valid for: Aurora DB clusters only
|
|
916
925
|
# @option options [String] :master_user_secret_kms_key_id
|
|
917
926
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
918
927
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -937,12 +946,6 @@ module Aws::RDS
|
|
|
937
946
|
# Amazon Web Services Region.
|
|
938
947
|
#
|
|
939
948
|
# 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
949
|
# @option options [String] :ca_certificate_identifier
|
|
947
950
|
# The CA certificate identifier to use for the DB cluster's server
|
|
948
951
|
# certificate.
|
|
@@ -990,6 +993,29 @@ module Aws::RDS
|
|
|
990
993
|
#
|
|
991
994
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
|
|
992
995
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
996
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
997
|
+
# Tags to assign to resources associated with the DB cluster.
|
|
998
|
+
#
|
|
999
|
+
# Valid Values:
|
|
1000
|
+
#
|
|
1001
|
+
# * `cluster-auto-backup` - The DB cluster's automated backup.
|
|
1002
|
+
#
|
|
1003
|
+
# ^
|
|
1004
|
+
# @option options [String] :master_user_authentication_type
|
|
1005
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
1006
|
+
# user authentication, you can configure the master DB user with IAM
|
|
1007
|
+
# database authentication when you create a DB cluster.
|
|
1008
|
+
#
|
|
1009
|
+
# You can specify one of the following values:
|
|
1010
|
+
#
|
|
1011
|
+
# * `password` - Use standard database authentication with a password.
|
|
1012
|
+
#
|
|
1013
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
1014
|
+
#
|
|
1015
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1016
|
+
#
|
|
1017
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
1018
|
+
# engines.
|
|
993
1019
|
# @option options [String] :source_region
|
|
994
1020
|
# The source region of the snapshot. This is only needed when the
|
|
995
1021
|
# shapshot is encrypted and in a different region.
|
|
@@ -1105,7 +1131,7 @@ module Aws::RDS
|
|
|
1105
1131
|
# db_instance_class: "String", # required
|
|
1106
1132
|
# engine: "String", # required
|
|
1107
1133
|
# master_username: "String",
|
|
1108
|
-
# master_user_password: "
|
|
1134
|
+
# master_user_password: "SensitiveString",
|
|
1109
1135
|
# db_security_groups: ["String"],
|
|
1110
1136
|
# vpc_security_group_ids: ["String"],
|
|
1111
1137
|
# availability_zone: "String",
|
|
@@ -1120,6 +1146,7 @@ module Aws::RDS
|
|
|
1120
1146
|
# auto_minor_version_upgrade: false,
|
|
1121
1147
|
# license_model: "String",
|
|
1122
1148
|
# iops: 1,
|
|
1149
|
+
# storage_throughput: 1,
|
|
1123
1150
|
# option_group_name: "String",
|
|
1124
1151
|
# character_set_name: "String",
|
|
1125
1152
|
# nchar_character_set_name: "String",
|
|
@@ -1133,7 +1160,7 @@ module Aws::RDS
|
|
|
1133
1160
|
# db_cluster_identifier: "String",
|
|
1134
1161
|
# storage_type: "String",
|
|
1135
1162
|
# tde_credential_arn: "String",
|
|
1136
|
-
# tde_credential_password: "
|
|
1163
|
+
# tde_credential_password: "SensitiveString",
|
|
1137
1164
|
# storage_encrypted: false,
|
|
1138
1165
|
# kms_key_id: "String",
|
|
1139
1166
|
# domain: "String",
|
|
@@ -1162,17 +1189,38 @@ module Aws::RDS
|
|
|
1162
1189
|
# deletion_protection: false,
|
|
1163
1190
|
# max_allocated_storage: 1,
|
|
1164
1191
|
# enable_customer_owned_ip: false,
|
|
1165
|
-
# custom_iam_instance_profile: "String",
|
|
1166
|
-
# backup_target: "String",
|
|
1167
1192
|
# network_type: "String",
|
|
1168
|
-
#
|
|
1193
|
+
# backup_target: "String",
|
|
1194
|
+
# custom_iam_instance_profile: "String",
|
|
1195
|
+
# db_system_id: "String",
|
|
1196
|
+
# ca_certificate_identifier: "String",
|
|
1169
1197
|
# manage_master_user_password: false,
|
|
1170
1198
|
# master_user_secret_kms_key_id: "String",
|
|
1171
|
-
# ca_certificate_identifier: "String",
|
|
1172
|
-
# db_system_id: "String",
|
|
1173
|
-
# dedicated_log_volume: false,
|
|
1174
1199
|
# multi_tenant: false,
|
|
1200
|
+
# dedicated_log_volume: false,
|
|
1175
1201
|
# engine_lifecycle_support: "String",
|
|
1202
|
+
# tag_specifications: [
|
|
1203
|
+
# {
|
|
1204
|
+
# resource_type: "String",
|
|
1205
|
+
# tags: [
|
|
1206
|
+
# {
|
|
1207
|
+
# key: "String",
|
|
1208
|
+
# value: "String",
|
|
1209
|
+
# },
|
|
1210
|
+
# ],
|
|
1211
|
+
# },
|
|
1212
|
+
# ],
|
|
1213
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
1214
|
+
# additional_storage_volumes: [
|
|
1215
|
+
# {
|
|
1216
|
+
# volume_name: "String", # required
|
|
1217
|
+
# allocated_storage: 1,
|
|
1218
|
+
# iops: 1,
|
|
1219
|
+
# max_allocated_storage: 1,
|
|
1220
|
+
# storage_throughput: 1,
|
|
1221
|
+
# storage_type: "String",
|
|
1222
|
+
# },
|
|
1223
|
+
# ],
|
|
1176
1224
|
# })
|
|
1177
1225
|
# @param [Hash] options ({})
|
|
1178
1226
|
# @option options [String] :db_name
|
|
@@ -1493,6 +1541,8 @@ module Aws::RDS
|
|
|
1493
1541
|
#
|
|
1494
1542
|
# * `postgres`
|
|
1495
1543
|
#
|
|
1544
|
+
# * `sqlserver-dev-ee`
|
|
1545
|
+
#
|
|
1496
1546
|
# * `sqlserver-ee`
|
|
1497
1547
|
#
|
|
1498
1548
|
# * `sqlserver-se`
|
|
@@ -1847,6 +1897,14 @@ module Aws::RDS
|
|
|
1847
1897
|
#
|
|
1848
1898
|
#
|
|
1849
1899
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
1900
|
+
# @option options [Integer] :storage_throughput
|
|
1901
|
+
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
1902
|
+
# DB instance.
|
|
1903
|
+
#
|
|
1904
|
+
# This setting applies only to the `gp3` storage type.
|
|
1905
|
+
#
|
|
1906
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
1907
|
+
# instances.
|
|
1850
1908
|
# @option options [String] :option_group_name
|
|
1851
1909
|
# The option group to associate the DB instance with.
|
|
1852
1910
|
#
|
|
@@ -1876,37 +1934,28 @@ module Aws::RDS
|
|
|
1876
1934
|
# Specifies whether the DB instance is publicly accessible.
|
|
1877
1935
|
#
|
|
1878
1936
|
# When the DB instance is publicly accessible and you connect from
|
|
1879
|
-
# outside of the DB instance's virtual private cloud (VPC), its
|
|
1880
|
-
#
|
|
1937
|
+
# outside of the DB instance's virtual private cloud (VPC), its domain
|
|
1938
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
1881
1939
|
# connect from within the same VPC as the DB instance, the endpoint
|
|
1882
1940
|
# 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.
|
|
1941
|
+
# controlled by its security group settings.
|
|
1886
1942
|
#
|
|
1887
1943
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
|
1888
1944
|
# instance with a DNS name that resolves to a private IP address.
|
|
1889
1945
|
#
|
|
1890
|
-
#
|
|
1891
|
-
# `
|
|
1892
|
-
#
|
|
1893
|
-
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
|
1894
|
-
# isn't specified, the following applies:
|
|
1946
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
1947
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
1895
1948
|
#
|
|
1896
|
-
#
|
|
1897
|
-
#
|
|
1949
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
1950
|
+
# `false` for Aurora instances and `true` for non-Aurora instances.
|
|
1898
1951
|
#
|
|
1899
|
-
#
|
|
1900
|
-
#
|
|
1952
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
1953
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
1954
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
1901
1955
|
#
|
|
1902
|
-
# If `
|
|
1903
|
-
#
|
|
1904
|
-
#
|
|
1905
|
-
# * If the subnets are part of a VPC that doesn’t have an internet
|
|
1906
|
-
# gateway attached to it, the DB instance is private.
|
|
1907
|
-
#
|
|
1908
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
1909
|
-
# attached to it, the DB instance is public.
|
|
1956
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
1957
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
1958
|
+
# returns an error.
|
|
1910
1959
|
# @option options [Array<Types::Tag>] :tags
|
|
1911
1960
|
# Tags to assign to the DB instance.
|
|
1912
1961
|
# @option options [String] :db_cluster_identifier
|
|
@@ -2250,28 +2299,21 @@ module Aws::RDS
|
|
|
2250
2299
|
#
|
|
2251
2300
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2252
2301
|
# [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.
|
|
2302
|
+
# @option options [String] :network_type
|
|
2303
|
+
# The network type of the DB instance.
|
|
2262
2304
|
#
|
|
2263
|
-
#
|
|
2264
|
-
#
|
|
2305
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2306
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2307
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2265
2308
|
#
|
|
2266
|
-
#
|
|
2267
|
-
#
|
|
2309
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2310
|
+
# the *Amazon RDS User Guide.*
|
|
2268
2311
|
#
|
|
2269
|
-
#
|
|
2270
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2312
|
+
# Valid Values: `IPV4 | DUAL`
|
|
2271
2313
|
#
|
|
2272
2314
|
#
|
|
2273
2315
|
#
|
|
2274
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2316
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2275
2317
|
# @option options [String] :backup_target
|
|
2276
2318
|
# The location for storing automated backups and manual snapshots.
|
|
2277
2319
|
#
|
|
@@ -2291,29 +2333,50 @@ module Aws::RDS
|
|
|
2291
2333
|
#
|
|
2292
2334
|
#
|
|
2293
2335
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2294
|
-
# @option options [String] :
|
|
2295
|
-
# The
|
|
2336
|
+
# @option options [String] :custom_iam_instance_profile
|
|
2337
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
2338
|
+
# instance of an RDS Custom DB instance.
|
|
2296
2339
|
#
|
|
2297
|
-
#
|
|
2298
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2299
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2340
|
+
# This setting is required for RDS Custom.
|
|
2300
2341
|
#
|
|
2301
|
-
#
|
|
2302
|
-
# the *Amazon RDS User Guide.*
|
|
2342
|
+
# Constraints:
|
|
2303
2343
|
#
|
|
2304
|
-
#
|
|
2344
|
+
# * The profile must exist in your account.
|
|
2305
2345
|
#
|
|
2346
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2347
|
+
# assume.
|
|
2306
2348
|
#
|
|
2349
|
+
# * The instance profile name and the associated IAM role name must
|
|
2350
|
+
# start with the prefix `AWSRDSCustom`.
|
|
2307
2351
|
#
|
|
2308
|
-
# [
|
|
2309
|
-
#
|
|
2310
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
2311
|
-
# DB instance.
|
|
2352
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
2353
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2312
2354
|
#
|
|
2313
|
-
# This setting applies only to the `gp3` storage type.
|
|
2314
2355
|
#
|
|
2315
|
-
#
|
|
2316
|
-
#
|
|
2356
|
+
#
|
|
2357
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2358
|
+
# @option options [String] :db_system_id
|
|
2359
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2360
|
+
# database instance that manages your database files. In this context,
|
|
2361
|
+
# the term "Oracle database instance" refers exclusively to the system
|
|
2362
|
+
# global area (SGA) and Oracle background processes. If you don't
|
|
2363
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2364
|
+
# the name of your CDB.
|
|
2365
|
+
# @option options [String] :ca_certificate_identifier
|
|
2366
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
2367
|
+
# certificate.
|
|
2368
|
+
#
|
|
2369
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
2370
|
+
#
|
|
2371
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2372
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2373
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2374
|
+
# Guide*.
|
|
2375
|
+
#
|
|
2376
|
+
#
|
|
2377
|
+
#
|
|
2378
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2379
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2317
2380
|
# @option options [Boolean] :manage_master_user_password
|
|
2318
2381
|
# Specifies whether to manage the master user password with Amazon Web
|
|
2319
2382
|
# Services Secrets Manager.
|
|
@@ -2353,31 +2416,6 @@ module Aws::RDS
|
|
|
2353
2416
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
2354
2417
|
# Amazon Web Services account has a different default KMS key for each
|
|
2355
2418
|
# 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
2419
|
# @option options [Boolean] :multi_tenant
|
|
2382
2420
|
# Specifies whether to use the multi-tenant configuration or the
|
|
2383
2421
|
# single-tenant configuration (default). This parameter only applies to
|
|
@@ -2393,6 +2431,9 @@ module Aws::RDS
|
|
|
2393
2431
|
# * If you specify the multi-tenant configuration when you create your
|
|
2394
2432
|
# DB instance, you can't later modify this DB instance to use the
|
|
2395
2433
|
# single-tenant configuration.
|
|
2434
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
2435
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2436
|
+
# enabled.
|
|
2396
2437
|
# @option options [String] :engine_lifecycle_support
|
|
2397
2438
|
# The life cycle type for this DB instance.
|
|
2398
2439
|
#
|
|
@@ -2424,6 +2465,33 @@ module Aws::RDS
|
|
|
2424
2465
|
#
|
|
2425
2466
|
#
|
|
2426
2467
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
2468
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
2469
|
+
# Tags to assign to resources associated with the DB instance.
|
|
2470
|
+
#
|
|
2471
|
+
# Valid Values:
|
|
2472
|
+
#
|
|
2473
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
2474
|
+
#
|
|
2475
|
+
# ^
|
|
2476
|
+
# @option options [String] :master_user_authentication_type
|
|
2477
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
2478
|
+
# user authentication, you can configure the master DB user with IAM
|
|
2479
|
+
# database authentication when you create a DB instance.
|
|
2480
|
+
#
|
|
2481
|
+
# You can specify one of the following values:
|
|
2482
|
+
#
|
|
2483
|
+
# * `password` - Use standard database authentication with a password.
|
|
2484
|
+
#
|
|
2485
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
2486
|
+
#
|
|
2487
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
2488
|
+
# engines.
|
|
2489
|
+
# @option options [Array<Types::AdditionalStorageVolume>] :additional_storage_volumes
|
|
2490
|
+
# A list of additional storage volumes to create for the DB instance.
|
|
2491
|
+
# You can create up to three additional storage volumes using the names
|
|
2492
|
+
# `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage
|
|
2493
|
+
# volumes are supported for RDS for Oracle and RDS for SQL Server DB
|
|
2494
|
+
# instances only.
|
|
2427
2495
|
# @return [DBInstance]
|
|
2428
2496
|
def create_db_instance(options = {})
|
|
2429
2497
|
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
@@ -3666,7 +3734,7 @@ module Aws::RDS
|
|
|
3666
3734
|
#
|
|
3667
3735
|
# events = rds.events({
|
|
3668
3736
|
# 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
|
|
3737
|
+
# 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
3738
|
# start_time: Time.now,
|
|
3671
3739
|
# end_time: Time.now,
|
|
3672
3740
|
# duration: 1,
|