aws-sdk-rds 1.200.0 → 1.201.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.
@@ -4362,6 +4362,23 @@ module Aws::RDS
4362
4362
  # enabled.
4363
4363
  # @return [Boolean]
4364
4364
  #
4365
+ # @!attribute [rw] multi_tenant
4366
+ # Specifies whether to use the multi-tenant configuration or the
4367
+ # single-tenant configuration (default). This parameter only applies
4368
+ # to RDS for Oracle container database (CDB) engines.
4369
+ #
4370
+ # Note the following restrictions:
4371
+ #
4372
+ # * The DB engine that you specify in the request must support the
4373
+ # multi-tenant configuration. If you attempt to enable the
4374
+ # multi-tenant configuration on a DB engine that doesn't support
4375
+ # it, the request fails.
4376
+ #
4377
+ # * If you specify the multi-tenant configuration when you create your
4378
+ # DB instance, you can't later modify this DB instance to use the
4379
+ # single-tenant configuration.
4380
+ # @return [Boolean]
4381
+ #
4365
4382
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
4366
4383
  #
4367
4384
  class CreateDBInstanceMessage < Struct.new(
@@ -4425,7 +4442,8 @@ module Aws::RDS
4425
4442
  :master_user_secret_kms_key_id,
4426
4443
  :ca_certificate_identifier,
4427
4444
  :db_system_id,
4428
- :dedicated_log_volume)
4445
+ :dedicated_log_volume,
4446
+ :multi_tenant)
4429
4447
  SENSITIVE = []
4430
4448
  include Aws::Structure
4431
4449
  end
@@ -6001,6 +6019,88 @@ module Aws::RDS
6001
6019
  include Aws::Structure
6002
6020
  end
6003
6021
 
6022
+ # @!attribute [rw] db_instance_identifier
6023
+ # The user-supplied DB instance identifier. RDS creates your tenant
6024
+ # database in this DB instance. This parameter isn't case-sensitive.
6025
+ # @return [String]
6026
+ #
6027
+ # @!attribute [rw] tenant_db_name
6028
+ # The user-supplied name of the tenant database that you want to
6029
+ # create in your DB instance. This parameter has the same constraints
6030
+ # as `DBName` in `CreateDBInstance`.
6031
+ # @return [String]
6032
+ #
6033
+ # @!attribute [rw] master_username
6034
+ # The name for the master user account in your tenant database. RDS
6035
+ # creates this user account in the tenant database and grants
6036
+ # privileges to the master user. This parameter is case-sensitive.
6037
+ #
6038
+ # Constraints:
6039
+ #
6040
+ # * Must be 1 to 16 letters, numbers, or underscores.
6041
+ #
6042
+ # * First character must be a letter.
6043
+ #
6044
+ # * Can't be a reserved word for the chosen database engine.
6045
+ # @return [String]
6046
+ #
6047
+ # @!attribute [rw] master_user_password
6048
+ # The password for the master user in your tenant database.
6049
+ #
6050
+ # Constraints:
6051
+ #
6052
+ # * Must be 8 to 30 characters.
6053
+ #
6054
+ # * Can include any printable ASCII character except forward slash
6055
+ # (`/`), double quote (`"`), at symbol (`@`), ampersand (`&`), or
6056
+ # single quote (`'`).
6057
+ # @return [String]
6058
+ #
6059
+ # @!attribute [rw] character_set_name
6060
+ # The character set for your tenant database. If you don't specify a
6061
+ # value, the character set name defaults to `AL32UTF8`.
6062
+ # @return [String]
6063
+ #
6064
+ # @!attribute [rw] nchar_character_set_name
6065
+ # The `NCHAR` value for the tenant database.
6066
+ # @return [String]
6067
+ #
6068
+ # @!attribute [rw] tags
6069
+ # A list of tags. For more information, see [Tagging Amazon RDS
6070
+ # Resources][1] in the *Amazon RDS User Guide.*
6071
+ #
6072
+ #
6073
+ #
6074
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
6075
+ # @return [Array<Types::Tag>]
6076
+ #
6077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateTenantDatabaseMessage AWS API Documentation
6078
+ #
6079
+ class CreateTenantDatabaseMessage < Struct.new(
6080
+ :db_instance_identifier,
6081
+ :tenant_db_name,
6082
+ :master_username,
6083
+ :master_user_password,
6084
+ :character_set_name,
6085
+ :nchar_character_set_name,
6086
+ :tags)
6087
+ SENSITIVE = [:master_user_password]
6088
+ include Aws::Structure
6089
+ end
6090
+
6091
+ # @!attribute [rw] tenant_database
6092
+ # A tenant database in the DB instance. This data type is an element
6093
+ # in the response to the `DescribeTenantDatabases` action.
6094
+ # @return [Types::TenantDatabase]
6095
+ #
6096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateTenantDatabaseResult AWS API Documentation
6097
+ #
6098
+ class CreateTenantDatabaseResult < Struct.new(
6099
+ :tenant_database)
6100
+ SENSITIVE = []
6101
+ include Aws::Structure
6102
+ end
6103
+
6004
6104
  # `CustomAvailabilityZoneId` doesn't refer to an existing custom
