aws-sdk-rds 1.185.0 → 1.187.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.
@@ -72,17 +72,10 @@ module Aws::RDS
72
72
  data[:master_username]
73
73
  end
74
74
 
75
- # The meaning of this parameter differs depending on the database
76
- # engine.
77
- #
78
- # * For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL -
79
- # The name of the initial database specified for this DB instance when
80
- # it was created, if one was provided. This same name is returned for
81
- # the life of the DB instance.
82
- #
83
- # * For RDS for Oracle - The Oracle System ID (SID) of the created DB
84
- # instance. This value is only returned when the object returned is an
85
- # Oracle DB instance.
75
+ # Contains the initial database name that you provided (if required)
76
+ # when you created the DB instance. This name is returned for the life
77
+ # of your DB instance. For an RDS for Oracle CDB instance, the name
78
+ # identifies the PDB rather than the CDB.
86
79
  # @return [String]
87
80
  def db_name
88
81
  data[:db_name]
@@ -758,6 +751,12 @@ module Aws::RDS
758
751
  data[:read_replica_source_db_cluster_identifier]
759
752
  end
760
753
 
754
+ # The progress of the storage optimization operation as a percentage.
755
+ # @return [String]
756
+ def percent_progress
757
+ data[:percent_progress]
758
+ end
759
+
761
760
  # @!endgroup
762
761
 
763
762
  # @return [Client]
@@ -967,119 +966,124 @@ module Aws::RDS
967
966
  # manage_master_user_password: false,
968
967
  # master_user_secret_kms_key_id: "String",
969
968
  # ca_certificate_identifier: "String",
969
+ # db_system_id: "String",
970
970
  # })
971
971
  # @param [Hash] options ({})
972
972
  # @option options [String] :db_name
973
- # The meaning of this parameter differs depending on the database
974
- # engine.
975
- #
976
- # Amazon Aurora MySQL
973
+ # The meaning of this parameter differs according to the database engine
974
+ # you use.
977
975
  #
978
- # : The name of the database to create when the primary DB instance of
979
- # the Aurora MySQL DB cluster is created. If you don't specify a
980
- # value, Amazon RDS doesn't create a database in the DB cluster.
976
+ # **MySQL**
981
977
  #
982
- # Constraints:
978
+ # The name of the database to create when the DB instance is created. If
979
+ # this parameter isn't specified, no database is created in the DB
980
+ # instance.
983
981
  #
984
- # * Must contain 1 to 64 alphanumeric characters.
982
+ # Constraints:
985
983
  #
986
- # * Can't be a word reserved by the database engine.
984
+ # * Must contain 1 to 64 letters or numbers.
987
985
  #
988
- # Amazon Aurora PostgreSQL
986
+ # * Must begin with a letter. Subsequent characters can be letters,
987
+ # underscores, or digits (0-9).
989
988
  #
990
- # : The name of the database to create when the primary DB instance of
991
- # the Aurora PostgreSQL DB cluster is created.
989
+ # * Can't be a word reserved by the specified database engine
992
990
  #
993
- # Default: `postgres`
991
+ # **MariaDB**
994
992
  #
995
- # Constraints:
993
+ # The name of the database to create when the DB instance is created. If
994
+ # this parameter isn't specified, no database is created in the DB
995
+ # instance.
996
996
  #
997
- # * Must contain 1 to 63 alphanumeric characters.
997
+ # Constraints:
998
998
  #
999
- # * Must begin with a letter. Subsequent characters can be letters,
1000
- # underscores, or digits (0 to 9).
999
+ # * Must contain 1 to 64 letters or numbers.
1001
1000
  #
1002
- # * Can't be a word reserved by the database engine.
1001
+ # * Must begin with a letter. Subsequent characters can be letters,
1002
+ # underscores, or digits (0-9).
1003
1003
  #
1004
- # Amazon RDS Custom for Oracle
1004
+ # * Can't be a word reserved by the specified database engine
1005
1005
  #
1006
- # : The Oracle System ID (SID) of the created RDS Custom DB instance.
1006
+ # **PostgreSQL**
1007
1007
  #