6005
6105
  # Availability Zone identifier.
6006
6106
  #
@@ -7931,10 +8031,10 @@ module Aws::RDS
7931
8031
  # @return [String]
7932
8032
  #
7933
8033
  # @!attribute [rw] db_name
7934
- # Contains the initial database name that you provided (if required)
7935
- # when you created the DB instance. This name is returned for the life
7936
- # of your DB instance. For an RDS for Oracle CDB instance, the name
7937
- # identifies the PDB rather than the CDB.
8034
+ # The initial database name that you provided (if required) when you
8035
+ # created the DB instance. This name is returned for the life of your
8036
+ # DB instance. For an RDS for Oracle CDB instance, the name identifies
8037
+ # the PDB rather than the CDB.
7938
8038
  # @return [String]
7939
8039
  #
7940
8040
  # @!attribute [rw] endpoint
@@ -8485,6 +8585,11 @@ module Aws::RDS
8485
8585
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem
8486
8586
  # @return [Boolean]
8487
8587
  #
8588
+ # @!attribute [rw] multi_tenant
8589
+ # Specifies whether the DB instance is in the multi-tenant
8590
+ # configuration (TRUE) or the single-tenant configuration (FALSE).
8591
+ # @return [Boolean]
8592
+ #
8488
8593
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
8489
8594
  #
8490
8595
  class DBInstance < Struct.new(
@@ -8571,7 +8676,8 @@ module Aws::RDS
8571
8676
  :read_replica_source_db_cluster_identifier,
8572
8677
  :percent_progress,
8573
8678
  :dedicated_log_volume,
8574
- :is_storage_config_upgrade_available)
8679
+ :is_storage_config_upgrade_available,
8680
+ :multi_tenant)
8575
8681
  SENSITIVE = []
8576
8682
  include Aws::Structure
8577
8683
  end
@@ -8739,6 +8845,12 @@ module Aws::RDS
8739
8845
  # enabled.
8740
8846
  # @return [Boolean]
8741
8847
  #
8848
+ # @!attribute [rw] multi_tenant
8849
+ # Specifies whether the automatic backup is for a DB instance in the
8850
+ # multi-tenant configuration (TRUE) or the single-tenant configuration
8851
+ # (FALSE).
8852
+ # @return [Boolean]
8853
+ #
8742
8854
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackup AWS API Documentation
8743
8855
  #
8744
8856
  class DBInstanceAutomatedBackup < Struct.new(
@@ -8771,7 +8883,8 @@ module Aws::RDS
8771
8883
  :backup_target,
8772
8884
  :storage_throughput,
8773
8885
  :aws_backup_recovery_point_arn,
8774
- :dedicated_log_volume)
8886
+ :dedicated_log_volume,
8887
+ :multi_tenant)
8775
8888
  SENSITIVE = []
8776
8889
  include Aws::Structure
8777
8890
  end
@@ -8926,8 +9039,8 @@ module Aws::RDS
8926
9039
  # @return [String]
8927
9040
  #
8928
9041
  # @!attribute [rw] normal
8929
- # A Boolean value that is true if the instance is operating normally,
8930
- # or false if the instance is in an error state.
9042
+ # Indicates whether the instance is operating normally (TRUE) or is in
9043
+ # an error state (FALSE).
8931
9044
  # @return [Boolean]
8932
9045
  #
8933
9046
  # @!attribute [rw] status
@@ -9804,6 +9917,12 @@ module Aws::RDS
9804
9917
  # enabled.
9805
9918
  # @return [Boolean]
9806
9919
  #
9920
+ # @!attribute [rw] multi_tenant
9921
+ # Indicates whether the snapshot is of a DB instance using the
9922
+ # multi-tenant configuration (TRUE) or the single-tenant configuration
9923
+ # (FALSE).
9924
+ # @return [Boolean]
9925
+ #
9807
9926
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshot AWS API Documentation
9808
9927
  #
9809
9928
  class DBSnapshot < Struct.new(
@@ -9841,7 +9960,8 @@ module Aws::RDS
9841
9960
  :snapshot_target,
9842
9961
  :storage_throughput,
9843
9962
  :db_system_id,
9844
- :dedicated_log_volume)
9963
+ :dedicated_log_volume,
9964
+ :multi_tenant)
9845
9965
  SENSITIVE = []
9846
9966
  include Aws::Structure
9847
9967
  end
@@ -9939,6 +10059,114 @@ module Aws::RDS
9939
10059
  #
9940
10060
  class DBSnapshotNotFoundFault < Aws::EmptyStructure; end
9941
10061
 