1008
- # Default: `ORCL`
1008
+ # The name of the database to create when the DB instance is created. If
1009
+ # this parameter isn't specified, a database named `postgres` is
1010
+ # created in the DB instance.
1009
1011
  #
1010
- # Constraints:
1012
+ # Constraints:
1011
1013
  #
1012
- # * Must contain 1 to 8 alphanumeric characters.
1014
+ # * Must contain 1 to 63 letters, numbers, or underscores.
1013
1015
  #
1014
- # * Must contain a letter.
1016
+ # * Must begin with a letter. Subsequent characters can be letters,
1017
+ # underscores, or digits (0-9).
1015
1018
  #
1016
- # * Can't be a word reserved by the database engine.
1019
+ # * Can't be a word reserved by the specified database engine
1017
1020
  #
1018
- # Amazon RDS Custom for SQL Server
1021
+ # **Oracle**
1019
1022
  #
1020
- # : Not applicable. Must be null.
1023
+ # The Oracle System ID (SID) of the created DB instance. If you don't
1024
+ # specify a value, the default value is `ORCL`. You can't specify the
1025
+ # string `null`, or any other reserved word, for `DBName`.
1021
1026
  #
1022
- # RDS for MariaDB
1027
+ # Default: `ORCL`
1023
1028
  #
1024
- # : The name of the database to create when the DB instance is created.
1025
- # If you don't specify a value, Amazon RDS doesn't create a database
1026
- # in the DB instance.
1027
- #
1028
- # Constraints:
1029
+ # Constraints:
1029
1030
  #
1030
- # * Must contain 1 to 64 letters or numbers.
1031
+ # * Can't be longer than 8 characters
1031
1032
  #
1032
- # * Must begin with a letter. Subsequent characters can be letters,
1033
- # underscores, or digits (0-9).
1033
+ # ^
1034
1034
  #
1035
- # * Can't be a word reserved by the database engine.
1035
+ # **Amazon RDS Custom for Oracle**
1036
1036
  #
1037
- # RDS for MySQL
1037
+ # The Oracle System ID (SID) of the created RDS Custom DB instance. If
1038
+ # you don't specify a value, the default value is `ORCL` for non-CDBs
1039
+ # and `RDSCDB` for CDBs.
1038
1040
  #
1039
- # : The name of the database to create when the DB instance is created.
1040
- # If you don't specify a value, Amazon RDS doesn't create a database
1041
- # in the DB instance.
1041
+ # Default: `ORCL`
1042
1042
  #
1043
- # Constraints:
1043
+ # Constraints:
1044
1044
  #
1045
- # * Must contain 1 to 64 letters or numbers.
1045
+ # * It must contain 1 to 8 alphanumeric characters.
1046
1046
  #
1047
- # * Must begin with a letter. Subsequent characters can be letters,
1048
- # underscores, or digits (0-9).
1047
+ # * It must contain a letter.
1049
1048
  #
1050
- # * Can't be a word reserved by the database engine.
1049
+ # * It can't be a word reserved by the database engine.
1051
1050
  #
1052
- # RDS for Oracle
1051
+ # **Amazon RDS Custom for SQL Server**
1053
1052
  #
1054
- # : The Oracle System ID (SID) of the created DB instance.
1053
+ # Not applicable. Must be null.
1055
1054
  #
1056
- # Default: `ORCL`
1055
+ # **SQL Server**
1057
1056
  #
1058
- # Constraints:
1057
+ # Not applicable. Must be null.
1059
1058
  #
1060
- # * Can't be longer than 8 characters.
1059
+ # **Amazon Aurora MySQL**
1061
1060
  #
1062
- # * Can't be a word reserved by the database engine, such as the
1063
- # string `NULL`.
1061
+ # The name of the database to create when the primary DB instance of the
1062
+ # Aurora MySQL DB cluster is created. If this parameter isn't specified
1063
+ # for an Aurora MySQL DB cluster, no database is created in the DB
1064
+ # cluster.
1064
1065
  #
1065
- # RDS for PostgreSQL
1066
+ # Constraints:
1066
1067
  #