10062
+ # Contains the details of a tenant database in a snapshot of a DB
10063
+ # instance.
10064
+ #
10065
+ # @!attribute [rw] db_snapshot_identifier
10066
+ # The identifier for the snapshot of the DB instance.
10067
+ # @return [String]
10068
+ #
10069
+ # @!attribute [rw] db_instance_identifier
10070
+ # The ID for the DB instance that contains the tenant databases.
10071
+ # @return [String]
10072
+ #
10073
+ # @!attribute [rw] dbi_resource_id
10074
+ # The resource identifier of the source CDB instance. This identifier
10075
+ # can't be changed and is unique to an Amazon Web Services Region.
10076
+ # @return [String]
10077
+ #
10078
+ # @!attribute [rw] engine_name
10079
+ # The name of the database engine.
10080
+ # @return [String]
10081
+ #
10082
+ # @!attribute [rw] snapshot_type
10083
+ # The type of DB snapshot.
10084
+ # @return [String]
10085
+ #
10086
+ # @!attribute [rw] tenant_database_create_time
10087
+ # The time the DB snapshot was taken, specified in Coordinated
10088
+ # Universal Time (UTC). If you copy the snapshot, the creation time
10089
+ # changes.
10090
+ # @return [Time]
10091
+ #
10092
+ # @!attribute [rw] tenant_db_name
10093
+ # The name of the tenant database.
10094
+ # @return [String]
10095
+ #
10096
+ # @!attribute [rw] master_username
10097
+ # The master username of the tenant database.
10098
+ # @return [String]
10099
+ #
10100
+ # @!attribute [rw] tenant_database_resource_id
10101
+ # The resource ID of the tenant database.
10102
+ # @return [String]
10103
+ #
10104
+ # @!attribute [rw] character_set_name
10105
+ # The name of the character set of a tenant database.
10106
+ # @return [String]
10107
+ #
10108
+ # @!attribute [rw] db_snapshot_tenant_database_arn
10109
+ # The Amazon Resource Name (ARN) for the snapshot tenant database.
10110
+ # @return [String]
10111
+ #
10112
+ # @!attribute [rw] nchar_character_set_name
10113
+ # The `NCHAR` character set name of the tenant database.
10114
+ # @return [String]
10115
+ #
10116
+ # @!attribute [rw] tag_list
10117
+ # A list of tags. For more information, see [Tagging Amazon RDS
10118
+ # Resources][1] in the *Amazon RDS User Guide.*
10119
+ #
10120
+ #
10121
+ #
10122
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
10123
+ # @return [Array<Types::Tag>]
10124
+ #
10125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshotTenantDatabase AWS API Documentation
10126
+ #
10127
+ class DBSnapshotTenantDatabase < Struct.new(
10128
+ :db_snapshot_identifier,
10129
+ :db_instance_identifier,
10130
+ :dbi_resource_id,
10131
+ :engine_name,
10132
+ :snapshot_type,
10133
+ :tenant_database_create_time,
10134
+ :tenant_db_name,
10135
+ :master_username,
10136
+ :tenant_database_resource_id,
10137
+ :character_set_name,
10138
+ :db_snapshot_tenant_database_arn,
10139
+ :nchar_character_set_name,
10140
+ :tag_list)
10141
+ SENSITIVE = []
10142
+ include Aws::Structure
10143
+ end
10144
+
10145
+ # The specified snapshot tenant database wasn't found.
10146
+ #
10147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshotTenantDatabaseNotFoundFault AWS API Documentation
10148
+ #
10149
+ class DBSnapshotTenantDatabaseNotFoundFault < Aws::EmptyStructure; end
10150
+
10151
+ # @!attribute [rw] marker
10152
+ # An optional pagination token provided by a previous request. If this
10153
+ # parameter is specified, the response includes only records beyond
10154
+ # the marker, up to the value specified by `MaxRecords`.
10155
+ # @return [String]
10156
+ #
10157
+ # @!attribute [rw] db_snapshot_tenant_databases
10158
+ # A list of DB snapshot tenant databases.
10159
+ # @return [Array<Types::DBSnapshotTenantDatabase>]
10160
+ #
10161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBSnapshotTenantDatabasesMessage AWS API Documentation
10162
+ #
10163
+ class DBSnapshotTenantDatabasesMessage < Struct.new(
10164
+ :marker,
10165
+ :db_snapshot_tenant_databases)
10166
+ SENSITIVE = []
10167
+ include Aws::Structure
10168
+ end
10169
+
9942
10170
  # Contains the details of an Amazon RDS DB subnet group.
9943
10171
  #
9944
10172
  # This data type is used as a response element in the
@@ -10691,6 +10919,61 @@ module Aws::RDS
10691
10919
  include Aws::Structure
10692
10920
  end
10693
10921
 
10922
+ # @!attribute [rw] db_instance_identifier
10923
+ # The user-supplied identifier for the DB instance that contains the
10924
+ # tenant database that you want to delete.
10925
+ # @return [String]
10926
+ #
10927
+ # @!attribute [rw] tenant_db_name
10928
+ # The user-supplied name of the tenant database that you want to
10929
+ # remove from your DB instance. Amazon RDS deletes the tenant database
10930
+ # with this name. This parameter isn’t case-sensitive.
10931
+ # @return [String]
10932
+ #
10933
+ # @!attribute [rw] skip_final_snapshot
10934
+ # Specifies whether to skip the creation of a final DB snapshot before
10935
+ # removing the tenant database from your DB instance. If you enable
10936
+ # this parameter, RDS doesn't create a DB snapshot. If you don't
10937
+ # enable this parameter, RDS creates a DB snapshot before it deletes
10938
+ # the tenant database. By default, RDS doesn't skip the final
10939
+ # snapshot. If you don't enable this parameter, you must specify the
10940
+ # `FinalDBSnapshotIdentifier` parameter.
10941
+ # @return [Boolean]
10942
+ #
10943
+ # @!attribute [rw] final_db_snapshot_identifier
10944
+ # The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
10945
+ # `SkipFinalSnapshot` parameter is disabled.
10946
+ #
10947
+ # <note markdown="1"> If you enable this parameter and also enable `SkipFinalShapshot`,
10948
+ # the command results in an error.
10949
+ #
10950
+ # </note>
10951
+ # @return [String]
10952
+ #
10953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteTenantDatabaseMessage AWS API Documentation
10954
+ #
10955
+ class DeleteTenantDatabaseMessage < Struct.new(
10956
+ :db_instance_identifier,
10957
+ :tenant_db_name,
10958
+ :skip_final_snapshot,
10959
+ :final_db_snapshot_identifier)
10960
+ SENSITIVE = []
10961
+ include Aws::Structure
10962
+ end
10963
+
10964
+ # @!attribute [rw] tenant_database
10965
+ # A tenant database in the DB instance. This data type is an element
10966
+ # in the response to the `DescribeTenantDatabases` action.
10967
+ # @return [Types::TenantDatabase]
10968
+ #
10969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteTenantDatabaseResult AWS API Documentation
10970
+ #
10971
+ class DeleteTenantDatabaseResult < Struct.new(
10972
+ :tenant_database)
10973
+ SENSITIVE = []
10974
+ include Aws::Structure
10975
+ end
10976
+
10694
10977
  # @!attribute [rw] db_proxy_name
10695
10978
  # The identifier of the `DBProxy` that is associated with the
10696
10979
  # `DBProxyTargetGroup`.
@@ -12217,6 +12500,108 @@ module Aws::RDS
12217
12500
  include Aws::Structure
12218
12501
  end
12219
12502
 
12503
+ # @!attribute [rw] db_instance_identifier
12504
+ # The ID of the DB instance used to create the DB snapshots. This
12505
+ # parameter isn't case-sensitive.
12506
+ #
12507
+ # Constraints:
12508
+ #
12509
+ # * If supplied, must match the identifier of an existing
12510
+ # `DBInstance`.
12511
+ #
12512
+ # ^
12513
+ # @return [String]
12514
+ #
12515
+ # @!attribute [rw] db_snapshot_identifier
12516
+ # The ID of a DB snapshot that contains the tenant databases to
12517
+ # describe. This value is stored as a lowercase string.
12518
+ #
12519
+ # Constraints:
12520
+ #
12521
+ # * If you specify this parameter, the value must match the ID of an
12522
+ # existing DB snapshot.
12523
+ #
12524
+ # * If you specify an automatic snapshot, you must also specify
12525
+ # `SnapshotType`.
12526
+ # @return [String]
12527
+ #
12528
+ # @!attribute [rw] snapshot_type
12529
+ # The type of DB snapshots to be returned. You can specify one of the
12530
+ # following values:
12531
+ #
12532
+ # * `automated` – All DB snapshots that have been automatically taken
12533
+ # by Amazon RDS for my Amazon Web Services account.
12534
+ #
12535
+ # * `manual` – All DB snapshots that have been taken by my Amazon Web
12536
+ # Services account.
12537
+ #
12538
+ # * `shared` – All manual DB snapshots that have been shared to my
12539
+ # Amazon Web Services account.
12540
+ #
12541
+ # * `public` – All DB snapshots that have been marked as public.
12542
+ #
12543
+ # * `awsbackup` – All DB snapshots managed by the Amazon Web Services
12544
+ # Backup service.
12545
+ # @return [String]
12546
+ #
12547
+ # @!attribute [rw] filters
12548
+ # A filter that specifies one or more tenant databases to describe.
12549
+ #
12550
+ # Supported filters:
12551
+ #
12552
+ # * `tenant-db-name` - Tenant database names. The results list only
12553
+ # includes information about the tenant databases that match these
12554
+ # tenant DB names.
12555
+ #
12556
+ # * `tenant-database-resource-id` - Tenant database resource
12557
+ # identifiers. The results list only includes information about the
12558
+ # tenant databases contained within the DB snapshots.
12559
+ #
12560
+ # * `dbi-resource-id` - DB instance resource identifiers. The results
12561
+ # list only includes information about snapshots containing tenant
12562
+ # databases contained within the DB instances identified by these
12563
+ # resource identifiers.
12564
+ #
12565
+ # * `db-instance-id` - Accepts DB instance identifiers and DB instance
12566
+ # Amazon Resource Names (ARNs).
12567
+ #
12568
+ # * `db-snapshot-id` - Accepts DB snapshot identifiers.
12569
+ #
12570
+ # * `snapshot-type` - Accepts types of DB snapshots.
12571
+ # @return [Array<Types::Filter>]
12572
+ #
12573
+ # @!attribute [rw] max_records
12574
+ # The maximum number of records to include in the response. If more
12575
+ # records exist than the specified `MaxRecords` value, a pagination
12576
+ # token called a marker is included in the response so that you can
12577
+ # retrieve the remaining results.
12578
+ # @return [Integer]
12579
+ #
12580
+ # @!attribute [rw] marker
12581
+ # An optional pagination token provided by a previous
12582
+ # `DescribeDBSnapshotTenantDatabases` request. If this parameter is
12583
+ # specified, the response includes only records beyond the marker, up
12584
+ # to the value specified by `MaxRecords`.
12585
+ # @return [String]
12586
+ #
12587
+ # @!attribute [rw] dbi_resource_id
12588
+ # A specific DB resource identifier to describe.
12589
+ # @return [String]
12590
+ #
12591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshotTenantDatabasesMessage AWS API Documentation
12592
+ #
12593
+ class DescribeDBSnapshotTenantDatabasesMessage < Struct.new(
12594
+ :db_instance_identifier,
12595
+ :db_snapshot_identifier,
12596
+ :snapshot_type,
12597
+ :filters,
12598
+ :max_records,
12599
+ :marker,
12600
+ :dbi_resource_id)
12601
+ SENSITIVE = []
12602
+ include Aws::Structure
12603
+ end
12604
+
12220
12605
  # @!attribute [rw] db_instance_identifier