1067
- # : The name of the database to create when the DB instance is created.
1068
+ # * It must contain 1 to 64 alphanumeric characters.
1068
1069
  #
1069
- # Default: `postgres`
1070
+ # * It can't be a word reserved by the database engine.
1070
1071
  #
1071
- # Constraints:
1072
+ # **Amazon Aurora PostgreSQL**
1072
1073
  #
1073
- # * Must contain 1 to 63 letters, numbers, or underscores.
1074
+ # The name of the database to create when the primary DB instance of the
1075
+ # Aurora PostgreSQL DB cluster is created. If this parameter isn't
1076
+ # specified for an Aurora PostgreSQL DB cluster, a database named
1077
+ # `postgres` is created in the DB cluster.
1074
1078
  #
1075
- # * Must begin with a letter. Subsequent characters can be letters,
1076
- # underscores, or digits (0-9).
1079
+ # Constraints:
1077
1080
  #
1078
- # * Can't be a word reserved by the database engine.
1081
+ # * It must contain 1 to 63 alphanumeric characters.
1079
1082
  #
1080
- # RDS for SQL Server
1083
+ # * It must begin with a letter. Subsequent characters can be letters,
1084
+ # underscores, or digits (0 to 9).
1081
1085
  #
1082
- # : Not applicable. Must be null.
1086
+ # * It can't be a word reserved by the database engine.
1083
1087
  # @option options [Integer] :allocated_storage
1084
1088
  # The amount of storage in gibibytes (GiB) to allocate for the DB
1085
1089
  # instance.
@@ -2054,6 +2058,13 @@ module Aws::RDS
2054
2058
  #
2055
2059
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
2056
2060
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
2061
+ # @option options [String] :db_system_id
2062
+ # The Oracle system identifier (SID), which is the name of the Oracle
2063
+ # database instance that manages your database files. In this context,
2064
+ # the term "Oracle database instance" refers exclusively to the system
2065
+ # global area (SGA) and Oracle background processes. If you don't
2066
+ # specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
2067
+ # the name of your CDB.
2057
2068
  # @return [DBInstance]
2058
2069
  def create(options = {})
2059
2070
  options = options.merge(db_instance_identifier: @id)
@@ -3314,7 +3325,7 @@ module Aws::RDS
3314
3325
  #
3315
3326
  # This setting doesn't apply to RDS Custom DB instances.
3316
3327
  # @option options [String] :ca_certificate_identifier
3317
- # The CA certificate identifier to use for the DB instance6's server
3328
+ # The CA certificate identifier to use for the DB instance's server
3318
3329
  # certificate.
3319
3330
  #
3320
3331
  # This setting doesn't apply to RDS Custom DB instances.
@@ -265,6 +265,14 @@ module Aws::RDS
265
265
  data[:storage_throughput]
266
266
  end
267
267
 
268
+ # The Oracle system identifier (SID), which is the name of the Oracle
269
+ # database instance that manages your database files. The Oracle SID is
270
+ # also the name of your CDB.
271
+ # @return [String]
272
+ def db_system_id
273
+ data[:db_system_id]
274
+ end
275
+
268
276
  # @!endgroup
269
277
 
270
278
  # @return [Client]
@@ -1022,119 +1022,124 @@ module Aws::RDS
1022
1022
  # manage_master_user_password: false,
1023
1023
  # master_user_secret_kms_key_id: "String",
1024
1024
  # ca_certificate_identifier: "String",
1025
+ # db_system_id: "String",
1025
1026
  # })
1026
1027
  # @param [Hash] options ({})
1027
1028
  # @option options [String] :db_name
1028
- # The meaning of this parameter differs depending on the database
1029
- # engine.
1030
- #
1031
- # Amazon Aurora MySQL
1032
- #
1033
- # : The name of the database to create when the primary DB instance of
1034
- # the Aurora MySQL DB cluster is created. If you don't specify a
1035
- # value, Amazon RDS doesn't create a database in the DB cluster.
1029
+ # The meaning of this parameter differs according to the database engine
1030
+ # you use.
1036
1031
  #
1037
- # Constraints:
1032
+ # **MySQL**
1038
1033
  #