12221
12606
  # The ID of the DB instance to retrieve the list of DB snapshots for.
12222
12607
  # This parameter isn't case-sensitive.
@@ -13455,6 +13840,62 @@ module Aws::RDS
13455
13840
  include Aws::Structure
13456
13841
  end
13457
13842
 
13843
+ # @!attribute [rw] db_instance_identifier
13844
+ # The user-supplied DB instance identifier, which must match the
13845
+ # identifier of an existing instance owned by the Amazon Web Services
13846
+ # account. This parameter isn't case-sensitive.
13847
+ # @return [String]
13848
+ #
13849
+ # @!attribute [rw] tenant_db_name
13850
+ # The user-supplied tenant database name, which must match the name of
13851
+ # an existing tenant database on the specified DB instance owned by
13852
+ # your Amazon Web Services account. This parameter isn’t
13853
+ # case-sensitive.
13854
+ # @return [String]
13855
+ #
13856
+ # @!attribute [rw] filters
13857
+ # A filter that specifies one or more database tenants to describe.
13858
+ #
13859
+ # Supported filters:
13860
+ #
13861
+ # * `tenant-db-name` - Tenant database names. The results list only
13862
+ # includes information about the tenant databases that match these
13863
+ # tenant DB names.
13864
+ #
13865
+ # * `tenant-database-resource-id` - Tenant database resource
13866
+ # identifiers.
13867
+ #
13868
+ # * `dbi-resource-id` - DB instance resource identifiers. The results
13869
+ # list only includes information about the tenants contained within
13870
+ # the DB instances identified by these resource identifiers.
13871
+ # @return [Array<Types::Filter>]
13872
+ #
13873
+ # @!attribute [rw] marker
13874
+ # An optional pagination token provided by a previous
13875
+ # `DescribeTenantDatabases` request. If this parameter is specified,
13876
+ # the response includes only records beyond the marker, up to the
13877
+ # value specified by `MaxRecords`.
13878
+ # @return [String]
13879
+ #
13880
+ # @!attribute [rw] max_records
13881
+ # The maximum number of records to include in the response. If more
13882
+ # records exist than the specified `MaxRecords` value, a pagination
13883
+ # token called a marker is included in the response so that you can
13884
+ # retrieve the remaining results.
13885
+ # @return [Integer]
13886
+ #
13887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeTenantDatabasesMessage AWS API Documentation
13888
+ #
13889
+ class DescribeTenantDatabasesMessage < Struct.new(
13890
+ :db_instance_identifier,
13891
+ :tenant_db_name,
13892
+ :filters,
13893
+ :marker,
13894
+ :max_records)
13895
+ SENSITIVE = []
13896
+ include Aws::Structure
13897
+ end
13898
+
13458
13899
  # @!attribute [rw] db_instance_identifier
13459
13900
  # The customer identifier or the ARN of your DB instance.
13460
13901
  # @return [String]
@@ -13883,8 +14324,8 @@ module Aws::RDS
13883
14324
  # @return [Array<String>]
13884
14325
  #
13885
14326
  # @!attribute [rw] enabled
13886
- # A Boolean value indicating if the subscription is enabled. True
13887
- # indicates the subscription is enabled.
14327
+ # Specifies whether the subscription is enabled. True indicates the
14328
+ # subscription is enabled.
13888
14329
  # @return [Boolean]
13889
14330
  #
13890
14331
  # @!attribute [rw] event_subscription_arn
@@ -14272,15 +14713,19 @@ module Aws::RDS
14272
14713
  # and the specified secondary DB cluster are being verified before
14273
14714
  # the operation starts.
14274
14715
  #
14275
- # * failing-over – This status covers the range of Aurora internal
14276
- # operations that take place during the switchover or failover
14277
- # process, such as demoting the primary Aurora DB cluster, promoting
14278
- # the secondary Aurora DB cluster, and synchronizing replicas.
14716
+ # * failing-over – Aurora is promoting the chosen secondary Aurora DB
14717
+ # cluster to become the new primary DB cluster to fail over the
14718
+ # global cluster.
14279
14719
  #
14280
14720
  # * cancelling – The request to switch over or fail over the global
14281
14721
  # cluster was cancelled and the primary Aurora DB cluster and the
14282
14722
  # selected secondary Aurora DB cluster are returning to their
14283
14723
  # previous states.
14724
+ #
14725
+ # * switching-over – This status covers the range of Aurora internal
14726
+ # operations that take place during the switchover process, such as
14727
+ # demoting the primary Aurora DB cluster, promoting the secondary
14728
+ # Aurora DB cluster, and synchronizing replicas.
14284
14729
  # @return [String]
14285
14730
  #
14286
14731
  # @!attribute [rw] from_db_cluster_arn
@@ -16201,8 +16646,8 @@ module Aws::RDS
16201
16646
  # engine version at the same time, the currently running engine
16202
16647
  # version must be supported on the specified DB instance class.
16203
16648
  # Otherwise, the operation returns an error. In this case, first run
16204
- # the operation to modify the DB instance class, and then run it
16205
- # again to upgrade the engine version.
16649
+ # the operation to upgrade the engine version, and then run it again
16650
+ # to modify the DB instance class.
16206
16651
  #
16207
16652
  # ^
16208
16653
  #
@@ -16495,8 +16940,8 @@ module Aws::RDS
16495
16940
  # instance class at the same time, the currently running engine
16496
16941
  # version must be supported on the specified DB instance class.
16497
16942
  # Otherwise, the operation returns an error. In this case, first run
16498
- # the operation to modify the DB instance class, and then run it
16499
- # again to upgrade the engine version.
16943
+ # the operation to upgrade the engine version, and then run it again
16944
+ # to modify the DB instance class.
16500
16945
  #
16501
16946
  # ^
16502
16947
  # @return [String]
@@ -17265,6 +17710,24 @@ module Aws::RDS
17265
17710
  # enabled.
17266
17711
  # @return [Boolean]
17267
17712
  #
17713
+ # @!attribute [rw] multi_tenant
17714
+ # Specifies whether the to convert your DB instance from the
17715
+ # single-tenant configuration to the multi-tenant configuration. This
17716
+ # parameter is supported only for RDS for Oracle CDB instances.
17717
+ #
17718
+ # During the conversion, RDS creates an initial tenant database and
17719
+ # associates the DB name, master user name, character set, and
17720
+ # national character set metadata with this database. The tags
17721
+ # associated with the instance also propagate to the initial tenant
17722
+ # database. You can add more tenant databases to your DB instance by
17723
+ # using the `CreateTenantDatabase` operation.
17724
+ #
17725
+ # The conversion to the multi-tenant configuration is permanent and
17726
+ # irreversible, so you can't later convert back to the single-tenant
17727
+ # configuration. When you specify this parameter, you must also
17728
+ # specify `ApplyImmediately`.
17729
+ # @return [Boolean]
17730
+ #
17268
17731
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
17269
17732
  #
17270
17733
  class ModifyDBInstanceMessage < Struct.new(
@@ -17326,7 +17789,8 @@ module Aws::RDS
17326
17789
  :rotate_master_user_password,
17327
17790
  :master_user_secret_kms_key_id,
17328
17791
  :engine,
17329
- :dedicated_log_volume)
17792
+ :dedicated_log_volume,
17793
+ :multi_tenant)
17330
17794
  SENSITIVE = []
17331
17795
  include Aws::Structure
17332
17796
  end
@@ -17952,6 +18416,88 @@ module Aws::RDS
17952
18416
  include Aws::Structure
17953
18417
  end
17954
18418
 