1039
- # * Must contain 1 to 64 alphanumeric characters.
1034
+ # The name of the database to create when the DB instance is created. If
1035
+ # this parameter isn't specified, no database is created in the DB
1036
+ # instance.
1040
1037
  #
1041
- # * Can't be a word reserved by the database engine.
1038
+ # Constraints:
1042
1039
  #
1043
- # Amazon Aurora PostgreSQL
1040
+ # * Must contain 1 to 64 letters or numbers.
1044
1041
  #
1045
- # : The name of the database to create when the primary DB instance of
1046
- # the Aurora PostgreSQL DB cluster is created.
1042
+ # * Must begin with a letter. Subsequent characters can be letters,
1043
+ # underscores, or digits (0-9).
1047
1044
  #
1048
- # Default: `postgres`
1045
+ # * Can't be a word reserved by the specified database engine
1049
1046
  #
1050
- # Constraints:
1047
+ # **MariaDB**
1051
1048
  #
1052
- # * Must contain 1 to 63 alphanumeric characters.
1049
+ # The name of the database to create when the DB instance is created. If
1050
+ # this parameter isn't specified, no database is created in the DB
1051
+ # instance.
1053
1052
  #
1054
- # * Must begin with a letter. Subsequent characters can be letters,
1055
- # underscores, or digits (0 to 9).
1053
+ # Constraints:
1056
1054
  #
1057
- # * Can't be a word reserved by the database engine.
1055
+ # * Must contain 1 to 64 letters or numbers.
1058
1056
  #
1059
- # Amazon RDS Custom for Oracle
1057
+ # * Must begin with a letter. Subsequent characters can be letters,
1058
+ # underscores, or digits (0-9).
1060
1059
  #
1061
- # : The Oracle System ID (SID) of the created RDS Custom DB instance.
1060
+ # * Can't be a word reserved by the specified database engine
1062
1061
  #
1063
- # Default: `ORCL`
1062
+ # **PostgreSQL**
1064
1063
  #
1065
- # Constraints:
1064
+ # The name of the database to create when the DB instance is created. If
1065
+ # this parameter isn't specified, a database named `postgres` is
1066
+ # created in the DB instance.
1066
1067
  #
1067
- # * Must contain 1 to 8 alphanumeric characters.
1068
+ # Constraints:
1068
1069
  #
1069
- # * Must contain a letter.
1070
+ # * Must contain 1 to 63 letters, numbers, or underscores.
1070
1071
  #
1071
- # * Can't be a word reserved by the database engine.
1072
+ # * Must begin with a letter. Subsequent characters can be letters,
1073
+ # underscores, or digits (0-9).
1072
1074
  #
1073
- # Amazon RDS Custom for SQL Server
1075
+ # * Can't be a word reserved by the specified database engine
1074
1076
  #
1075
- # : Not applicable. Must be null.
1077
+ # **Oracle**
1076
1078
  #
1077
- # RDS for MariaDB
1079
+ # The Oracle System ID (SID) of the created DB instance. If you don't
1080
+ # specify a value, the default value is `ORCL`. You can't specify the
1081
+ # string `null`, or any other reserved word, for `DBName`.
1078
1082
  #
1079
- # : The name of the database to create when the DB instance is created.
1080
- # If you don't specify a value, Amazon RDS doesn't create a database
1081
- # in the DB instance.
1083
+ # Default: `ORCL`
1082
1084
  #
1083
- # Constraints:
1085
+ # Constraints:
1084
1086
  #
1085
- # * Must contain 1 to 64 letters or numbers.
1087
+ # * Can't be longer than 8 characters
1086
1088
  #
1087
- # * Must begin with a letter. Subsequent characters can be letters,
1088
- # underscores, or digits (0-9).
1089
+ # ^
1089
1090
  #
1090
- # * Can't be a word reserved by the database engine.
1091
+ # **Amazon RDS Custom for Oracle**
1091
1092
  #
1092
- # RDS for MySQL
1093
+ # The Oracle System ID (SID) of the created RDS Custom DB instance. If
1094
+ # you don't specify a value, the default value is `ORCL` for non-CDBs
1095
+ # and `RDSCDB` for CDBs.
1093
1096
  #