18419
+ # @!attribute [rw] db_instance_identifier
18420
+ # The identifier of the DB instance that contains the tenant database
18421
+ # that you are modifying. This parameter isn't case-sensitive.
18422
+ #
18423
+ # Constraints:
18424
+ #
18425
+ # * Must match the identifier of an existing DB instance.
18426
+ #
18427
+ # ^
18428
+ # @return [String]
18429
+ #
18430
+ # @!attribute [rw] tenant_db_name
18431
+ # The user-supplied name of the tenant database that you want to
18432
+ # modify. This parameter isn’t case-sensitive.
18433
+ #
18434
+ # Constraints:
18435
+ #
18436
+ # * Must match the identifier of an existing tenant database.
18437
+ #
18438
+ # ^
18439
+ # @return [String]
18440
+ #
18441
+ # @!attribute [rw] master_user_password
18442
+ # The new password for the master user of the specified tenant
18443
+ # database in your DB instance.
18444
+ #
18445
+ # <note markdown="1"> Amazon RDS operations never return the password, so this action
18446
+ # provides a way to regain access to a tenant database user if the
18447
+ # password is lost. This includes restoring privileges that might have
18448
+ # been accidentally revoked.
18449
+ #
18450
+ # </note>
18451
+ #
18452
+ # Constraints:
18453
+ #
18454
+ # * Can include any printable ASCII character except `/`, `"` (double
18455
+ # quote), `@`, `&` (ampersand), and `'` (single quote).
18456
+ #
18457
+ # ^
18458
+ #
18459
+ # Length constraints:
18460
+ #
18461
+ # * Must contain between 8 and 30 characters.
18462
+ #
18463
+ # ^
18464
+ # @return [String]
18465
+ #
18466
+ # @!attribute [rw] new_tenant_db_name
18467
+ # The new name of the tenant database when renaming a tenant database.
18468
+ # This parameter isn’t case-sensitive.
18469
+ #
18470
+ # Constraints:
18471
+ #
18472
+ # * Can't be the string null or any other reserved word.
18473
+ #
18474
+ # * Can't be longer than 8 characters.
18475
+ # @return [String]
18476
+ #
18477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyTenantDatabaseMessage AWS API Documentation
18478
+ #
18479
+ class ModifyTenantDatabaseMessage < Struct.new(
18480
+ :db_instance_identifier,
18481
+ :tenant_db_name,
18482
+ :master_user_password,
18483
+ :new_tenant_db_name)
18484
+ SENSITIVE = [:master_user_password]
18485
+ include Aws::Structure
18486
+ end
18487
+
18488
+ # @!attribute [rw] tenant_database
18489
+ # A tenant database in the DB instance. This data type is an element
18490
+ # in the response to the `DescribeTenantDatabases` action.
18491
+ # @return [Types::TenantDatabase]
18492
+ #
18493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyTenantDatabaseResult AWS API Documentation
18494
+ #
18495
+ class ModifyTenantDatabaseResult < Struct.new(
18496
+ :tenant_database)
18497
+ SENSITIVE = []
18498
+ include Aws::Structure
18499
+ end
18500
+
17955
18501
  # The network type is invalid for the DB instance. Valid nework type
17956
18502
  # values are `IPV4` and `DUAL`.
17957
18503
  #
@@ -19011,6 +19557,11 @@ module Aws::RDS
19011
19557
  # enabled.&gt;
19012
19558
  # @return [Boolean]
19013
19559
  #
19560
+ # @!attribute [rw] multi_tenant
19561
+ # Indicates whether the DB instance will change to the multi-tenant
19562
+ # configuration (TRUE) or the single-tenant configuration (FALSE).
19563
+ # @return [Boolean]
19564
+ #
19014
19565
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PendingModifiedValues AWS API Documentation
19015
19566
  #
19016
19567
  class PendingModifiedValues < Struct.new(
@@ -19034,7 +19585,8 @@ module Aws::RDS
19034
19585
  :resume_full_automation_mode_time,
19035
19586
  :storage_throughput,
19036
19587
  :engine,
19037
- :dedicated_log_volume)
19588
+ :dedicated_log_volume,
19589
+ :multi_tenant)
19038
19590
  SENSITIVE = []
19039
19591
  include Aws::Structure
19040
19592
  end
@@ -24671,6 +25223,152 @@ module Aws::RDS
24671
25223
  include Aws::Structure
24672
25224
  end
24673
25225
 
25226
+ # A tenant database in the DB instance. This data type is an element in
25227
+ # the response to the `DescribeTenantDatabases` action.
25228
+ #
25229
+ # @!attribute [rw] tenant_database_create_time
25230
+ # The creation time of the tenant database.
25231
+ # @return [Time]
25232
+ #
25233
+ # @!attribute [rw] db_instance_identifier
25234
+ # The ID of the DB instance that contains the tenant database.
25235
+ # @return [String]
25236
+ #
25237
+ # @!attribute [rw] tenant_db_name
25238
+ # The database name of the tenant database.
25239
+ # @return [String]
25240
+ #
25241
+ # @!attribute [rw] status
25242
+ # The status of the tenant database.
25243
+ # @return [String]
25244
+ #
25245
+ # @!attribute [rw] master_username
25246
+ # The master username of the tenant database.
25247
+ # @return [String]
25248
+ #
25249
+ # @!attribute [rw] dbi_resource_id
25250
+ # The Amazon Web Services Region-unique, immutable identifier for the
25251
+ # DB instance.
25252
+ # @return [String]
25253
+ #
25254
+ # @!attribute [rw] tenant_database_resource_id
25255
+ # The Amazon Web Services Region-unique, immutable identifier for the
25256
+ # tenant database.
25257
+ # @return [String]
25258
+ #
25259
+ # @!attribute [rw] tenant_database_arn
25260
+ # The Amazon Resource Name (ARN) for the tenant database.
25261
+ # @return [String]
25262
+ #
25263
+ # @!attribute [rw] character_set_name
25264
+ # The character set of the tenant database.
25265
+ # @return [String]
25266
+ #
25267
+ # @!attribute [rw] nchar_character_set_name
25268
+ # The `NCHAR` character set name of the tenant database.
25269
+ # @return [String]
25270
+ #
25271
+ # @!attribute [rw] deletion_protection
25272
+ # Specifies whether deletion protection is enabled for the DB
25273
+ # instance.
25274
+ # @return [Boolean]
25275
+ #
25276
+ # @!attribute [rw] pending_modified_values
25277
+ # Information about pending changes for a tenant database.
25278
+ # @return [Types::TenantDatabasePendingModifiedValues]
25279
+ #
25280
+ # @!attribute [rw] tag_list
25281
+ # A list of tags. For more information, see [Tagging Amazon RDS
25282
+ # Resources][1] in the *Amazon RDS User Guide.*
25283
+ #
25284
+ #
25285
+ #
25286
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
25287
+ # @return [Array<Types::Tag>]
25288
+ #
25289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabase AWS API Documentation
25290
+ #
25291
+ class TenantDatabase < Struct.new(
25292
+ :tenant_database_create_time,
25293
+ :db_instance_identifier,
25294
+ :tenant_db_name,
25295
+ :status,
25296
+ :master_username,
25297
+ :dbi_resource_id,
25298
+ :tenant_database_resource_id,
25299
+ :tenant_database_arn,
25300
+ :character_set_name,
25301
+ :nchar_character_set_name,
25302
+ :deletion_protection,
25303
+ :pending_modified_values,
25304
+ :tag_list)
25305
+ SENSITIVE = []
25306
+ include Aws::Structure
25307
+ end
25308
+
25309
+ # You attempted to either create a tenant database that already exists
25310
+ # or modify a tenant database to use the name of an existing tenant
25311
+ # database.
25312
+ #
25313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabaseAlreadyExistsFault AWS API Documentation
25314
+ #
25315
+ class TenantDatabaseAlreadyExistsFault < Aws::EmptyStructure; end
25316
+
25317
+ # The specified tenant database wasn't found in the DB instance.
25318
+ #
25319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabaseNotFoundFault AWS API Documentation
25320
+ #
25321
+ class TenantDatabaseNotFoundFault < Aws::EmptyStructure; end
25322
+
25323
+ # A response element in the `ModifyTenantDatabase` operation that
25324
+ # describes changes that will be applied. Specific changes are
25325
+ # identified by subelements.
25326
+ #
25327
+ # @!attribute [rw] master_user_password
25328
+ # The master password for the tenant database.
25329
+ # @return [String]
25330
+ #
25331
+ # @!attribute [rw] tenant_db_name
25332
+ # The name of the tenant database.
25333
+ # @return [String]
25334
+ #
25335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabasePendingModifiedValues AWS API Documentation
25336
+ #
25337
+ class TenantDatabasePendingModifiedValues < Struct.new(
25338
+ :master_user_password,
25339
+ :tenant_db_name)
25340
+ SENSITIVE = [:master_user_password]
25341
+ include Aws::Structure
25342
+ end
25343
+
25344
+ # You attempted to create more tenant databases than are permitted in
25345
+ # your Amazon Web Services account.
25346
+ #
25347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabaseQuotaExceededFault AWS API Documentation
25348
+ #
25349
+ class TenantDatabaseQuotaExceededFault < Aws::EmptyStructure; end
25350
+
25351
+ # @!attribute [rw] marker
25352
+ # An optional pagination token provided by a previous
25353
+ # `DescribeTenantDatabases` request. If this parameter is specified,
25354
+ # the response includes only records beyond the marker, up to the
25355
+ # value specified by `MaxRecords`.
25356
+ # @return [String]
25357
+ #
25358
+ # @!attribute [rw] tenant_databases
25359
+ # An array of the tenant databases requested by the
25360
+ # `DescribeTenantDatabases` operation.
25361
+ # @return [Array<Types::TenantDatabase>]
25362
+ #
25363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/TenantDatabasesMessage AWS API Documentation
25364
+ #
25365
+ class TenantDatabasesMessage < Struct.new(
25366
+ :marker,
25367
+ :tenant_databases)
25368
+ SENSITIVE = []
25369
+ include Aws::Structure
25370
+ end
25371
+
24674
25372
  # A time zone associated with a `DBInstance` or a `DBSnapshot`. This
24675
25373
  # data type is an element in the response to the `DescribeDBInstances`,
24676
25374
  # the `DescribeDBSnapshots`, and the `DescribeDBEngineVersions` actions.