1094
- # : The name of the database to create when the DB instance is created.
1095
- # If you don't specify a value, Amazon RDS doesn't create a database
1096
- # in the DB instance.
1097
+ # Default: `ORCL`
1097
1098
  #
1098
- # Constraints:
1099
+ # Constraints:
1099
1100
  #
1100
- # * Must contain 1 to 64 letters or numbers.
1101
+ # * It must contain 1 to 8 alphanumeric characters.
1101
1102
  #
1102
- # * Must begin with a letter. Subsequent characters can be letters,
1103
- # underscores, or digits (0-9).
1103
+ # * It must contain a letter.
1104
1104
  #
1105
- # * Can't be a word reserved by the database engine.
1105
+ # * It can't be a word reserved by the database engine.
1106
1106
  #
1107
- # RDS for Oracle
1107
+ # **Amazon RDS Custom for SQL Server**
1108
1108
  #
1109
- # : The Oracle System ID (SID) of the created DB instance.
1109
+ # Not applicable. Must be null.
1110
1110
  #
1111
- # Default: `ORCL`
1111
+ # **SQL Server**
1112
1112
  #
1113
- # Constraints:
1113
+ # Not applicable. Must be null.
1114
1114
  #
1115
- # * Can't be longer than 8 characters.
1115
+ # **Amazon Aurora MySQL**
1116
1116
  #
1117
- # * Can't be a word reserved by the database engine, such as the
1118
- # string `NULL`.
1117
+ # The name of the database to create when the primary DB instance of the
1118
+ # Aurora MySQL DB cluster is created. If this parameter isn't specified
1119
+ # for an Aurora MySQL DB cluster, no database is created in the DB
1120
+ # cluster.
1119
1121
  #
1120
- # RDS for PostgreSQL
1122
+ # Constraints:
1121
1123
  #
1122
- # : The name of the database to create when the DB instance is created.
1124
+ # * It must contain 1 to 64 alphanumeric characters.
1123
1125
  #
1124
- # Default: `postgres`
1126
+ # * It can't be a word reserved by the database engine.
1125
1127
  #
1126
- # Constraints:
1128
+ # **Amazon Aurora PostgreSQL**
1127
1129
  #
1128
- # * Must contain 1 to 63 letters, numbers, or underscores.
1130
+ # The name of the database to create when the primary DB instance of the
1131
+ # Aurora PostgreSQL DB cluster is created. If this parameter isn't
1132
+ # specified for an Aurora PostgreSQL DB cluster, a database named
1133
+ # `postgres` is created in the DB cluster.
1129
1134
  #
1130
- # * Must begin with a letter. Subsequent characters can be letters,
1131
- # underscores, or digits (0-9).
1135
+ # Constraints:
1132
1136
  #
1133
- # * Can't be a word reserved by the database engine.
1137
+ # * It must contain 1 to 63 alphanumeric characters.
1134
1138
  #
1135
- # RDS for SQL Server
1139
+ # * It must begin with a letter. Subsequent characters can be letters,
1140
+ # underscores, or digits (0 to 9).
1136
1141
  #
1137
- # : Not applicable. Must be null.
1142
+ # * It can't be a word reserved by the database engine.
1138
1143
  # @option options [required, String] :db_instance_identifier
1139
1144
  # The identifier for this DB instance. This parameter is stored as a
1140
1145
  # lowercase string.
@@ -2122,6 +2127,13 @@ module Aws::RDS
2122
2127
  #
2123
2128
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
2124
2129
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
2130
+ # @option options [String] :db_system_id
2131
+ # The Oracle system identifier (SID), which is the name of the Oracle
2132
+ # database instance that manages your database files. In this context,
2133
+ # the term "Oracle database instance" refers exclusively to the system
2134
+ # global area (SGA) and Oracle background processes. If you don't
2135
+ # specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
2136
+ # the name of your CDB.
2125
2137
  # @return [DBInstance]
2126
2138
  def create_db_instance(options = {})
2127
2139
  resp = Aws::Plugins::UserAgent.feature('resource') do