aws-sdk-rds 1.194.0 → 1.196.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/certificate.rb +2 -1
- data/lib/aws-sdk-rds/client.rb +450 -398
- data/lib/aws-sdk-rds/client_api.rb +1 -0
- data/lib/aws-sdk-rds/db_cluster.rb +44 -43
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +3 -4
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +45 -50
- data/lib/aws-sdk-rds/db_engine.rb +12 -15
- data/lib/aws-sdk-rds/db_engine_version.rb +14 -14
- data/lib/aws-sdk-rds/db_instance.rb +218 -174
- data/lib/aws-sdk-rds/db_parameter_group.rb +3 -3
- data/lib/aws-sdk-rds/db_snapshot.rb +33 -30
- data/lib/aws-sdk-rds/event_subscription.rb +5 -5
- data/lib/aws-sdk-rds/option_group.rb +2 -3
- data/lib/aws-sdk-rds/option_group_option.rb +2 -2
- data/lib/aws-sdk-rds/parameter.rb +2 -2
- data/lib/aws-sdk-rds/reserved_db_instance.rb +1 -1
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +30 -32
- data/lib/aws-sdk-rds/types.rb +630 -573
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -285,7 +285,7 @@ module Aws::RDS
|
|
285
285
|
# @!attribute [rw] apply_action
|
286
286
|
# The pending maintenance action to apply to this resource.
|
287
287
|
#
|
288
|
-
# Valid
|
288
|
+
# Valid Values: `system-update`, `db-upgrade`, `hardware-maintenance`,
|
289
289
|
# `ca-certificate-rotation`
|
290
290
|
# @return [String]
|
291
291
|
#
|
@@ -294,7 +294,7 @@ module Aws::RDS
|
|
294
294
|
# opt-in request. An opt-in request of type `immediate` can't be
|
295
295
|
# undone.
|
296
296
|
#
|
297
|
-
# Valid
|
297
|
+
# Valid Values:
|
298
298
|
#
|
299
299
|
# * `immediate` - Apply the maintenance action immediately.
|
300
300
|
#
|
@@ -500,17 +500,17 @@ module Aws::RDS
|
|
500
500
|
# @return [Time]
|
501
501
|
#
|
502
502
|
# @!attribute [rw] force
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
503
|
+
# Specifies whether to force the DB cluster to backtrack when binary
|
504
|
+
# logging is enabled. Otherwise, an error occurs when binary logging
|
505
|
+
# is enabled.
|
506
506
|
# @return [Boolean]
|
507
507
|
#
|
508
508
|
# @!attribute [rw] use_earliest_time_on_point_in_time_unavailable
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
509
|
+
# Specifies whether to backtrack the DB cluster to the earliest
|
510
|
+
# possible backtrack time when *BacktrackTo* is set to a timestamp
|
511
|
+
# earlier than the earliest backtrack time. When this parameter is
|
512
|
+
# disabled and *BacktrackTo* is set to a timestamp earlier than the
|
513
|
+
# earliest backtrack time, an error occurs.
|
514
514
|
# @return [Boolean]
|
515
515
|
#
|
516
516
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/BacktrackDBClusterMessage AWS API Documentation
|
@@ -739,7 +739,8 @@ module Aws::RDS
|
|
739
739
|
# @return [String]
|
740
740
|
#
|
741
741
|
# @!attribute [rw] customer_override
|
742
|
-
#
|
742
|
+
# Indicates whether there is an override for the default certificate
|
743
|
+
# identifier.
|
743
744
|
# @return [Boolean]
|
744
745
|
#
|
745
746
|
# @!attribute [rw] customer_override_valid_till
|
@@ -794,6 +795,14 @@ module Aws::RDS
|
|
794
795
|
|
795
796
|
# Data returned by the **DescribeCertificates** action.
|
796
797
|
#
|
798
|
+
# @!attribute [rw] default_certificate_for_new_launches
|
799
|
+
# The default root CA for new databases created by your Amazon Web
|
800
|
+
# Services account. This is either the root CA override set on your
|
801
|
+
# Amazon Web Services account or the system default CA for the Region
|
802
|
+
# if no override exists. To override the default CA, use the
|
803
|
+
# `ModifyCertificates` operation.
|
804
|
+
# @return [String]
|
805
|
+
#
|
797
806
|
# @!attribute [rw] certificates
|
798
807
|
# The list of `Certificate` objects for the Amazon Web Services
|
799
808
|
# account.
|
@@ -809,6 +818,7 @@ module Aws::RDS
|
|
809
818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CertificateMessage AWS API Documentation
|
810
819
|
#
|
811
820
|
class CertificateMessage < Struct.new(
|
821
|
+
:default_certificate_for_new_launches,
|
812
822
|
:certificates,
|
813
823
|
:marker)
|
814
824
|
SENSITIVE = []
|
@@ -897,9 +907,8 @@ module Aws::RDS
|
|
897
907
|
# @return [String]
|
898
908
|
#
|
899
909
|
# @!attribute [rw] iam_database_authentication_enabled
|
900
|
-
#
|
901
|
-
#
|
902
|
-
# is enabled.
|
910
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
911
|
+
# Management (IAM) accounts to database accounts is enabled.
|
903
912
|
# @return [Boolean]
|
904
913
|
#
|
905
914
|
# @!attribute [rw] engine_version
|
@@ -954,20 +963,24 @@ module Aws::RDS
|
|
954
963
|
# If you specify `MaxIdleConnectionsPercent`, then you must also
|
955
964
|
# include a value for this parameter.
|
956
965
|
#
|
957
|
-
# Default: 10 for RDS for Microsoft SQL Server, and 100 for all
|
958
|
-
# engines
|
966
|
+
# Default: `10` for RDS for Microsoft SQL Server, and `100` for all
|
967
|
+
# other engines
|
968
|
+
#
|
969
|
+
# Constraints:
|
970
|
+
#
|
971
|
+
# * Must be between 1 and 100.
|
959
972
|
#
|
960
|
-
#
|
973
|
+
# ^
|
961
974
|
# @return [Integer]
|
962
975
|
#
|
963
976
|
# @!attribute [rw] max_idle_connections_percent
|
964
|
-
#
|
965
|
-
# the connection pool. The value is expressed as a
|
966
|
-
# `max_connections` setting for the RDS DB instance
|
967
|
-
# cluster used by the target group. With a high value,
|
968
|
-
# leaves a high percentage of idle database connections
|
969
|
-
# value causes the proxy to close more idle connections
|
970
|
-
# them to the database.
|
977
|
+
# A value that controls how actively the proxy closes idle database
|
978
|
+
# connections in the connection pool. The value is expressed as a
|
979
|
+
# percentage of the `max_connections` setting for the RDS DB instance
|
980
|
+
# or Aurora DB cluster used by the target group. With a high value,
|
981
|
+
# the proxy leaves a high percentage of idle database connections
|
982
|
+
# open. A low value causes the proxy to close more idle connections
|
983
|
+
# and return them to the database.
|
971
984
|
#
|
972
985
|
# If you specify this parameter, then you must also include a value
|
973
986
|
# for `MaxConnectionsPercent`.
|
@@ -976,22 +989,30 @@ module Aws::RDS
|
|
976
989
|
# `MaxConnectionsPercent`. For example, if `MaxConnectionsPercent` is
|
977
990
|
# 80, then the default value of `MaxIdleConnectionsPercent` is 40. If
|
978
991
|
# the value of `MaxConnectionsPercent` isn't specified, then for SQL
|
979
|
-
# Server, `MaxIdleConnectionsPercent` is 5
|
980
|
-
# the default is 50
|
992
|
+
# Server, `MaxIdleConnectionsPercent` is `5`, and for all other
|
993
|
+
# engines, the default is `50`.
|
981
994
|
#
|
982
|
-
# Constraints:
|
983
|
-
#
|
995
|
+
# Constraints:
|
996
|
+
#
|
997
|
+
# * Must be between 0 and the value of `MaxConnectionsPercent`.
|
998
|
+
#
|
999
|
+
# ^
|
984
1000
|
# @return [Integer]
|
985
1001
|
#
|
986
1002
|
# @!attribute [rw] connection_borrow_timeout
|
987
1003
|
# The number of seconds for a proxy to wait for a connection to become
|
988
|
-
# available in the connection pool.
|
989
|
-
# opened its maximum number of connections and all
|
990
|
-
# busy with client sessions.
|
1004
|
+
# available in the connection pool. This setting only applies when the
|
1005
|
+
# proxy has opened its maximum number of connections and all
|
1006
|
+
# connections are busy with client sessions. For an unlimited wait
|
1007
|
+
# time, specify `0`.
|
1008
|
+
#
|
1009
|
+
# Default: `120`
|
1010
|
+
#
|
1011
|
+
# Constraints:
|
991
1012
|
#
|
992
|
-
#
|
1013
|
+
# * Must be between 0 and 3600.
|
993
1014
|
#
|
994
|
-
#
|
1015
|
+
# ^
|
995
1016
|
# @return [Integer]
|
996
1017
|
#
|
997
1018
|
# @!attribute [rw] session_pinning_filters
|
@@ -1286,9 +1307,9 @@ module Aws::RDS
|
|
1286
1307
|
# @return [String]
|
1287
1308
|
#
|
1288
1309
|
# @!attribute [rw] copy_tags
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1310
|
+
# Specifies whether to copy all tags from the source DB cluster
|
1311
|
+
# snapshot to the target DB cluster snapshot. By default, tags are not
|
1312
|
+
# copied.
|
1292
1313
|
# @return [Boolean]
|
1293
1314
|
#
|
1294
1315
|
# @!attribute [rw] tags
|
@@ -1487,8 +1508,8 @@ module Aws::RDS
|
|
1487
1508
|
# @return [Array<Types::Tag>]
|
1488
1509
|
#
|
1489
1510
|
# @!attribute [rw] copy_tags
|
1490
|
-
#
|
1491
|
-
#
|
1511
|
+
# Specifies whether to copy all tags from the source DB snapshot to
|
1512
|
+
# the target DB snapshot. By default, tags aren't copied.
|
1492
1513
|
# @return [Boolean]
|
1493
1514
|
#
|
1494
1515
|
# @!attribute [rw] pre_signed_url
|
@@ -1585,11 +1606,10 @@ module Aws::RDS
|
|
1585
1606
|
# @return [String]
|
1586
1607
|
#
|
1587
1608
|
# @!attribute [rw] copy_option_group
|
1588
|
-
#
|
1589
|
-
#
|
1590
|
-
#
|
1591
|
-
#
|
1592
|
-
# snapshot copy calls.
|
1609
|
+
# Specifies whether to copy the DB option group associated with the
|
1610
|
+
# source DB snapshot to the target Amazon Web Services account and
|
1611
|
+
# associate with the target DB snapshot. The associated option group
|
1612
|
+
# can be copied only with cross-account snapshot copy calls.
|
1593
1613
|
# @return [Boolean]
|
1594
1614
|
#
|
1595
1615
|
# @!attribute [rw] source_region
|
@@ -3391,7 +3411,8 @@ module Aws::RDS
|
|
3391
3411
|
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
3392
3412
|
#
|
3393
3413
|
# * Can include any printable ASCII character except "/", """, or
|
3394
|
-
# "@".
|
3414
|
+
# "@". For RDS for Oracle, can't include the "&"
|
3415
|
+
# (ampersand) or the "'" (single quotes) character.
|
3395
3416
|
#
|
3396
3417
|
# Length Constraints:
|
3397
3418
|
#
|
@@ -4428,7 +4449,7 @@ module Aws::RDS
|
|
4428
4449
|
# of DB instance classes, and availability for your engine, see [DB
|
4429
4450
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
4430
4451
|
#
|
4431
|
-
# Default: Inherits from the source DB instance.
|
4452
|
+
# Default: Inherits the value from the source DB instance.
|
4432
4453
|
#
|
4433
4454
|
#
|
4434
4455
|
#
|
@@ -4447,14 +4468,13 @@ module Aws::RDS
|
|
4447
4468
|
# @!attribute [rw] port
|
4448
4469
|
# The port number that the DB instance uses for connections.
|
4449
4470
|
#
|
4450
|
-
# Default: Inherits from the source DB instance
|
4451
|
-
#
|
4452
4471
|
# Valid Values: `1150-65535`
|
4472
|
+
#
|
4473
|
+
# Default: Inherits the value from the source DB instance.
|
4453
4474
|
# @return [Integer]
|
4454
4475
|
#
|
4455
4476
|
# @!attribute [rw] multi_az
|
4456
|
-
#
|
4457
|
-
# deployment.
|
4477
|
+
# Specifies whether the read replica is in a Multi-AZ deployment.
|
4458
4478
|
#
|
4459
4479
|
# You can create a read replica as a Multi-AZ DB instance. RDS creates
|
4460
4480
|
# a standby of your replica in another Availability Zone for failover
|
@@ -4462,60 +4482,61 @@ module Aws::RDS
|
|
4462
4482
|
# instance is independent of whether the source is a Multi-AZ DB
|
4463
4483
|
# instance or a Multi-AZ DB cluster.
|
4464
4484
|
#
|
4465
|
-
# This setting doesn't apply to RDS Custom.
|
4485
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4466
4486
|
# @return [Boolean]
|
4467
4487
|
#
|
4468
4488
|
# @!attribute [rw] auto_minor_version_upgrade
|
4469
|
-
#
|
4470
|
-
#
|
4489
|
+
# Specifies whether to automatically apply minor engine upgrades to
|
4490
|
+
# the read replica during the maintenance window.
|
4471
4491
|
#
|
4472
|
-
# This setting doesn't apply to RDS Custom.
|
4492
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4473
4493
|
#
|
4474
|
-
# Default: Inherits from the source DB instance
|
4494
|
+
# Default: Inherits the value from the source DB instance.
|
4475
4495
|
# @return [Boolean]
|
4476
4496
|
#
|
4477
4497
|
# @!attribute [rw] iops
|
4478
4498
|
# The amount of Provisioned IOPS (input/output operations per second)
|
4479
|
-
# to
|
4499
|
+
# to initially allocate for the DB instance.
|
4480
4500
|
# @return [Integer]
|
4481
4501
|
#
|
4482
4502
|
# @!attribute [rw] option_group_name
|
4483
|
-
# The option group the DB instance
|
4484
|
-
# option group associated with the source
|
4503
|
+
# The option group to associate the DB instance with. If not
|
4504
|
+
# specified, RDS uses the option group associated with the source DB
|
4505
|
+
# instance or cluster.
|
4485
4506
|
#
|
4486
4507
|
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
4487
4508
|
# source.
|
4488
4509
|
#
|
4489
4510
|
# </note>
|
4490
4511
|
#
|
4491
|
-
# This setting doesn't apply to RDS Custom.
|
4512
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4492
4513
|
# @return [String]
|
4493
4514
|
#
|
4494
4515
|
# @!attribute [rw] db_parameter_group_name
|
4495
4516
|
# The name of the DB parameter group to associate with this DB
|
4496
4517
|
# instance.
|
4497
4518
|
#
|
4498
|
-
# If you
|
4499
|
-
# Amazon RDS uses the `DBParameterGroup` of source DB instance for
|
4500
|
-
# same Region read replica, or the default `DBParameterGroup` for
|
4501
|
-
# specified DB engine for a cross-Region read replica.
|
4519
|
+
# If you don't specify a value for `DBParameterGroupName`, then
|
4520
|
+
# Amazon RDS uses the `DBParameterGroup` of the source DB instance for
|
4521
|
+
# a same Region read replica, or the default `DBParameterGroup` for
|
4522
|
+
# the specified DB engine for a cross-Region read replica.
|
4502
4523
|
#
|
4503
4524
|
# Specifying a parameter group for this operation is only supported
|
4504
|
-
# for MySQL
|
4505
|
-
#
|
4525
|
+
# for MySQL DB instances for cross-Region read replicas and for Oracle
|
4526
|
+
# DB instances. It isn't supported for MySQL DB instances for same
|
4527
|
+
# Region read replicas or for RDS Custom.
|
4506
4528
|
#
|
4507
4529
|
# Constraints:
|
4508
4530
|
#
|
4509
4531
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
4510
4532
|
#
|
4511
|
-
# * First character must be a letter
|
4533
|
+
# * First character must be a letter.
|
4512
4534
|
#
|
4513
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
4535
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
4514
4536
|
# @return [String]
|
4515
4537
|
#
|
4516
4538
|
# @!attribute [rw] publicly_accessible
|
4517
|
-
#
|
4518
|
-
# accessible.
|
4539
|
+
# Specifies whether the DB instance is publicly accessible.
|
4519
4540
|
#
|
4520
4541
|
# When the DB cluster is publicly accessible, its Domain Name System
|
4521
4542
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -4541,20 +4562,20 @@ module Aws::RDS
|
|
4541
4562
|
# @return [Array<Types::Tag>]
|
4542
4563
|
#
|
4543
4564
|
# @!attribute [rw] db_subnet_group_name
|
4544
|
-
#
|
4545
|
-
#
|
4565
|
+
# A DB subnet group for the DB instance. The new DB instance is
|
4566
|
+
# created in the VPC associated with the DB subnet group. If no DB
|
4546
4567
|
# subnet group is specified, then the new DB instance isn't created
|
4547
4568
|
# in a VPC.
|
4548
4569
|
#
|
4549
4570
|
# Constraints:
|
4550
4571
|
#
|
4551
|
-
# * If supplied, must match the name of an existing
|
4572
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
4552
4573
|
#
|
4553
4574
|
# * The specified DB subnet group must be in the same Amazon Web
|
4554
4575
|
# Services Region in which the operation is running.
|
4555
4576
|
#
|
4556
4577
|
# * All read replicas in one Amazon Web Services Region that are
|
4557
|
-
# created from the same source DB instance must either
|
4578
|
+
# created from the same source DB instance must either:
|
4558
4579
|
#
|
4559
4580
|
# * Specify DB subnet groups from the same VPC. All these read
|
4560
4581
|
# replicas are created in the same VPC.
|
@@ -4569,40 +4590,42 @@ module Aws::RDS
|
|
4569
4590
|
# A list of Amazon EC2 VPC security groups to associate with the read
|
4570
4591
|
# replica.
|
4571
4592
|
#
|
4572
|
-
# This setting doesn't apply to RDS Custom.
|
4593
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4573
4594
|
#
|
4574
4595
|
# Default: The default EC2 VPC security group for the DB subnet
|
4575
4596
|
# group's VPC.
|
4576
4597
|
# @return [Array<String>]
|
4577
4598
|
#
|
4578
4599
|
# @!attribute [rw] storage_type
|
4579
|
-
#
|
4580
|
-
#
|
4581
|
-
# Valid values: `gp2 | gp3 | io1 | standard`
|
4600
|
+
# The storage type to associate with the read replica.
|
4582
4601
|
#
|
4583
4602
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
4584
4603
|
# `Iops` parameter.
|
4585
4604
|
#
|
4586
|
-
#
|
4605
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
4606
|
+
#
|
4607
|
+
# Default: `io1` if the `Iops` parameter is specified. Otherwise,
|
4608
|
+
# `gp2`.
|
4587
4609
|
# @return [String]
|
4588
4610
|
#
|
4589
4611
|
# @!attribute [rw] copy_tags_to_snapshot
|
4590
|
-
#
|
4591
|
-
#
|
4592
|
-
# copied.
|
4612
|
+
# Specifies whether to copy all tags from the read replica to
|
4613
|
+
# snapshots of the read replica. By default, tags aren't copied.
|
4593
4614
|
# @return [Boolean]
|
4594
4615
|
#
|
4595
4616
|
# @!attribute [rw] monitoring_interval
|
4596
4617
|
# The interval, in seconds, between points when Enhanced Monitoring
|
4597
|
-
# metrics are collected for the read replica. To disable
|
4598
|
-
# Enhanced Monitoring metrics, specify 0
|
4618
|
+
# metrics are collected for the read replica. To disable collection of
|
4619
|
+
# Enhanced Monitoring metrics, specify `0`. The default is `0`.
|
4599
4620
|
#
|
4600
|
-
# If `MonitoringRoleArn` is specified, then you must
|
4601
|
-
# `MonitoringInterval` to a value other than 0
|
4621
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
4622
|
+
# `MonitoringInterval` to a value other than `0`.
|
4602
4623
|
#
|
4603
|
-
# This setting doesn't apply to RDS Custom.
|
4624
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4604
4625
|
#
|
4605
4626
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
4627
|
+
#
|
4628
|
+
# Default: `0`
|
4606
4629
|
# @return [Integer]
|
4607
4630
|
#
|
4608
4631
|
# @!attribute [rw] monitoring_role_arn
|
@@ -4615,7 +4638,7 @@ module Aws::RDS
|
|
4615
4638
|
# If `MonitoringInterval` is set to a value other than 0, then you
|
4616
4639
|
# must supply a `MonitoringRoleArn` value.
|
4617
4640
|
#
|
4618
|
-
# This setting doesn't apply to RDS Custom.
|
4641
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4619
4642
|
#
|
4620
4643
|
#
|
4621
4644
|
#
|
@@ -4724,7 +4747,7 @@ module Aws::RDS
|
|
4724
4747
|
#
|
4725
4748
|
# </note>
|
4726
4749
|
#
|
4727
|
-
# This setting doesn't apply to RDS Custom.
|
4750
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4728
4751
|
#
|
4729
4752
|
#
|
4730
4753
|
#
|
@@ -4733,15 +4756,15 @@ module Aws::RDS
|
|
4733
4756
|
# @return [String]
|
4734
4757
|
#
|
4735
4758
|
# @!attribute [rw] enable_iam_database_authentication
|
4736
|
-
#
|
4737
|
-
#
|
4738
|
-
#
|
4759
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
4760
|
+
# and Access Management (IAM) accounts to database accounts. By
|
4761
|
+
# default, mapping isn't enabled.
|
4739
4762
|
#
|
4740
4763
|
# For more information about IAM database authentication, see [ IAM
|
4741
4764
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
4742
4765
|
# RDS User Guide*.
|
4743
4766
|
#
|
4744
|
-
# This setting doesn't apply to RDS Custom.
|
4767
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4745
4768
|
#
|
4746
4769
|
#
|
4747
4770
|
#
|
@@ -4749,13 +4772,13 @@ module Aws::RDS
|
|
4749
4772
|
# @return [Boolean]
|
4750
4773
|
#
|
4751
4774
|
# @!attribute [rw] enable_performance_insights
|
4752
|
-
#
|
4753
|
-
#
|
4775
|
+
# Specifies whether to enable Performance Insights for the read
|
4776
|
+
# replica.
|
4754
4777
|
#
|
4755
4778
|
# For more information, see [Using Amazon Performance Insights][1] in
|
4756
4779
|
# the *Amazon RDS User Guide*.
|
4757
4780
|
#
|
4758
|
-
# This setting doesn't apply to RDS Custom.
|
4781
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4759
4782
|
#
|
4760
4783
|
#
|
4761
4784
|
#
|
@@ -4775,33 +4798,28 @@ module Aws::RDS
|
|
4775
4798
|
# account has a different default KMS key for each Amazon Web Services
|
4776
4799
|
# Region.
|
4777
4800
|
#
|
4778
|
-
# This setting doesn't apply to RDS Custom.
|
4801
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4779
4802
|
# @return [String]
|
4780
4803
|
#
|
4781
4804
|
# @!attribute [rw] performance_insights_retention_period
|
4782
|
-
# The number of days to retain Performance Insights data.
|
4783
|
-
# is 7 days. The following values are valid:
|
4784
|
-
#
|
4785
|
-
# * 7
|
4786
|
-
#
|
4787
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
4788
|
-
#
|
4789
|
-
# * 731
|
4805
|
+
# The number of days to retain Performance Insights data.
|
4790
4806
|
#
|
4791
|
-
#
|
4807
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4792
4808
|
#
|
4793
|
-
#
|
4809
|
+
# Valid Values:
|
4794
4810
|
#
|
4795
|
-
# *
|
4811
|
+
# * `7`
|
4796
4812
|
#
|
4797
|
-
# *
|
4813
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
4814
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
|
4815
|
+
# (19 months * 31)
|
4798
4816
|
#
|
4799
|
-
# * 731
|
4817
|
+
# * `731`
|
4800
4818
|
#
|
4801
|
-
#
|
4802
|
-
# value, RDS issues an error.
|
4819
|
+
# Default: `7` days
|
4803
4820
|
#
|
4804
|
-
#
|
4821
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
4822
|
+
# Amazon RDS returns an error.
|
4805
4823
|
# @return [Integer]
|
4806
4824
|
#
|
4807
4825
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -4810,7 +4828,7 @@ module Aws::RDS
|
|
4810
4828
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
4811
4829
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
4812
4830
|
#
|
4813
|
-
# This setting doesn't apply to RDS Custom.
|
4831
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4814
4832
|
#
|
4815
4833
|
#
|
4816
4834
|
#
|
@@ -4821,21 +4839,21 @@ module Aws::RDS
|
|
4821
4839
|
# The number of CPU cores and the number of threads per core for the
|
4822
4840
|
# DB instance class of the DB instance.
|
4823
4841
|
#
|
4824
|
-
# This setting doesn't apply to RDS Custom.
|
4842
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4825
4843
|
# @return [Array<Types::ProcessorFeature>]
|
4826
4844
|
#
|
4827
4845
|
# @!attribute [rw] use_default_processor_features
|
4828
|
-
#
|
4829
|
-
#
|
4846
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
4847
|
+
# default processor features.
|
4830
4848
|
#
|
4831
|
-
# This setting doesn't apply to RDS Custom.
|
4849
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4832
4850
|
# @return [Boolean]
|
4833
4851
|
#
|
4834
4852
|
# @!attribute [rw] deletion_protection
|
4835
|
-
#
|
4836
|
-
#
|
4837
|
-
#
|
4838
|
-
#
|
4853
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
4854
|
+
# The database can't be deleted when deletion protection is enabled.
|
4855
|
+
# By default, deletion protection isn't enabled. For more
|
4856
|
+
# information, see [ Deleting a DB Instance][1].
|
4839
4857
|
#
|
4840
4858
|
#
|
4841
4859
|
#
|
@@ -4850,7 +4868,7 @@ module Aws::RDS
|
|
4850
4868
|
# For more information, see [ Kerberos Authentication][1] in the
|
4851
4869
|
# *Amazon RDS User Guide*.
|
4852
4870
|
#
|
4853
|
-
# This setting doesn't apply to RDS Custom.
|
4871
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4854
4872
|
#
|
4855
4873
|
#
|
4856
4874
|
#
|
@@ -4858,10 +4876,10 @@ module Aws::RDS
|
|
4858
4876
|
# @return [String]
|
4859
4877
|
#
|
4860
4878
|
# @!attribute [rw] domain_iam_role_name
|
4861
|
-
# The name of the IAM role to
|
4879
|
+
# The name of the IAM role to use when making API calls to the
|
4862
4880
|
# Directory Service.
|
4863
4881
|
#
|
4864
|
-
# This setting doesn't apply to RDS Custom.
|
4882
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4865
4883
|
# @return [String]
|
4866
4884
|
#
|
4867
4885
|
# @!attribute [rw] domain_fqdn
|
@@ -4971,7 +4989,7 @@ module Aws::RDS
|
|
4971
4989
|
# For the list of permissions required for the IAM role, see [
|
4972
4990
|
# Configure IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
4973
4991
|
#
|
4974
|
-
# This setting is required for RDS Custom.
|
4992
|
+
# This setting is required for RDS Custom DB instances.
|
4975
4993
|
#
|
4976
4994
|
#
|
4977
4995
|
#
|
@@ -4981,7 +4999,7 @@ module Aws::RDS
|
|
4981
4999
|
# @!attribute [rw] network_type
|
4982
5000
|
# The network type of the DB instance.
|
4983
5001
|
#
|
4984
|
-
# Valid
|
5002
|
+
# Valid Values:
|
4985
5003
|
#
|
4986
5004
|
# * `IPV4`
|
4987
5005
|
#
|
@@ -5002,12 +5020,13 @@ module Aws::RDS
|
|
5002
5020
|
# @!attribute [rw] storage_throughput
|
5003
5021
|
# Specifies the storage throughput value for the read replica.
|
5004
5022
|
#
|
5005
|
-
# This setting doesn't apply to RDS Custom or Amazon Aurora
|
5023
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
5024
|
+
# instances.
|
5006
5025
|
# @return [Integer]
|
5007
5026
|
#
|
5008
5027
|
# @!attribute [rw] enable_customer_owned_ip
|
5009
|
-
#
|
5010
|
-
#
|
5028
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for
|
5029
|
+
# an RDS on Outposts read replica.
|
5011
5030
|
#
|
5012
5031
|
# A *CoIP* provides local or external connectivity to resources in
|
5013
5032
|
# your Outpost subnets through your on-premises network. For some use
|
@@ -5279,10 +5298,10 @@ module Aws::RDS
|
|
5279
5298
|
# @return [Array<String>]
|
5280
5299
|
#
|
5281
5300
|
# @!attribute [rw] target_role
|
5282
|
-
#
|
5283
|
-
# read/write or
|
5284
|
-
# only role that proxies for RDS for
|
5285
|
-
# `READ_WRITE`.
|
5301
|
+
# The role of the DB proxy endpoint. The role determines whether the
|
5302
|
+
# endpoint can be used for read/write or only read operations. The
|
5303
|
+
# default is `READ_WRITE`. The only role that proxies for RDS for
|
5304
|
+
# Microsoft SQL Server support is `READ_WRITE`.
|
5286
5305
|
# @return [String]
|
5287
5306
|
#
|
5288
5307
|
# @!attribute [rw] tags
|
@@ -5358,10 +5377,9 @@ module Aws::RDS
|
|
5358
5377
|
# @return [Array<String>]
|
5359
5378
|
#
|
5360
5379
|
# @!attribute [rw] require_tls
|
5361
|
-
#
|
5362
|
-
#
|
5363
|
-
#
|
5364
|
-
# the proxy.
|
5380
|
+
# Specifies whether Transport Layer Security (TLS) encryption is
|
5381
|
+
# required for connections to the proxy. By enabling this setting, you
|
5382
|
+
# can enforce encrypted TLS connections to the proxy.
|
5365
5383
|
# @return [Boolean]
|
5366
5384
|
#
|
5367
5385
|
# @!attribute [rw] idle_client_timeout
|
@@ -5371,10 +5389,10 @@ module Aws::RDS
|
|
5371
5389
|
# @return [Integer]
|
5372
5390
|
#
|
5373
5391
|
# @!attribute [rw] debug_logging
|
5374
|
-
#
|
5375
|
-
# in its logs. This information helps you to debug issues
|
5376
|
-
# SQL behavior or the performance and scalability of the
|
5377
|
-
# connections. The debug information includes the text of SQL
|
5392
|
+
# Specifies whether the proxy includes detailed information about SQL
|
5393
|
+
# statements in its logs. This information helps you to debug issues
|
5394
|
+
# involving SQL behavior or the performance and scalability of the
|
5395
|
+
# proxy connections. The debug information includes the text of SQL
|
5378
5396
|
# statements that you submit through the proxy. Thus, only enable this
|
5379
5397
|
# setting when needed for debugging, and only when you have security
|
5380
5398
|
# measures in place to safeguard any sensitive information that
|
@@ -5598,7 +5616,7 @@ module Aws::RDS
|
|
5598
5616
|
# set this parameter to `db-instance`. For RDS Proxy events, specify
|
5599
5617
|
# `db-proxy`. If this value isn't specified, all events are returned.
|
5600
5618
|
#
|
5601
|
-
# Valid
|
5619
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group`
|
5602
5620
|
# \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
5603
5621
|
# `db-proxy`
|
5604
5622
|
# @return [String]
|
@@ -5651,9 +5669,9 @@ module Aws::RDS
|
|
5651
5669
|
# @return [Array<String>]
|
5652
5670
|
#
|
5653
5671
|
# @!attribute [rw] enabled
|
5654
|
-
#
|
5655
|
-
#
|
5656
|
-
#
|
5672
|
+
# Specifies whether to activate the subscription. If the event
|
5673
|
+
# notification subscription isn't activated, the subscription is
|
5674
|
+
# created but not active.
|
5657
5675
|
# @return [Boolean]
|
5658
5676
|
#
|
5659
5677
|
# @!attribute [rw] tags
|
@@ -6278,7 +6296,7 @@ module Aws::RDS
|
|
6278
6296
|
# @return [String]
|
6279
6297
|
#
|
6280
6298
|
# @!attribute [rw] global_write_forwarding_requested
|
6281
|
-
#
|
6299
|
+
# Indicates whether write forwarding is enabled for a secondary
|
6282
6300
|
# cluster in an Aurora global database. Because write forwarding takes
|
6283
6301
|
# time to enable, check the value of `GlobalWriteForwardingStatus` to
|
6284
6302
|
# confirm that the request has completed before using the write
|
@@ -6439,7 +6457,7 @@ module Aws::RDS
|
|
6439
6457
|
# @return [Time]
|
6440
6458
|
#
|
6441
6459
|
# @!attribute [rw] local_write_forwarding_status
|
6442
|
-
#
|
6460
|
+
# Indicates whether an Aurora DB cluster has in-cluster write
|
6443
6461
|
# forwarding enabled, not enabled, requested, or is in the process of
|
6444
6462
|
# enabling it.
|
6445
6463
|
# @return [String]
|
@@ -6587,9 +6605,8 @@ module Aws::RDS
|
|
6587
6605
|
# @return [String]
|
6588
6606
|
#
|
6589
6607
|
# @!attribute [rw] iam_database_authentication_enabled
|
6590
|
-
#
|
6591
|
-
# Management (IAM) accounts to database accounts is enabled
|
6592
|
-
# otherwise false.
|
6608
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
6609
|
+
# Management (IAM) accounts to database accounts is enabled.
|
6593
6610
|
# @return [Boolean]
|
6594
6611
|
#
|
6595
6612
|
# @!attribute [rw] cluster_create_time
|
@@ -6598,7 +6615,7 @@ module Aws::RDS
|
|
6598
6615
|
# @return [Time]
|
6599
6616
|
#
|
6600
6617
|
# @!attribute [rw] storage_encrypted
|
6601
|
-
#
|
6618
|
+
# Indicates whether the source DB cluster is encrypted.
|
6602
6619
|
# @return [Boolean]
|
6603
6620
|
#
|
6604
6621
|
# @!attribute [rw] allocated_storage
|
@@ -6979,8 +6996,8 @@ module Aws::RDS
|
|
6979
6996
|
# @return [String]
|
6980
6997
|
#
|
6981
6998
|
# @!attribute [rw] is_cluster_writer
|
6982
|
-
#
|
6983
|
-
#
|
6999
|
+
# Indicates whether the cluster member is the primary DB instance for
|
7000
|
+
# the DB cluster.
|
6984
7001
|
# @return [Boolean]
|
6985
7002
|
#
|
6986
7003
|
# @!attribute [rw] db_cluster_parameter_group_status
|
@@ -7237,41 +7254,40 @@ module Aws::RDS
|
|
7237
7254
|
# `DescribeDBClusterSnapshots` action.
|
7238
7255
|
#
|
7239
7256
|
# @!attribute [rw] availability_zones
|
7240
|
-
#
|
7241
|
-
#
|
7257
|
+
# The list of Availability Zones (AZs) where instances in the DB
|
7258
|
+
# cluster snapshot can be restored.
|
7242
7259
|
# @return [Array<String>]
|
7243
7260
|
#
|
7244
7261
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
7245
|
-
#
|
7262
|
+
# The identifier for the DB cluster snapshot.
|
7246
7263
|
# @return [String]
|
7247
7264
|
#
|
7248
7265
|
# @!attribute [rw] db_cluster_identifier
|
7249
|
-
#
|
7250
|
-
#
|
7266
|
+
# The DB cluster identifier of the DB cluster that this DB cluster
|
7267
|
+
# snapshot was created from.
|
7251
7268
|
# @return [String]
|
7252
7269
|
#
|
7253
7270
|
# @!attribute [rw] snapshot_create_time
|
7254
|
-
#
|
7255
|
-
#
|
7271
|
+
# The time when the snapshot was taken, in Universal Coordinated Time
|
7272
|
+
# (UTC).
|
7256
7273
|
# @return [Time]
|
7257
7274
|
#
|
7258
7275
|
# @!attribute [rw] engine
|
7259
|
-
#
|
7260
|
-
# snapshot.
|
7276
|
+
# The name of the database engine for this DB cluster snapshot.
|
7261
7277
|
# @return [String]
|
7262
7278
|
#
|
7263
7279
|
# @!attribute [rw] engine_mode
|
7264
|
-
#
|
7265
|
-
# snapshot.
|
7280
|
+
# The engine mode of the database engine for this DB cluster snapshot.
|
7266
7281
|
# @return [String]
|
7267
7282
|
#
|
7268
7283
|
# @!attribute [rw] allocated_storage
|
7269
|
-
#
|
7284
|
+
# The allocated storage size of the DB cluster snapshot in gibibytes
|
7285
|
+
# (GiB).
|
7270
7286
|
# @return [Integer]
|
7271
7287
|
#
|
7272
7288
|
# @!attribute [rw] status
|
7273
|
-
#
|
7274
|
-
#
|
7289
|
+
# The status of this DB cluster snapshot. Valid statuses are the
|
7290
|
+
# following:
|
7275
7291
|
#
|
7276
7292
|
# * `available`
|
7277
7293
|
#
|
@@ -7281,43 +7297,41 @@ module Aws::RDS
|
|
7281
7297
|
# @return [String]
|
7282
7298
|
#
|
7283
7299
|
# @!attribute [rw] port
|
7284
|
-
#
|
7285
|
-
#
|
7300
|
+
# The port that the DB cluster was listening on at the time of the
|
7301
|
+
# snapshot.
|
7286
7302
|
# @return [Integer]
|
7287
7303
|
#
|
7288
7304
|
# @!attribute [rw] vpc_id
|
7289
|
-
#
|
7305
|
+
# The VPC ID associated with the DB cluster snapshot.
|
7290
7306
|
# @return [String]
|
7291
7307
|
#
|
7292
7308
|
# @!attribute [rw] cluster_create_time
|
7293
|
-
#
|
7294
|
-
#
|
7309
|
+
# The time when the DB cluster was created, in Universal Coordinated
|
7310
|
+
# Time (UTC).
|
7295
7311
|
# @return [Time]
|
7296
7312
|
#
|
7297
7313
|
# @!attribute [rw] master_username
|
7298
|
-
#
|
7314
|
+
# The master username for this DB cluster snapshot.
|
7299
7315
|
# @return [String]
|
7300
7316
|
#
|
7301
7317
|
# @!attribute [rw] engine_version
|
7302
|
-
#
|
7303
|
-
# snapshot.
|
7318
|
+
# The version of the database engine for this DB cluster snapshot.
|
7304
7319
|
# @return [String]
|
7305
7320
|
#
|
7306
7321
|
# @!attribute [rw] license_model
|
7307
|
-
#
|
7322
|
+
# The license model information for this DB cluster snapshot.
|
7308
7323
|
# @return [String]
|
7309
7324
|
#
|
7310
7325
|
# @!attribute [rw] snapshot_type
|
7311
|
-
#
|
7326
|
+
# The type of the DB cluster snapshot.
|
7312
7327
|
# @return [String]
|
7313
7328
|
#
|
7314
7329
|
# @!attribute [rw] percent_progress
|
7315
|
-
#
|
7316
|
-
# transferred.
|
7330
|
+
# The percentage of the estimated data that has been transferred.
|
7317
7331
|
# @return [Integer]
|
7318
7332
|
#
|
7319
7333
|
# @!attribute [rw] storage_encrypted
|
7320
|
-
#
|
7334
|
+
# Indicates whether the DB cluster snapshot is encrypted.
|
7321
7335
|
# @return [Boolean]
|
7322
7336
|
#
|
7323
7337
|
# @!attribute [rw] kms_key_id
|
@@ -7329,8 +7343,7 @@ module Aws::RDS
|
|
7329
7343
|
# @return [String]
|
7330
7344
|
#
|
7331
7345
|
# @!attribute [rw] db_cluster_snapshot_arn
|
7332
|
-
#
|
7333
|
-
# snapshot.
|
7346
|
+
# The Amazon Resource Name (ARN) for the DB cluster snapshot.
|
7334
7347
|
# @return [String]
|
7335
7348
|
#
|
7336
7349
|
# @!attribute [rw] source_db_cluster_snapshot_arn
|
@@ -7340,9 +7353,8 @@ module Aws::RDS
|
|
7340
7353
|
# @return [String]
|
7341
7354
|
#
|
7342
7355
|
# @!attribute [rw] iam_database_authentication_enabled
|
7343
|
-
#
|
7344
|
-
# Management (IAM) accounts to database accounts is enabled
|
7345
|
-
# otherwise false.
|
7356
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
7357
|
+
# Management (IAM) accounts to database accounts is enabled.
|
7346
7358
|
# @return [Boolean]
|
7347
7359
|
#
|
7348
7360
|
# @!attribute [rw] tag_list
|
@@ -7365,8 +7377,8 @@ module Aws::RDS
|
|
7365
7377
|
# @return [String]
|
7366
7378
|
#
|
7367
7379
|
# @!attribute [rw] db_cluster_resource_id
|
7368
|
-
#
|
7369
|
-
#
|
7380
|
+
# The resource ID of the DB cluster that this DB cluster snapshot was
|
7381
|
+
# created from.
|
7370
7382
|
# @return [String]
|
7371
7383
|
#
|
7372
7384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBClusterSnapshot AWS API Documentation
|
@@ -7566,8 +7578,8 @@ module Aws::RDS
|
|
7566
7578
|
# @return [Array<String>]
|
7567
7579
|
#
|
7568
7580
|
# @!attribute [rw] supports_log_exports_to_cloudwatch_logs
|
7569
|
-
#
|
7570
|
-
#
|
7581
|
+
# Indicates whether the engine version supports exporting the log
|
7582
|
+
# types specified by ExportableLogTypes to CloudWatch Logs.
|
7571
7583
|
# @return [Boolean]
|
7572
7584
|
#
|
7573
7585
|
# @!attribute [rw] supports_read_replica
|
@@ -7606,13 +7618,13 @@ module Aws::RDS
|
|
7606
7618
|
# @return [String]
|
7607
7619
|
#
|
7608
7620
|
# @!attribute [rw] supports_parallel_query
|
7609
|
-
#
|
7610
|
-
#
|
7621
|
+
# Indicates whether you can use Aurora parallel query with a specific
|
7622
|
+
# DB engine version.
|
7611
7623
|
# @return [Boolean]
|
7612
7624
|
#
|
7613
7625
|
# @!attribute [rw] supports_global_databases
|
7614
|
-
#
|
7615
|
-
#
|
7626
|
+
# Indicates whether you can use Aurora global databases with a
|
7627
|
+
# specific DB engine version.
|
7616
7628
|
# @return [Boolean]
|
7617
7629
|
#
|
7618
7630
|
# @!attribute [rw] major_engine_version
|
@@ -7653,8 +7665,8 @@ module Aws::RDS
|
|
7653
7665
|
# @return [Array<Types::Tag>]
|
7654
7666
|
#
|
7655
7667
|
# @!attribute [rw] supports_babelfish
|
7656
|
-
#
|
7657
|
-
#
|
7668
|
+
# Indicates whether the engine version supports Babelfish for Aurora
|
7669
|
+
# PostgreSQL.
|
7658
7670
|
# @return [Boolean]
|
7659
7671
|
#
|
7660
7672
|
# @!attribute [rw] custom_db_engine_version_manifest
|
@@ -7672,8 +7684,8 @@ module Aws::RDS
|
|
7672
7684
|
# @return [String]
|
7673
7685
|
#
|
7674
7686
|
# @!attribute [rw] supports_certificate_rotation_without_restart
|
7675
|
-
#
|
7676
|
-
#
|
7687
|
+
# Indicates whether the engine version supports rotating the server
|
7688
|
+
# certificate without rebooting the DB instance.
|
7677
7689
|
# @return [Boolean]
|
7678
7690
|
#
|
7679
7691
|
# @!attribute [rw] supported_ca_certificate_identifiers
|
@@ -7691,10 +7703,10 @@ module Aws::RDS
|
|
7691
7703
|
# @return [Array<String>]
|
7692
7704
|
#
|
7693
7705
|
# @!attribute [rw] supports_local_write_forwarding
|
7694
|
-
#
|
7695
|
-
#
|
7696
|
-
# DB
|
7697
|
-
#
|
7706
|
+
# Indicates whether the DB engine version supports forwarding write
|
7707
|
+
# operations from reader DB instances to the writer DB instance in the
|
7708
|
+
# DB cluster. By default, write operations aren't allowed on reader
|
7709
|
+
# DB instances.
|
7698
7710
|
#
|
7699
7711
|
# Valid for: Aurora DB clusters only
|
7700
7712
|
# @return [Boolean]
|
@@ -8458,15 +8470,16 @@ module Aws::RDS
|
|
8458
8470
|
# @return [String]
|
8459
8471
|
#
|
8460
8472
|
# @!attribute [rw] restore_window
|
8461
|
-
#
|
8473
|
+
# The earliest and latest time a DB instance can be restored to.
|
8462
8474
|
# @return [Types::RestoreWindow]
|
8463
8475
|
#
|
8464
8476
|
# @!attribute [rw] allocated_storage
|
8465
|
-
#
|
8477
|
+
# The allocated storage size for the the automated backup in gibibytes
|
8478
|
+
# (GiB).
|
8466
8479
|
# @return [Integer]
|
8467
8480
|
#
|
8468
8481
|
# @!attribute [rw] status
|
8469
|
-
#
|
8482
|
+
# A list of status information for an automated backup:
|
8470
8483
|
#
|
8471
8484
|
# * `active` - Automated backups for current instances.
|
8472
8485
|
#
|
@@ -8495,11 +8508,11 @@ module Aws::RDS
|
|
8495
8508
|
# @return [String]
|
8496
8509
|
#
|
8497
8510
|
# @!attribute [rw] vpc_id
|
8498
|
-
#
|
8511
|
+
# The VPC ID associated with the DB instance.
|
8499
8512
|
# @return [String]
|
8500
8513
|
#
|
8501
8514
|
# @!attribute [rw] instance_create_time
|
8502
|
-
#
|
8515
|
+
# The date and time when the DB instance was created.
|
8503
8516
|
# @return [Time]
|
8504
8517
|
#
|
8505
8518
|
# @!attribute [rw] master_username
|
@@ -8515,7 +8528,7 @@ module Aws::RDS
|
|
8515
8528
|
# @return [String]
|
8516
8529
|
#
|
8517
8530
|
# @!attribute [rw] license_model
|
8518
|
-
#
|
8531
|
+
# The license model information for the automated backup.
|
8519
8532
|
# @return [String]
|
8520
8533
|
#
|
8521
8534
|
# @!attribute [rw] iops
|
@@ -8533,11 +8546,11 @@ module Aws::RDS
|
|
8533
8546
|
# @return [String]
|
8534
8547
|
#
|
8535
8548
|
# @!attribute [rw] encrypted
|
8536
|
-
#
|
8549
|
+
# Indicates whether the automated backup is encrypted.
|
8537
8550
|
# @return [Boolean]
|
8538
8551
|
#
|
8539
8552
|
# @!attribute [rw] storage_type
|
8540
|
-
#
|
8553
|
+
# The storage type associated with the automated backup.
|
8541
8554
|
# @return [String]
|
8542
8555
|
#
|
8543
8556
|
# @!attribute [rw] kms_key_id
|
@@ -8573,12 +8586,12 @@ module Aws::RDS
|
|
8573
8586
|
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
8574
8587
|
#
|
8575
8588
|
# @!attribute [rw] backup_target
|
8576
|
-
#
|
8589
|
+
# The location where automated backups are stored: Amazon Web Services
|
8577
8590
|
# Outposts or the Amazon Web Services Region.
|
8578
8591
|
# @return [String]
|
8579
8592
|
#
|
8580
8593
|
# @!attribute [rw] storage_throughput
|
8581
|
-
#
|
8594
|
+
# The storage throughput for the automated backup.
|
8582
8595
|
# @return [Integer]
|
8583
8596
|
#
|
8584
8597
|
# @!attribute [rw] aws_backup_recovery_point_arn
|
@@ -8702,8 +8715,8 @@ module Aws::RDS
|
|
8702
8715
|
#
|
8703
8716
|
class DBInstanceNotFoundFault < Aws::EmptyStructure; end
|
8704
8717
|
|
8705
|
-
#
|
8706
|
-
# role that is associated with a DB instance.
|
8718
|
+
# Information about an Amazon Web Services Identity and Access
|
8719
|
+
# Management (IAM) role that is associated with a DB instance.
|
8707
8720
|
#
|
8708
8721
|
# @!attribute [rw] role_arn
|
8709
8722
|
# The Amazon Resource Name (ARN) of the IAM role that is associated
|
@@ -8717,8 +8730,9 @@ module Aws::RDS
|
|
8717
8730
|
# @return [String]
|
8718
8731
|
#
|
8719
8732
|
# @!attribute [rw] status
|
8720
|
-
#
|
8721
|
-
# instance. The Status property returns one of the following
|
8733
|
+
# Information about the state of association between the IAM role and
|
8734
|
+
# the DB instance. The Status property returns one of the following
|
8735
|
+
# values:
|
8722
8736
|
#
|
8723
8737
|
# * `ACTIVE` - the IAM role ARN is associated with the DB instance and
|
8724
8738
|
# can be used to access other Amazon Web Services services on your
|
@@ -8771,12 +8785,12 @@ module Aws::RDS
|
|
8771
8785
|
# @return [String]
|
8772
8786
|
#
|
8773
8787
|
# @!attribute [rw] normal
|
8774
|
-
# Boolean value that is true if the instance is operating normally,
|
8775
|
-
# false if the instance is in an error state.
|
8788
|
+
# A Boolean value that is true if the instance is operating normally,
|
8789
|
+
# or false if the instance is in an error state.
|
8776
8790
|
# @return [Boolean]
|
8777
8791
|
#
|
8778
8792
|
# @!attribute [rw] status
|
8779
|
-
#
|
8793
|
+
# The status of the DB instance. For a StatusType of read replica, the
|
8780
8794
|
# values can be replicating, replication stop point set, replication
|
8781
8795
|
# stop point reached, error, stopped, or terminated.
|
8782
8796
|
# @return [String]
|
@@ -9026,10 +9040,10 @@ module Aws::RDS
|
|
9026
9040
|
# @return [Integer]
|
9027
9041
|
#
|
9028
9042
|
# @!attribute [rw] debug_logging
|
9029
|
-
#
|
9030
|
-
# in its logs. This information helps you to debug issues
|
9031
|
-
# SQL behavior or the performance and scalability of the
|
9032
|
-
# connections. The debug information includes the text of SQL
|
9043
|
+
# Indicates whether the proxy includes detailed information about SQL
|
9044
|
+
# statements in its logs. This information helps you to debug issues
|
9045
|
+
# involving SQL behavior or the performance and scalability of the
|
9046
|
+
# proxy connections. The debug information includes the text of SQL
|
9033
9047
|
# statements that you submit through the proxy. Thus, only enable this
|
9034
9048
|
# setting when needed for debugging, and only when you have security
|
9035
9049
|
# measures in place to safeguard any sensitive information that
|
@@ -9134,8 +9148,8 @@ module Aws::RDS
|
|
9134
9148
|
# @return [String]
|
9135
9149
|
#
|
9136
9150
|
# @!attribute [rw] is_default
|
9137
|
-
#
|
9138
|
-
#
|
9151
|
+
# Indicates whether this endpoint is the default endpoint for the
|
9152
|
+
# associated DB proxy. Default DB proxy endpoints always have
|
9139
9153
|
# read/write capability. Other endpoints that you associate with the
|
9140
9154
|
# DB proxy can be either read/write or read-only.
|
9141
9155
|
# @return [Boolean]
|
@@ -9284,10 +9298,10 @@ module Aws::RDS
|
|
9284
9298
|
# @return [String]
|
9285
9299
|
#
|
9286
9300
|
# @!attribute [rw] is_default
|
9287
|
-
#
|
9288
|
-
# requests by the associated proxy. Because each proxy is
|
9289
|
-
# associated with a single target group, currently this
|
9290
|
-
# always `true`.
|
9301
|
+
# Indicates whether this target group is the first one used for
|
9302
|
+
# connection requests by the associated proxy. Because each proxy is
|
9303
|
+
# currently associated with a single target group, currently this
|
9304
|
+
# setting is always `true`.
|
9291
9305
|
# @return [Boolean]
|
9292
9306
|
#
|
9293
9307
|
# @!attribute [rw] status
|
@@ -9564,7 +9578,7 @@ module Aws::RDS
|
|
9564
9578
|
# @return [String]
|
9565
9579
|
#
|
9566
9580
|
# @!attribute [rw] encrypted
|
9567
|
-
#
|
9581
|
+
# Indicates whether the DB snapshot is encrypted.
|
9568
9582
|
# @return [Boolean]
|
9569
9583
|
#
|
9570
9584
|
# @!attribute [rw] kms_key_id
|
@@ -9587,9 +9601,8 @@ module Aws::RDS
|
|
9587
9601
|
# @return [String]
|
9588
9602
|
#
|
9589
9603
|
# @!attribute [rw] iam_database_authentication_enabled
|
9590
|
-
#
|
9591
|
-
# Management (IAM) accounts to database accounts is enabled
|
9592
|
-
# otherwise false.
|
9604
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
9605
|
+
# Management (IAM) accounts to database accounts is enabled.
|
9593
9606
|
# @return [Boolean]
|
9594
9607
|
#
|
9595
9608
|
# @!attribute [rw] processor_features
|
@@ -10036,12 +10049,12 @@ module Aws::RDS
|
|
10036
10049
|
# @return [String]
|
10037
10050
|
#
|
10038
10051
|
# @!attribute [rw] skip_final_snapshot
|
10039
|
-
#
|
10040
|
-
#
|
10041
|
-
#
|
10042
|
-
#
|
10043
|
-
#
|
10044
|
-
#
|
10052
|
+
# Specifies whether to skip the creation of a final DB cluster
|
10053
|
+
# snapshot before the DB cluster is deleted. If skip is specified, no
|
10054
|
+
# DB cluster snapshot is created. If skip isn't specified, a DB
|
10055
|
+
# cluster snapshot is created before the DB cluster is deleted. By
|
10056
|
+
# default, skip isn't specified, and the DB cluster snapshot is
|
10057
|
+
# created. By default, this parameter is disabled.
|
10045
10058
|
#
|
10046
10059
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
10047
10060
|
# `SkipFinalSnapshot` is disabled.
|
@@ -10069,10 +10082,10 @@ module Aws::RDS
|
|
10069
10082
|
# @return [String]
|
10070
10083
|
#
|
10071
10084
|
# @!attribute [rw] delete_automated_backups
|
10072
|
-
#
|
10073
|
-
#
|
10074
|
-
#
|
10075
|
-
#
|
10085
|
+
# Specifies whether to remove automated backups immediately after the
|
10086
|
+
# DB cluster is deleted. This parameter isn't case-sensitive. The
|
10087
|
+
# default is to remove automated backups immediately after the DB
|
10088
|
+
# cluster is deleted.
|
10076
10089
|
# @return [Boolean]
|
10077
10090
|
#
|
10078
10091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBClusterMessage AWS API Documentation
|
@@ -10225,12 +10238,11 @@ module Aws::RDS
|
|
10225
10238
|
# @return [String]
|
10226
10239
|
#
|
10227
10240
|
# @!attribute [rw] skip_final_snapshot
|
10228
|
-
#
|
10229
|
-
#
|
10230
|
-
#
|
10231
|
-
#
|
10232
|
-
#
|
10233
|
-
# created.
|
10241
|
+
# Specifies whether to skip the creation of a final DB snapshot before
|
10242
|
+
# deleting the instance. If you enable this parameter, RDS doesn't
|
10243
|
+
# create a DB snapshot. If you don't enable this parameter, RDS
|
10244
|
+
# creates a DB snapshot before the DB instance is deleted. By default,
|
10245
|
+
# skip isn't enabled, and the DB snapshot is created.
|
10234
10246
|
#
|
10235
10247
|
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
10236
10248
|
# `FinalDBSnapshotIdentifier` parameter.
|
@@ -10270,10 +10282,10 @@ module Aws::RDS
|
|
10270
10282
|
# @return [String]
|
10271
10283
|
#
|
10272
10284
|
# @!attribute [rw] delete_automated_backups
|
10273
|
-
#
|
10274
|
-
#
|
10275
|
-
#
|
10276
|
-
#
|
10285
|
+
# Specifies whether to remove automated backups immediately after the
|
10286
|
+
# DB instance is deleted. This parameter isn't case-sensitive. The
|
10287
|
+
# default is to remove automated backups immediately after the DB
|
10288
|
+
# instance is deleted.
|
10277
10289
|
# @return [Boolean]
|
10278
10290
|
#
|
10279
10291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceMessage AWS API Documentation
|
@@ -10954,8 +10966,15 @@ module Aws::RDS
|
|
10954
10966
|
# @return [String]
|
10955
10967
|
#
|
10956
10968
|
# @!attribute [rw] source
|
10957
|
-
# A
|
10958
|
-
#
|
10969
|
+
# A specific source to return parameters for.
|
10970
|
+
#
|
10971
|
+
# Valid Values:
|
10972
|
+
#
|
10973
|
+
# * `customer`
|
10974
|
+
#
|
10975
|
+
# * `engine`
|
10976
|
+
#
|
10977
|
+
# * `service`
|
10959
10978
|
# @return [String]
|
10960
10979
|
#
|
10961
10980
|
# @!attribute [rw] filters
|
@@ -11118,10 +11137,10 @@ module Aws::RDS
|
|
11118
11137
|
# @return [String]
|
11119
11138
|
#
|
11120
11139
|
# @!attribute [rw] include_shared
|
11121
|
-
#
|
11122
|
-
#
|
11123
|
-
#
|
11124
|
-
#
|
11140
|
+
# Specifies whether to include shared manual DB cluster snapshots from
|
11141
|
+
# other Amazon Web Services accounts that this Amazon Web Services
|
11142
|
+
# account has been given permission to copy or restore. By default,
|
11143
|
+
# these snapshots are not included.
|
11125
11144
|
#
|
11126
11145
|
# You can give an Amazon Web Services account permission to restore a
|
11127
11146
|
# manual DB cluster snapshot from another Amazon Web Services account
|
@@ -11129,10 +11148,9 @@ module Aws::RDS
|
|
11129
11148
|
# @return [Boolean]
|
11130
11149
|
#
|
11131
11150
|
# @!attribute [rw] include_public
|
11132
|
-
#
|
11133
|
-
#
|
11134
|
-
#
|
11135
|
-
# not included.
|
11151
|
+
# Specifies whether to include manual DB cluster snapshots that are
|
11152
|
+
# public and can be copied or restored by any Amazon Web Services
|
11153
|
+
# account. By default, the public snapshots are not included.
|
11136
11154
|
#
|
11137
11155
|
# You can share a manual DB cluster snapshot as public by using the
|
11138
11156
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -11233,7 +11251,7 @@ module Aws::RDS
|
|
11233
11251
|
end
|
11234
11252
|
|
11235
11253
|
# @!attribute [rw] engine
|
11236
|
-
# The database engine to return.
|
11254
|
+
# The database engine to return version details for.
|
11237
11255
|
#
|
11238
11256
|
# Valid Values:
|
11239
11257
|
#
|
@@ -11267,7 +11285,7 @@ module Aws::RDS
|
|
11267
11285
|
# @return [String]
|
11268
11286
|
#
|
11269
11287
|
# @!attribute [rw] engine_version
|
11270
|
-
#
|
11288
|
+
# A specific database engine version to return details for.
|
11271
11289
|
#
|
11272
11290
|
# Example: `5.1.49`
|
11273
11291
|
# @return [String]
|
@@ -11278,7 +11296,7 @@ module Aws::RDS
|
|
11278
11296
|
#
|
11279
11297
|
# Constraints:
|
11280
11298
|
#
|
11281
|
-
# * If supplied, must match an existing
|
11299
|
+
# * If supplied, must match an existing DB parameter group family.
|
11282
11300
|
#
|
11283
11301
|
# ^
|
11284
11302
|
# @return [String]
|
@@ -11340,41 +11358,37 @@ module Aws::RDS
|
|
11340
11358
|
# @return [String]
|
11341
11359
|
#
|
11342
11360
|
# @!attribute [rw] default_only
|
11343
|
-
#
|
11344
|
-
# specified engine or engine and major version combination
|
11345
|
-
# returned.
|
11361
|
+
# Specifies whether to return only the default version of the
|
11362
|
+
# specified engine or the engine and major version combination.
|
11346
11363
|
# @return [Boolean]
|
11347
11364
|
#
|
11348
11365
|
# @!attribute [rw] list_supported_character_sets
|
11349
|
-
#
|
11350
|
-
#
|
11366
|
+
# Specifies whether to list the supported character sets for each
|
11367
|
+
# engine version.
|
11351
11368
|
#
|
11352
11369
|
# If this parameter is enabled and the requested engine supports the
|
11353
11370
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
11354
11371
|
# includes a list of supported character sets for each engine version.
|
11355
11372
|
#
|
11356
11373
|
# For RDS Custom, the default is not to list supported character sets.
|
11357
|
-
# If you
|
11358
|
-
# returns no results.
|
11374
|
+
# If you enable this parameter, RDS Custom returns no results.
|
11359
11375
|
# @return [Boolean]
|
11360
11376
|
#
|
11361
11377
|
# @!attribute [rw] list_supported_timezones
|
11362
|
-
#
|
11363
|
-
#
|
11378
|
+
# Specifies whether to list the supported time zones for each engine
|
11379
|
+
# version.
|
11364
11380
|
#
|
11365
11381
|
# If this parameter is enabled and the requested engine supports the
|
11366
11382
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
11367
11383
|
# list of supported time zones for each engine version.
|
11368
11384
|
#
|
11369
11385
|
# For RDS Custom, the default is not to list supported time zones. If
|
11370
|
-
# you
|
11371
|
-
# results.
|
11386
|
+
# you enable this parameter, RDS Custom returns no results.
|
11372
11387
|
# @return [Boolean]
|
11373
11388
|
#
|
11374
11389
|
# @!attribute [rw] include_all
|
11375
|
-
#
|
11376
|
-
#
|
11377
|
-
# engine versions.
|
11390
|
+
# Specifies whether to also list the engine versions that aren't
|
11391
|
+
# available. The default is to list only available engine versions.
|
11378
11392
|
# @return [Boolean]
|
11379
11393
|
#
|
11380
11394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBEngineVersionsMessage AWS API Documentation
|
@@ -12145,10 +12159,10 @@ module Aws::RDS
|
|
12145
12159
|
# @return [String]
|
12146
12160
|
#
|
12147
12161
|
# @!attribute [rw] include_shared
|
12148
|
-
#
|
12149
|
-
#
|
12150
|
-
#
|
12151
|
-
#
|
12162
|
+
# Specifies whether to include shared manual DB cluster snapshots from
|
12163
|
+
# other Amazon Web Services accounts that this Amazon Web Services
|
12164
|
+
# account has been given permission to copy or restore. By default,
|
12165
|
+
# these snapshots are not included.
|
12152
12166
|
#
|
12153
12167
|
# You can give an Amazon Web Services account permission to restore a
|
12154
12168
|
# manual DB snapshot from another Amazon Web Services account by using
|
@@ -12158,10 +12172,9 @@ module Aws::RDS
|
|
12158
12172
|
# @return [Boolean]
|
12159
12173
|
#
|
12160
12174
|
# @!attribute [rw] include_public
|
12161
|
-
#
|
12162
|
-
#
|
12163
|
-
#
|
12164
|
-
# not included.
|
12175
|
+
# Specifies whether to include manual DB cluster snapshots that are
|
12176
|
+
# public and can be copied or restored by any Amazon Web Services
|
12177
|
+
# account. By default, the public snapshots are not included.
|
12165
12178
|
#
|
12166
12179
|
# You can share a manual DB snapshot as public by using the
|
12167
12180
|
# ModifyDBSnapshotAttribute API.
|
@@ -12425,7 +12438,7 @@ module Aws::RDS
|
|
12425
12438
|
# The type of source that is generating the events. For RDS Proxy
|
12426
12439
|
# events, specify `db-proxy`.
|
12427
12440
|
#
|
12428
|
-
# Valid
|
12441
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group`
|
12429
12442
|
# \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
12430
12443
|
# `db-proxy`
|
12431
12444
|
# @return [String]
|
@@ -12920,8 +12933,8 @@ module Aws::RDS
|
|
12920
12933
|
# @return [String]
|
12921
12934
|
#
|
12922
12935
|
# @!attribute [rw] vpc
|
12923
|
-
#
|
12924
|
-
#
|
12936
|
+
# Specifies whether to show only VPC or non-VPC offerings. RDS Custom
|
12937
|
+
# supports only VPC offerings.
|
12925
12938
|
#
|
12926
12939
|
# RDS Custom supports only VPC offerings. If you describe non-VPC
|
12927
12940
|
# offerings for RDS Custom, the output shows VPC offerings.
|
@@ -13051,8 +13064,8 @@ module Aws::RDS
|
|
13051
13064
|
# @return [String]
|
13052
13065
|
#
|
13053
13066
|
# @!attribute [rw] multi_az
|
13054
|
-
#
|
13055
|
-
#
|
13067
|
+
# Specifies whether to show only those reservations that support
|
13068
|
+
# Multi-AZ.
|
13056
13069
|
# @return [Boolean]
|
13057
13070
|
#
|
13058
13071
|
# @!attribute [rw] lease_id
|
@@ -13143,8 +13156,8 @@ module Aws::RDS
|
|
13143
13156
|
# @return [String]
|
13144
13157
|
#
|
13145
13158
|
# @!attribute [rw] multi_az
|
13146
|
-
#
|
13147
|
-
#
|
13159
|
+
# Specifies whether to show only those reservations that support
|
13160
|
+
# Multi-AZ.
|
13148
13161
|
# @return [Boolean]
|
13149
13162
|
#
|
13150
13163
|
# @!attribute [rw] filters
|
@@ -13345,7 +13358,7 @@ module Aws::RDS
|
|
13345
13358
|
# @return [String]
|
13346
13359
|
#
|
13347
13360
|
# @!attribute [rw] additional_data_pending
|
13348
|
-
# Boolean value that if true, indicates there is more data to be
|
13361
|
+
# A Boolean value that, if true, indicates there is more data to be
|
13349
13362
|
# downloaded.
|
13350
13363
|
# @return [Boolean]
|
13351
13364
|
#
|
@@ -13734,7 +13747,7 @@ module Aws::RDS
|
|
13734
13747
|
# Contains the details of a snapshot or cluster export to Amazon S3.
|
13735
13748
|
#
|
13736
13749
|
# This data type is used as a response element in the
|
13737
|
-
# `DescribeExportTasks`
|
13750
|
+
# `DescribeExportTasks` operation.
|
13738
13751
|
#
|
13739
13752
|
# @!attribute [rw] export_task_identifier
|
13740
13753
|
# A unique identifier for the snapshot or cluster export task. This ID
|
@@ -13748,8 +13761,9 @@ module Aws::RDS
|
|
13748
13761
|
# @return [String]
|
13749
13762
|
#
|
13750
13763
|
# @!attribute [rw] export_only
|
13751
|
-
# The data exported from the snapshot or cluster.
|
13752
|
-
#
|
13764
|
+
# The data exported from the snapshot or cluster.
|
13765
|
+
#
|
13766
|
+
# Valid Values:
|
13753
13767
|
#
|
13754
13768
|
# * `database` - Export all the data from a specified database.
|
13755
13769
|
#
|
@@ -13767,19 +13781,19 @@ module Aws::RDS
|
|
13767
13781
|
# @return [Array<String>]
|
13768
13782
|
#
|
13769
13783
|
# @!attribute [rw] snapshot_time
|
13770
|
-
# The time
|
13784
|
+
# The time when the snapshot was created.
|
13771
13785
|
# @return [Time]
|
13772
13786
|
#
|
13773
13787
|
# @!attribute [rw] task_start_time
|
13774
|
-
# The time
|
13788
|
+
# The time when the snapshot or cluster export task started.
|
13775
13789
|
# @return [Time]
|
13776
13790
|
#
|
13777
13791
|
# @!attribute [rw] task_end_time
|
13778
|
-
# The time
|
13792
|
+
# The time when the snapshot or cluster export task ended.
|
13779
13793
|
# @return [Time]
|
13780
13794
|
#
|
13781
13795
|
# @!attribute [rw] s3_bucket
|
13782
|
-
# The Amazon S3 bucket
|
13796
|
+
# The Amazon S3 bucket where the snapshot or cluster is exported to.
|
13783
13797
|
# @return [String]
|
13784
13798
|
#
|
13785
13799
|
# @!attribute [rw] s3_prefix
|
@@ -13892,12 +13906,12 @@ module Aws::RDS
|
|
13892
13906
|
end
|
13893
13907
|
|
13894
13908
|
# @!attribute [rw] db_cluster_identifier
|
13895
|
-
#
|
13896
|
-
# isn't case-sensitive.
|
13909
|
+
# The identifier of the DB cluster to force a failover for. This
|
13910
|
+
# parameter isn't case-sensitive.
|
13897
13911
|
#
|
13898
13912
|
# Constraints:
|
13899
13913
|
#
|
13900
|
-
# * Must match the identifier of an existing
|
13914
|
+
# * Must match the identifier of an existing DB cluster.
|
13901
13915
|
#
|
13902
13916
|
# ^
|
13903
13917
|
# @return [String]
|
@@ -14217,15 +14231,14 @@ module Aws::RDS
|
|
14217
14231
|
# @return [Array<String>]
|
14218
14232
|
#
|
14219
14233
|
# @!attribute [rw] is_writer
|
14220
|
-
#
|
14234
|
+
# Indicates whether the Aurora DB cluster is the primary cluster (that
|
14221
14235
|
# is, has read-write capability) for the global cluster with which it
|
14222
14236
|
# is associated.
|
14223
14237
|
# @return [Boolean]
|
14224
14238
|
#
|
14225
14239
|
# @!attribute [rw] global_write_forwarding_status
|
14226
|
-
#
|
14227
|
-
#
|
14228
|
-
# enabling it.
|
14240
|
+
# The status of write forwarding for a secondary cluster in the global
|
14241
|
+
# cluster.
|
14229
14242
|
# @return [String]
|
14230
14243
|
#
|
14231
14244
|
# @!attribute [rw] synchronization_status
|
@@ -14283,12 +14296,12 @@ module Aws::RDS
|
|
14283
14296
|
# `DescribeDBSecurityGroups` action.
|
14284
14297
|
#
|
14285
14298
|
# @!attribute [rw] status
|
14286
|
-
#
|
14299
|
+
# The status of the IP range. Status can be "authorizing",
|
14287
14300
|
# "authorized", "revoking", and "revoked".
|
14288
14301
|
# @return [String]
|
14289
14302
|
#
|
14290
14303
|
# @!attribute [rw] cidrip
|
14291
|
-
#
|
14304
|
+
# The IP range.
|
14292
14305
|
# @return [String]
|
14293
14306
|
#
|
14294
14307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/IPRange AWS API Documentation
|
@@ -14708,9 +14721,9 @@ module Aws::RDS
|
|
14708
14721
|
# @return [String]
|
14709
14722
|
#
|
14710
14723
|
# @!attribute [rw] remove_customer_override
|
14711
|
-
#
|
14712
|
-
#
|
14713
|
-
#
|
14724
|
+
# Specifies whether to remove the override for the default
|
14725
|
+
# certificate. If the override is removed, the default certificate is
|
14726
|
+
# the system default.
|
14714
14727
|
# @return [Boolean]
|
14715
14728
|
#
|
14716
14729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyCertificatesMessage AWS API Documentation
|
@@ -15144,7 +15157,7 @@ module Aws::RDS
|
|
15144
15157
|
# @!attribute [rw] allow_major_version_upgrade
|
15145
15158
|
# Specifies whether major version upgrades are allowed.
|
15146
15159
|
#
|
15147
|
-
# Valid for Cluster Type: Aurora DB clusters
|
15160
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
15148
15161
|
#
|
15149
15162
|
# Constraints:
|
15150
15163
|
#
|
@@ -15834,6 +15847,17 @@ module Aws::RDS
|
|
15834
15847
|
#
|
15835
15848
|
# Default: Uses existing setting
|
15836
15849
|
#
|
15850
|
+
# Constraints:
|
15851
|
+
#
|
15852
|
+
# * If you are modifying the DB instance class and upgrading the
|
15853
|
+
# engine version at the same time, the currently running engine
|
15854
|
+
# version must be supported on the specified DB instance class.
|
15855
|
+
# Otherwise, the operation returns an error. In this case, first run
|
15856
|
+
# the operation to modify the DB instance class, and then run it
|
15857
|
+
# again to upgrade the engine version.
|
15858
|
+
#
|
15859
|
+
# ^
|
15860
|
+
#
|
15837
15861
|
#
|
15838
15862
|
#
|
15839
15863
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
@@ -16116,6 +16140,17 @@ module Aws::RDS
|
|
16116
16140
|
#
|
16117
16141
|
# In RDS Custom for Oracle, this parameter is supported for read
|
16118
16142
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
16143
|
+
#
|
16144
|
+
# Constraints:
|
16145
|
+
#
|
16146
|
+
# * If you are upgrading the engine version and modifying the DB
|
16147
|
+
# instance class at the same time, the currently running engine
|
16148
|
+
# version must be supported on the specified DB instance class.
|
16149
|
+
# Otherwise, the operation returns an error. In this case, first run
|
16150
|
+
# the operation to modify the DB instance class, and then run it
|
16151
|
+
# again to upgrade the engine version.
|
16152
|
+
#
|
16153
|
+
# ^
|
16119
16154
|
# @return [String]
|
16120
16155
|
#
|
16121
16156
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -17383,7 +17418,7 @@ module Aws::RDS
|
|
17383
17418
|
# specify `db-proxy`. If this value isn't specified, all events are
|
17384
17419
|
# returned.
|
17385
17420
|
#
|
17386
|
-
# Valid
|
17421
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group`
|
17387
17422
|
# \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
17388
17423
|
# `db-proxy`
|
17389
17424
|
# @return [String]
|
@@ -17400,7 +17435,7 @@ module Aws::RDS
|
|
17400
17435
|
# @return [Array<String>]
|
17401
17436
|
#
|
17402
17437
|
# @!attribute [rw] enabled
|
17403
|
-
#
|
17438
|
+
# Specifies whether to activate the subscription.
|
17404
17439
|
# @return [Boolean]
|
17405
17440
|
#
|
17406
17441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyEventSubscriptionMessage AWS API Documentation
|
@@ -17536,9 +17571,9 @@ module Aws::RDS
|
|
17536
17571
|
# @return [Array<String>]
|
17537
17572
|
#
|
17538
17573
|
# @!attribute [rw] apply_immediately
|
17539
|
-
#
|
17540
|
-
#
|
17541
|
-
#
|
17574
|
+
# Specifies whether to apply the change immediately or during the next
|
17575
|
+
# maintenance window for each instance associated with the option
|
17576
|
+
# group.
|
17542
17577
|
# @return [Boolean]
|
17543
17578
|
#
|
17544
17579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyOptionGroupMessage AWS API Documentation
|
@@ -17570,7 +17605,7 @@ module Aws::RDS
|
|
17570
17605
|
#
|
17571
17606
|
class NetworkTypeNotSupported < Aws::EmptyStructure; end
|
17572
17607
|
|
17573
|
-
#
|
17608
|
+
# The details of an option.
|
17574
17609
|
#
|
17575
17610
|
# @!attribute [rw] option_name
|
17576
17611
|
# The name of the option.
|
@@ -17581,11 +17616,11 @@ module Aws::RDS
|
|
17581
17616
|
# @return [String]
|
17582
17617
|
#
|
17583
17618
|
# @!attribute [rw] persistent
|
17584
|
-
#
|
17619
|
+
# Indicates whether this option is persistent.
|
17585
17620
|
# @return [Boolean]
|
17586
17621
|
#
|
17587
17622
|
# @!attribute [rw] permanent
|
17588
|
-
#
|
17623
|
+
# Indicates whether this option is permanent.
|
17589
17624
|
# @return [Boolean]
|
17590
17625
|
#
|
17591
17626
|
# @!attribute [rw] port
|
@@ -17798,7 +17833,7 @@ module Aws::RDS
|
|
17798
17833
|
# @return [String]
|
17799
17834
|
#
|
17800
17835
|
# @!attribute [rw] port_required
|
17801
|
-
#
|
17836
|
+
# Indicates whether the option requires a port.
|
17802
17837
|
# @return [Boolean]
|
17803
17838
|
#
|
17804
17839
|
# @!attribute [rw] default_port
|
@@ -17855,7 +17890,7 @@ module Aws::RDS
|
|
17855
17890
|
# @return [Array<Types::OptionVersion>]
|
17856
17891
|
#
|
17857
17892
|
# @!attribute [rw] copyable_cross_account
|
17858
|
-
#
|
17893
|
+
# Indicates whether the option can be copied across Amazon Web
|
17859
17894
|
# Services accounts.
|
17860
17895
|
# @return [Boolean]
|
17861
17896
|
#
|
@@ -17908,13 +17943,13 @@ module Aws::RDS
|
|
17908
17943
|
# @return [String]
|
17909
17944
|
#
|
17910
17945
|
# @!attribute [rw] is_modifiable
|
17911
|
-
#
|
17912
|
-
#
|
17946
|
+
# Indicates whether this option group option can be changed from the
|
17947
|
+
# default value.
|
17913
17948
|
# @return [Boolean]
|
17914
17949
|
#
|
17915
17950
|
# @!attribute [rw] is_required
|
17916
|
-
#
|
17917
|
-
#
|
17951
|
+
# Indicates whether a value must be specified for this option setting
|
17952
|
+
# of the option group option.
|
17918
17953
|
# @return [Boolean]
|
17919
17954
|
#
|
17920
17955
|
# @!attribute [rw] minimum_engine_version_per_allowed_value
|
@@ -18019,12 +18054,12 @@ module Aws::RDS
|
|
18019
18054
|
# @return [String]
|
18020
18055
|
#
|
18021
18056
|
# @!attribute [rw] is_modifiable
|
18022
|
-
#
|
18023
|
-
#
|
18057
|
+
# Indicates whether the option setting can be modified from the
|
18058
|
+
# default.
|
18024
18059
|
# @return [Boolean]
|
18025
18060
|
#
|
18026
18061
|
# @!attribute [rw] is_collection
|
18027
|
-
# Indicates
|
18062
|
+
# Indicates whether the option setting is part of a collection.
|
18028
18063
|
# @return [Boolean]
|
18029
18064
|
#
|
18030
18065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/OptionSetting AWS API Documentation
|
@@ -18051,8 +18086,7 @@ module Aws::RDS
|
|
18051
18086
|
# @return [String]
|
18052
18087
|
#
|
18053
18088
|
# @!attribute [rw] is_default
|
18054
|
-
#
|
18055
|
-
# otherwise false.
|
18089
|
+
# Indicates whether the version is the default version of the option.
|
18056
18090
|
# @return [Boolean]
|
18057
18091
|
#
|
18058
18092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/OptionVersion AWS API Documentation
|
@@ -18110,7 +18144,7 @@ module Aws::RDS
|
|
18110
18144
|
# @return [Boolean]
|
18111
18145
|
#
|
18112
18146
|
# @!attribute [rw] storage_type
|
18113
|
-
#
|
18147
|
+
# The storage type for a DB instance.
|
18114
18148
|
# @return [String]
|
18115
18149
|
#
|
18116
18150
|
# @!attribute [rw] supports_iops
|
@@ -18128,8 +18162,7 @@ module Aws::RDS
|
|
18128
18162
|
# @return [Boolean]
|
18129
18163
|
#
|
18130
18164
|
# @!attribute [rw] supports_performance_insights
|
18131
|
-
#
|
18132
|
-
# false.
|
18165
|
+
# Indicates whether a DB instance supports Performance Insights.
|
18133
18166
|
# @return [Boolean]
|
18134
18167
|
#
|
18135
18168
|
# @!attribute [rw] min_storage_size
|
@@ -18166,16 +18199,16 @@ module Aws::RDS
|
|
18166
18199
|
# @return [Array<String>]
|
18167
18200
|
#
|
18168
18201
|
# @!attribute [rw] supports_storage_autoscaling
|
18169
|
-
#
|
18170
|
-
# that use the specified DB instance class.
|
18202
|
+
# Indicates whether Amazon RDS can automatically scale storage for DB
|
18203
|
+
# instances that use the specified DB instance class.
|
18171
18204
|
# @return [Boolean]
|
18172
18205
|
#
|
18173
18206
|
# @!attribute [rw] supports_kerberos_authentication
|
18174
|
-
#
|
18207
|
+
# Indicates whether a DB instance supports Kerberos Authentication.
|
18175
18208
|
# @return [Boolean]
|
18176
18209
|
#
|
18177
18210
|
# @!attribute [rw] outpost_capable
|
18178
|
-
#
|
18211
|
+
# Indicates whether a DB instance supports RDS on Outposts.
|
18179
18212
|
#
|
18180
18213
|
# For more information about RDS on Outposts, see [Amazon RDS on
|
18181
18214
|
# Amazon Web Services Outposts][1] in the *Amazon RDS User Guide.*
|
@@ -18193,12 +18226,13 @@ module Aws::RDS
|
|
18193
18226
|
# @return [Array<String>]
|
18194
18227
|
#
|
18195
18228
|
# @!attribute [rw] supports_global_databases
|
18196
|
-
#
|
18197
|
-
#
|
18229
|
+
# Indicates whether you can use Aurora global databases with a
|
18230
|
+
# specific combination of other DB engine attributes.
|
18198
18231
|
# @return [Boolean]
|
18199
18232
|
#
|
18200
18233
|
# @!attribute [rw] supports_clusters
|
18201
|
-
#
|
18234
|
+
# Indicates whether DB instances can be configured as a Multi-AZ DB
|
18235
|
+
# cluster.
|
18202
18236
|
#
|
18203
18237
|
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
18204
18238
|
# deployments with two readable standby DB instances][1] in the
|
@@ -18339,11 +18373,11 @@ module Aws::RDS
|
|
18339
18373
|
# `DescribeEngineDefaultParameters` and `DescribeDBParameters` actions.
|
18340
18374
|
#
|
18341
18375
|
# @!attribute [rw] parameter_name
|
18342
|
-
#
|
18376
|
+
# The name of the parameter.
|
18343
18377
|
# @return [String]
|
18344
18378
|
#
|
18345
18379
|
# @!attribute [rw] parameter_value
|
18346
|
-
#
|
18380
|
+
# The value of the parameter.
|
18347
18381
|
# @return [String]
|
18348
18382
|
#
|
18349
18383
|
# @!attribute [rw] description
|
@@ -18351,7 +18385,7 @@ module Aws::RDS
|
|
18351
18385
|
# @return [String]
|
18352
18386
|
#
|
18353
18387
|
# @!attribute [rw] source
|
18354
|
-
#
|
18388
|
+
# The source of the parameter value.
|
18355
18389
|
# @return [String]
|
18356
18390
|
#
|
18357
18391
|
# @!attribute [rw] apply_type
|
@@ -18530,8 +18564,8 @@ module Aws::RDS
|
|
18530
18564
|
# @return [Integer]
|
18531
18565
|
#
|
18532
18566
|
# @!attribute [rw] multi_az
|
18533
|
-
#
|
18534
|
-
#
|
18567
|
+
# Indicates whether the Single-AZ DB instance will change to a
|
18568
|
+
# Multi-AZ deployment.
|
18535
18569
|
# @return [Boolean]
|
18536
18570
|
#
|
18537
18571
|
# @!attribute [rw] engine_version
|
@@ -18587,7 +18621,7 @@ module Aws::RDS
|
|
18587
18621
|
# @return [Array<Types::ProcessorFeature>]
|
18588
18622
|
#
|
18589
18623
|
# @!attribute [rw] iam_database_authentication_enabled
|
18590
|
-
#
|
18624
|
+
# Indicates whether mapping of Amazon Web Services Identity and Access
|
18591
18625
|
# Management (IAM) accounts to database accounts is enabled.
|
18592
18626
|
# @return [Boolean]
|
18593
18627
|
#
|
@@ -19013,8 +19047,8 @@ module Aws::RDS
|
|
19013
19047
|
# @return [String]
|
19014
19048
|
#
|
19015
19049
|
# @!attribute [rw] force_failover
|
19016
|
-
#
|
19017
|
-
#
|
19050
|
+
# Specifies whether the reboot is conducted through a Multi-AZ
|
19051
|
+
# failover.
|
19018
19052
|
#
|
19019
19053
|
# Constraint: You can't enable force failover if the instance isn't
|
19020
19054
|
# configured for Multi-AZ.
|
@@ -19300,7 +19334,7 @@ module Aws::RDS
|
|
19300
19334
|
# @return [String]
|
19301
19335
|
#
|
19302
19336
|
# @!attribute [rw] multi_az
|
19303
|
-
# Indicates
|
19337
|
+
# Indicates whether the reservation applies to Multi-AZ deployments.
|
19304
19338
|
# @return [Boolean]
|
19305
19339
|
#
|
19306
19340
|
# @!attribute [rw] state
|
@@ -19424,7 +19458,7 @@ module Aws::RDS
|
|
19424
19458
|
# @return [String]
|
19425
19459
|
#
|
19426
19460
|
# @!attribute [rw] multi_az
|
19427
|
-
# Indicates
|
19461
|
+
# Indicates whether the offering applies to Multi-AZ deployments.
|
19428
19462
|
# @return [Boolean]
|
19429
19463
|
#
|
19430
19464
|
# @!attribute [rw] recurring_charges
|
@@ -19481,8 +19515,8 @@ module Aws::RDS
|
|
19481
19515
|
# @return [String]
|
19482
19516
|
#
|
19483
19517
|
# @!attribute [rw] reset_all_parameters
|
19484
|
-
#
|
19485
|
-
#
|
19518
|
+
# Specifies whether to reset all parameters in the DB cluster
|
19519
|
+
# parameter group to their default values. You can't use this
|
19486
19520
|
# parameter if there is a list of parameter names specified for the
|
19487
19521
|
# `Parameters` parameter.
|
19488
19522
|
# @return [Boolean]
|
@@ -19514,9 +19548,9 @@ module Aws::RDS
|
|
19514
19548
|
# @return [String]
|
19515
19549
|
#
|
19516
19550
|
# @!attribute [rw] reset_all_parameters
|
19517
|
-
#
|
19518
|
-
#
|
19519
|
-
#
|
19551
|
+
# Specifies whether to reset all parameters in the DB parameter group
|
19552
|
+
# to default values. By default, all parameters in the DB parameter
|
19553
|
+
# group are reset to default values.
|
19520
19554
|
# @return [Boolean]
|
19521
19555
|
#
|
19522
19556
|
# @!attribute [rw] parameters
|
@@ -19767,7 +19801,7 @@ module Aws::RDS
|
|
19767
19801
|
# @return [Array<Types::Tag>]
|
19768
19802
|
#
|
19769
19803
|
# @!attribute [rw] storage_encrypted
|
19770
|
-
#
|
19804
|
+
# Specifies whether the restored DB cluster is encrypted.
|
19771
19805
|
# @return [Boolean]
|
19772
19806
|
#
|
19773
19807
|
# @!attribute [rw] kms_key_id
|
@@ -19787,9 +19821,9 @@ module Aws::RDS
|
|
19787
19821
|
# @return [String]
|
19788
19822
|
#
|
19789
19823
|
# @!attribute [rw] enable_iam_database_authentication
|
19790
|
-
#
|
19791
|
-
#
|
19792
|
-
#
|
19824
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
19825
|
+
# and Access Management (IAM) accounts to database accounts. By
|
19826
|
+
# default, mapping isn't enabled.
|
19793
19827
|
#
|
19794
19828
|
# For more information, see [ IAM Database Authentication][1] in the
|
19795
19829
|
# *Amazon Aurora User Guide*.
|
@@ -19803,7 +19837,7 @@ module Aws::RDS
|
|
19803
19837
|
# The identifier for the database engine that was backed up to create
|
19804
19838
|
# the files stored in the Amazon S3 bucket.
|
19805
19839
|
#
|
19806
|
-
# Valid
|
19840
|
+
# Valid Values: `mysql`
|
19807
19841
|
# @return [String]
|
19808
19842
|
#
|
19809
19843
|
# @!attribute [rw] source_engine_version
|
@@ -19869,16 +19903,15 @@ module Aws::RDS
|
|
19869
19903
|
# @return [Array<String>]
|
19870
19904
|
#
|
19871
19905
|
# @!attribute [rw] deletion_protection
|
19872
|
-
#
|
19873
|
-
#
|
19874
|
-
#
|
19875
|
-
# enabled.
|
19906
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
19907
|
+
# The database can't be deleted when deletion protection is enabled.
|
19908
|
+
# By default, deletion protection isn't enabled.
|
19876
19909
|
# @return [Boolean]
|
19877
19910
|
#
|
19878
19911
|
# @!attribute [rw] copy_tags_to_snapshot
|
19879
|
-
#
|
19880
|
-
#
|
19881
|
-
#
|
19912
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
19913
|
+
# snapshots of the restored DB cluster. The default is not to copy
|
19914
|
+
# them.
|
19882
19915
|
# @return [Boolean]
|
19883
19916
|
#
|
19884
19917
|
# @!attribute [rw] domain
|
@@ -19915,7 +19948,7 @@ module Aws::RDS
|
|
19915
19948
|
# @!attribute [rw] network_type
|
19916
19949
|
# The network type of the DB cluster.
|
19917
19950
|
#
|
19918
|
-
# Valid
|
19951
|
+
# Valid Values:
|
19919
19952
|
#
|
19920
19953
|
# * `IPV4`
|
19921
19954
|
#
|
@@ -19934,8 +19967,8 @@ module Aws::RDS
|
|
19934
19967
|
# @return [String]
|
19935
19968
|
#
|
19936
19969
|
# @!attribute [rw] manage_master_user_password
|
19937
|
-
#
|
19938
|
-
#
|
19970
|
+
# Specifies whether to manage the master user password with Amazon Web
|
19971
|
+
# Services Secrets Manager.
|
19939
19972
|
#
|
19940
19973
|
# For more information, see [Password management with Amazon Web
|
19941
19974
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
@@ -19982,7 +20015,7 @@ module Aws::RDS
|
|
19982
20015
|
# @!attribute [rw] storage_type
|
19983
20016
|
# Specifies the storage type to be associated with the DB cluster.
|
19984
20017
|
#
|
19985
|
-
# Valid
|
20018
|
+
# Valid Values: `aurora`, `aurora-iopt1`
|
19986
20019
|
#
|
19987
20020
|
# Default: `aurora`
|
19988
20021
|
#
|
@@ -20251,9 +20284,9 @@ module Aws::RDS
|
|
20251
20284
|
# @return [String]
|
20252
20285
|
#
|
20253
20286
|
# @!attribute [rw] enable_iam_database_authentication
|
20254
|
-
#
|
20255
|
-
#
|
20256
|
-
#
|
20287
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
20288
|
+
# and Access Management (IAM) accounts to database accounts. By
|
20289
|
+
# default, mapping isn't enabled.
|
20257
20290
|
#
|
20258
20291
|
# For more information, see [ IAM Database Authentication][1] in the
|
20259
20292
|
# *Amazon Aurora User Guide*.
|
@@ -20362,27 +20395,26 @@ module Aws::RDS
|
|
20362
20395
|
# @return [String]
|
20363
20396
|
#
|
20364
20397
|
# @!attribute [rw] deletion_protection
|
20365
|
-
#
|
20366
|
-
#
|
20367
|
-
#
|
20368
|
-
# enabled.
|
20398
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
20399
|
+
# The database can't be deleted when deletion protection is enabled.
|
20400
|
+
# By default, deletion protection isn't enabled.
|
20369
20401
|
#
|
20370
20402
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20371
20403
|
# @return [Boolean]
|
20372
20404
|
#
|
20373
20405
|
# @!attribute [rw] copy_tags_to_snapshot
|
20374
|
-
#
|
20375
|
-
#
|
20376
|
-
#
|
20406
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
20407
|
+
# snapshots of the restored DB cluster. The default is not to copy
|
20408
|
+
# them.
|
20377
20409
|
#
|
20378
20410
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20379
20411
|
# @return [Boolean]
|
20380
20412
|
#
|
20381
20413
|
# @!attribute [rw] domain
|
20382
|
-
#
|
20383
|
-
#
|
20384
|
-
#
|
20385
|
-
#
|
20414
|
+
# The Active Directory directory ID to restore the DB cluster in. The
|
20415
|
+
# domain must be created prior to this operation. Currently, only
|
20416
|
+
# MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can
|
20417
|
+
# be created in an Active Directory Domain.
|
20386
20418
|
#
|
20387
20419
|
# For more information, see [ Kerberos Authentication][1] in the
|
20388
20420
|
# *Amazon RDS User Guide*.
|
@@ -20395,8 +20427,8 @@ module Aws::RDS
|
|
20395
20427
|
# @return [String]
|
20396
20428
|
#
|
20397
20429
|
# @!attribute [rw] domain_iam_role_name
|
20398
|
-
#
|
20399
|
-
#
|
20430
|
+
# The name of the IAM role to be used when making API calls to the
|
20431
|
+
# Directory Service.
|
20400
20432
|
#
|
20401
20433
|
# Valid for: Aurora DB clusters only
|
20402
20434
|
# @return [String]
|
@@ -20423,7 +20455,7 @@ module Aws::RDS
|
|
20423
20455
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
20424
20456
|
# parameter is required.
|
20425
20457
|
#
|
20426
|
-
# Valid
|
20458
|
+
# Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
|
20427
20459
|
# (Multi-AZ DB clusters)
|
20428
20460
|
#
|
20429
20461
|
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
@@ -20450,8 +20482,7 @@ module Aws::RDS
|
|
20450
20482
|
# @return [Integer]
|
20451
20483
|
#
|
20452
20484
|
# @!attribute [rw] publicly_accessible
|
20453
|
-
#
|
20454
|
-
# accessible.
|
20485
|
+
# Specifies whether the DB cluster is publicly accessible.
|
20455
20486
|
#
|
20456
20487
|
# When the DB cluster is publicly accessible, its Domain Name System
|
20457
20488
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -20503,7 +20534,7 @@ module Aws::RDS
|
|
20503
20534
|
# @!attribute [rw] network_type
|
20504
20535
|
# The network type of the DB cluster.
|
20505
20536
|
#
|
20506
|
-
# Valid
|
20537
|
+
# Valid Values:
|
20507
20538
|
#
|
20508
20539
|
# * `IPV4`
|
20509
20540
|
#
|
@@ -20664,9 +20695,9 @@ module Aws::RDS
|
|
20664
20695
|
# @return [Time]
|
20665
20696
|
#
|
20666
20697
|
# @!attribute [rw] use_latest_restorable_time
|
20667
|
-
#
|
20668
|
-
#
|
20669
|
-
#
|
20698
|
+
# Specifies whether to restore the DB cluster to the latest restorable
|
20699
|
+
# backup time. By default, the DB cluster isn't restored to the
|
20700
|
+
# latest restorable backup time.
|
20670
20701
|
#
|
20671
20702
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
20672
20703
|
# provided.
|
@@ -20748,9 +20779,9 @@ module Aws::RDS
|
|
20748
20779
|
# @return [String]
|
20749
20780
|
#
|
20750
20781
|
# @!attribute [rw] enable_iam_database_authentication
|
20751
|
-
#
|
20752
|
-
#
|
20753
|
-
#
|
20782
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
20783
|
+
# and Access Management (IAM) accounts to database accounts. By
|
20784
|
+
# default, mapping isn't enabled.
|
20754
20785
|
#
|
20755
20786
|
# For more information, see [ IAM Database Authentication][1] in the
|
20756
20787
|
# *Amazon Aurora User Guide*.
|
@@ -20816,9 +20847,11 @@ module Aws::RDS
|
|
20816
20847
|
# @return [Array<String>]
|
20817
20848
|
#
|
20818
20849
|
# @!attribute [rw] db_cluster_parameter_group_name
|
20819
|
-
# The name of the DB cluster parameter group to associate with
|
20820
|
-
#
|
20821
|
-
#
|
20850
|
+
# The name of the custom DB cluster parameter group to associate with
|
20851
|
+
# this DB cluster.
|
20852
|
+
#
|
20853
|
+
# If the `DBClusterParameterGroupName` parameter is omitted, the
|
20854
|
+
# default DB cluster parameter group for the specified engine is used.
|
20822
20855
|
#
|
20823
20856
|
# Constraints:
|
20824
20857
|
#
|
@@ -20835,25 +20868,24 @@ module Aws::RDS
|
|
20835
20868
|
# @return [String]
|
20836
20869
|
#
|
20837
20870
|
# @!attribute [rw] deletion_protection
|
20838
|
-
#
|
20839
|
-
#
|
20840
|
-
#
|
20841
|
-
# enabled.
|
20871
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
20872
|
+
# The database can't be deleted when deletion protection is enabled.
|
20873
|
+
# By default, deletion protection isn't enabled.
|
20842
20874
|
#
|
20843
20875
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20844
20876
|
# @return [Boolean]
|
20845
20877
|
#
|
20846
20878
|
# @!attribute [rw] copy_tags_to_snapshot
|
20847
|
-
#
|
20848
|
-
#
|
20849
|
-
#
|
20879
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
20880
|
+
# snapshots of the restored DB cluster. The default is not to copy
|
20881
|
+
# them.
|
20850
20882
|
#
|
20851
20883
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
20852
20884
|
# @return [Boolean]
|
20853
20885
|
#
|
20854
20886
|
# @!attribute [rw] domain
|
20855
|
-
#
|
20856
|
-
#
|
20887
|
+
# The Active Directory directory ID to restore the DB cluster in. The
|
20888
|
+
# domain must be created prior to this operation.
|
20857
20889
|
#
|
20858
20890
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
20859
20891
|
# Authentication to authenticate users that connect to the DB cluster.
|
@@ -20868,8 +20900,8 @@ module Aws::RDS
|
|
20868
20900
|
# @return [String]
|
20869
20901
|
#
|
20870
20902
|
# @!attribute [rw] domain_iam_role_name
|
20871
|
-
#
|
20872
|
-
#
|
20903
|
+
# The name of the IAM role to be used when making API calls to the
|
20904
|
+
# Directory Service.
|
20873
20905
|
#
|
20874
20906
|
# Valid for: Aurora DB clusters only
|
20875
20907
|
# @return [String]
|
@@ -20900,7 +20932,7 @@ module Aws::RDS
|
|
20900
20932
|
# database engines.
|
20901
20933
|
#
|
20902
20934
|
# For the full list of DB instance classes, and availability for your
|
20903
|
-
# engine, see [DB instance class][1] in the *Amazon RDS User Guide
|
20935
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide*.
|
20904
20936
|
#
|
20905
20937
|
# Valid for: Multi-AZ DB clusters only
|
20906
20938
|
#
|
@@ -20915,7 +20947,7 @@ module Aws::RDS
|
|
20915
20947
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
20916
20948
|
# parameter is required.
|
20917
20949
|
#
|
20918
|
-
# Valid
|
20950
|
+
# Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
|
20919
20951
|
# (Multi-AZ DB clusters)
|
20920
20952
|
#
|
20921
20953
|
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
@@ -20924,8 +20956,7 @@ module Aws::RDS
|
|
20924
20956
|
# @return [String]
|
20925
20957
|
#
|
20926
20958
|
# @!attribute [rw] publicly_accessible
|
20927
|
-
#
|
20928
|
-
# accessible.
|
20959
|
+
# Specifies whether the DB cluster is publicly accessible.
|
20929
20960
|
#
|
20930
20961
|
# When the DB cluster is publicly accessible, its Domain Name System
|
20931
20962
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -20995,7 +21026,7 @@ module Aws::RDS
|
|
20995
21026
|
# @!attribute [rw] network_type
|
20996
21027
|
# The network type of the DB cluster.
|
20997
21028
|
#
|
20998
|
-
# Valid
|
21029
|
+
# Valid Values:
|
20999
21030
|
#
|
21000
21031
|
# * `IPV4`
|
21001
21032
|
#
|
@@ -21168,8 +21199,7 @@ module Aws::RDS
|
|
21168
21199
|
# @return [String]
|
21169
21200
|
#
|
21170
21201
|
# @!attribute [rw] multi_az
|
21171
|
-
#
|
21172
|
-
# deployment.
|
21202
|
+
# Specifies whether the DB instance is a Multi-AZ deployment.
|
21173
21203
|
#
|
21174
21204
|
# This setting doesn't apply to RDS Custom.
|
21175
21205
|
#
|
@@ -21178,8 +21208,7 @@ module Aws::RDS
|
|
21178
21208
|
# @return [Boolean]
|
21179
21209
|
#
|
21180
21210
|
# @!attribute [rw] publicly_accessible
|
21181
|
-
#
|
21182
|
-
# accessible.
|
21211
|
+
# Specifies whether the DB instance is publicly accessible.
|
21183
21212
|
#
|
21184
21213
|
# When the DB instance is publicly accessible, its Domain Name System
|
21185
21214
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -21196,8 +21225,8 @@ module Aws::RDS
|
|
21196
21225
|
# @return [Boolean]
|
21197
21226
|
#
|
21198
21227
|
# @!attribute [rw] auto_minor_version_upgrade
|
21199
|
-
#
|
21200
|
-
#
|
21228
|
+
# Specifies whether to automatically apply minor version upgrades to
|
21229
|
+
# the DB instance during the maintenance window.
|
21201
21230
|
#
|
21202
21231
|
# If you restore an RDS Custom DB instance, you must disable this
|
21203
21232
|
# parameter.
|
@@ -21210,7 +21239,7 @@ module Aws::RDS
|
|
21210
21239
|
#
|
21211
21240
|
# Default: Same as source.
|
21212
21241
|
#
|
21213
|
-
# Valid
|
21242
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
21214
21243
|
# `general-public-license`
|
21215
21244
|
# @return [String]
|
21216
21245
|
#
|
@@ -21300,7 +21329,7 @@ module Aws::RDS
|
|
21300
21329
|
# @!attribute [rw] storage_type
|
21301
21330
|
# Specifies the storage type to be associated with the DB instance.
|
21302
21331
|
#
|
21303
|
-
# Valid
|
21332
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
21304
21333
|
#
|
21305
21334
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
21306
21335
|
# `Iops` parameter.
|
@@ -21379,6 +21408,10 @@ module Aws::RDS
|
|
21379
21408
|
#
|
21380
21409
|
# Constraints:
|
21381
21410
|
#
|
21411
|
+
# * Can't be longer than 64 characters.
|
21412
|
+
#
|
21413
|
+
# ^
|
21414
|
+
#
|
21382
21415
|
# Example:
|
21383
21416
|
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
21384
21417
|
# @return [String]
|
@@ -21399,8 +21432,8 @@ module Aws::RDS
|
|
21399
21432
|
# @return [Array<String>]
|
21400
21433
|
#
|
21401
21434
|
# @!attribute [rw] copy_tags_to_snapshot
|
21402
|
-
#
|
21403
|
-
#
|
21435
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
21436
|
+
# snapshots of the DB instance.
|
21404
21437
|
#
|
21405
21438
|
# In most cases, tags aren't copied by default. However, when you
|
21406
21439
|
# restore a DB instance from a DB snapshot, RDS checks whether you
|
@@ -21425,9 +21458,9 @@ module Aws::RDS
|
|
21425
21458
|
# @return [String]
|
21426
21459
|
#
|
21427
21460
|
# @!attribute [rw] enable_iam_database_authentication
|
21428
|
-
#
|
21429
|
-
#
|
21430
|
-
#
|
21461
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
21462
|
+
# and Access Management (IAM) accounts to database accounts. By
|
21463
|
+
# default, mapping is disabled.
|
21431
21464
|
#
|
21432
21465
|
# For more information about IAM database authentication, see [ IAM
|
21433
21466
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -21461,8 +21494,8 @@ module Aws::RDS
|
|
21461
21494
|
# @return [Array<Types::ProcessorFeature>]
|
21462
21495
|
#
|
21463
21496
|
# @!attribute [rw] use_default_processor_features
|
21464
|
-
#
|
21465
|
-
#
|
21497
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
21498
|
+
# default processor features.
|
21466
21499
|
#
|
21467
21500
|
# This setting doesn't apply to RDS Custom.
|
21468
21501
|
# @return [Boolean]
|
@@ -21488,10 +21521,10 @@ module Aws::RDS
|
|
21488
21521
|
# @return [String]
|
21489
21522
|
#
|
21490
21523
|
# @!attribute [rw] deletion_protection
|
21491
|
-
#
|
21492
|
-
#
|
21493
|
-
#
|
21494
|
-
#
|
21524
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
21525
|
+
# The database can't be deleted when deletion protection is enabled.
|
21526
|
+
# By default, deletion protection isn't enabled. For more
|
21527
|
+
# information, see [ Deleting a DB Instance][1].
|
21495
21528
|
#
|
21496
21529
|
#
|
21497
21530
|
#
|
@@ -21499,8 +21532,8 @@ module Aws::RDS
|
|
21499
21532
|
# @return [Boolean]
|
21500
21533
|
#
|
21501
21534
|
# @!attribute [rw] enable_customer_owned_ip
|
21502
|
-
#
|
21503
|
-
#
|
21535
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for
|
21536
|
+
# an RDS on Outposts DB instance.
|
21504
21537
|
#
|
21505
21538
|
# A *CoIP* provides local or external connectivity to resources in
|
21506
21539
|
# your Outpost subnets through your on-premises network. For some use
|
@@ -21564,7 +21597,7 @@ module Aws::RDS
|
|
21564
21597
|
# @!attribute [rw] network_type
|
21565
21598
|
# The network type of the DB instance.
|
21566
21599
|
#
|
21567
|
-
# Valid
|
21600
|
+
# Valid Values:
|
21568
21601
|
#
|
21569
21602
|
# * `IPV4`
|
21570
21603
|
#
|
@@ -21896,9 +21929,9 @@ module Aws::RDS
|
|
21896
21929
|
# @return [Integer]
|
21897
21930
|
#
|
21898
21931
|
# @!attribute [rw] multi_az
|
21899
|
-
#
|
21900
|
-
#
|
21901
|
-
#
|
21932
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. If the
|
21933
|
+
# DB instance is a Multi-AZ deployment, you can't set the
|
21934
|
+
# `AvailabilityZone` parameter.
|
21902
21935
|
# @return [Boolean]
|
21903
21936
|
#
|
21904
21937
|
# @!attribute [rw] engine_version
|
@@ -21909,9 +21942,9 @@ module Aws::RDS
|
|
21909
21942
|
# @return [String]
|
21910
21943
|
#
|
21911
21944
|
# @!attribute [rw] auto_minor_version_upgrade
|
21912
|
-
#
|
21913
|
-
#
|
21914
|
-
#
|
21945
|
+
# Specifies whether to automatically apply minor engine upgrades to
|
21946
|
+
# the DB instance during the maintenance window. By default, minor
|
21947
|
+
# engine upgrades are not applied automatically.
|
21915
21948
|
# @return [Boolean]
|
21916
21949
|
#
|
21917
21950
|
# @!attribute [rw] license_model
|
@@ -21937,8 +21970,7 @@ module Aws::RDS
|
|
21937
21970
|
# @return [String]
|
21938
21971
|
#
|
21939
21972
|
# @!attribute [rw] publicly_accessible
|
21940
|
-
#
|
21941
|
-
# accessible.
|
21973
|
+
# Specifies whether the DB instance is publicly accessible.
|
21942
21974
|
#
|
21943
21975
|
# When the DB instance is publicly accessible, its Domain Name System
|
21944
21976
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -21967,7 +21999,7 @@ module Aws::RDS
|
|
21967
21999
|
# @!attribute [rw] storage_type
|
21968
22000
|
# Specifies the storage type to be associated with the DB instance.
|
21969
22001
|
#
|
21970
|
-
# Valid
|
22002
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
21971
22003
|
#
|
21972
22004
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
21973
22005
|
# `Iops` parameter.
|
@@ -21976,8 +22008,7 @@ module Aws::RDS
|
|
21976
22008
|
# @return [String]
|
21977
22009
|
#
|
21978
22010
|
# @!attribute [rw] storage_encrypted
|
21979
|
-
#
|
21980
|
-
# not.
|
22011
|
+
# Specifies whether the new DB instance is encrypted or not.
|
21981
22012
|
# @return [Boolean]
|
21982
22013
|
#
|
21983
22014
|
# @!attribute [rw] kms_key_id
|
@@ -21997,8 +22028,8 @@ module Aws::RDS
|
|
21997
22028
|
# @return [String]
|
21998
22029
|
#
|
21999
22030
|
# @!attribute [rw] copy_tags_to_snapshot
|
22000
|
-
#
|
22001
|
-
#
|
22031
|
+
# Specifies whether to copy all tags from the DB instance to snapshots
|
22032
|
+
# of the DB instance. By default, tags are not copied.
|
22002
22033
|
# @return [Boolean]
|
22003
22034
|
#
|
22004
22035
|
# @!attribute [rw] monitoring_interval
|
@@ -22030,9 +22061,9 @@ module Aws::RDS
|
|
22030
22061
|
# @return [String]
|
22031
22062
|
#
|
22032
22063
|
# @!attribute [rw] enable_iam_database_authentication
|
22033
|
-
#
|
22034
|
-
#
|
22035
|
-
#
|
22064
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
22065
|
+
# and Access Management (IAM) accounts to database accounts. By
|
22066
|
+
# default, mapping isn't enabled.
|
22036
22067
|
#
|
22037
22068
|
# For more information about IAM database authentication, see [ IAM
|
22038
22069
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -22072,8 +22103,8 @@ module Aws::RDS
|
|
22072
22103
|
# @return [String]
|
22073
22104
|
#
|
22074
22105
|
# @!attribute [rw] enable_performance_insights
|
22075
|
-
#
|
22076
|
-
#
|
22106
|
+
# Specifies whether to enable Performance Insights for the DB
|
22107
|
+
# instance.
|
22077
22108
|
#
|
22078
22109
|
# For more information, see [Using Amazon Performance Insights][1] in
|
22079
22110
|
# the *Amazon RDS User Guide*.
|
@@ -22138,15 +22169,15 @@ module Aws::RDS
|
|
22138
22169
|
# @return [Array<Types::ProcessorFeature>]
|
22139
22170
|
#
|
22140
22171
|
# @!attribute [rw] use_default_processor_features
|
22141
|
-
#
|
22142
|
-
#
|
22172
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
22173
|
+
# default processor features.
|
22143
22174
|
# @return [Boolean]
|
22144
22175
|
#
|
22145
22176
|
# @!attribute [rw] deletion_protection
|
22146
|
-
#
|
22147
|
-
#
|
22148
|
-
#
|
22149
|
-
#
|
22177
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
22178
|
+
# The database can't be deleted when deletion protection is enabled.
|
22179
|
+
# By default, deletion protection isn't enabled. For more
|
22180
|
+
# information, see [ Deleting a DB Instance][1].
|
22150
22181
|
#
|
22151
22182
|
#
|
22152
22183
|
#
|
@@ -22169,7 +22200,7 @@ module Aws::RDS
|
|
22169
22200
|
# @!attribute [rw] network_type
|
22170
22201
|
# The network type of the DB instance.
|
22171
22202
|
#
|
22172
|
-
# Valid
|
22203
|
+
# Valid Values:
|
22173
22204
|
#
|
22174
22205
|
# * `IPV4`
|
22175
22206
|
#
|
@@ -22194,8 +22225,8 @@ module Aws::RDS
|
|
22194
22225
|
# @return [Integer]
|
22195
22226
|
#
|
22196
22227
|
# @!attribute [rw] manage_master_user_password
|
22197
|
-
#
|
22198
|
-
#
|
22228
|
+
# Specifies whether to manage the master user password with Amazon Web
|
22229
|
+
# Services Secrets Manager.
|
22199
22230
|
#
|
22200
22231
|
# For more information, see [Password management with Amazon Web
|
22201
22232
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
@@ -22322,40 +22353,42 @@ module Aws::RDS
|
|
22322
22353
|
# @return [String]
|
22323
22354
|
#
|
22324
22355
|
# @!attribute [rw] target_db_instance_identifier
|
22325
|
-
# The name of the new DB instance to
|
22356
|
+
# The name of the new DB instance to create.
|
22326
22357
|
#
|
22327
22358
|
# Constraints:
|
22328
22359
|
#
|
22329
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
22360
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
22330
22361
|
#
|
22331
|
-
# * First character must be a letter
|
22362
|
+
# * First character must be a letter.
|
22332
22363
|
#
|
22333
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
22364
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
22334
22365
|
# @return [String]
|
22335
22366
|
#
|
22336
22367
|
# @!attribute [rw] restore_time
|
22337
22368
|
# The date and time to restore from.
|
22338
22369
|
#
|
22339
|
-
# Valid Values: Value must be a time in Universal Coordinated Time
|
22340
|
-
# (UTC) format
|
22341
|
-
#
|
22342
22370
|
# Constraints:
|
22343
22371
|
#
|
22344
|
-
# * Must be
|
22372
|
+
# * Must be a time in Universal Coordinated Time (UTC) format.
|
22373
|
+
#
|
22374
|
+
# * Must be before the latest restorable time for the DB instance.
|
22345
22375
|
#
|
22346
22376
|
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
22347
|
-
# enabled
|
22377
|
+
# enabled.
|
22348
22378
|
#
|
22349
22379
|
# Example: `2009-09-07T23:45:00Z`
|
22350
22380
|
# @return [Time]
|
22351
22381
|
#
|
22352
22382
|
# @!attribute [rw] use_latest_restorable_time
|
22353
|
-
#
|
22354
|
-
#
|
22355
|
-
#
|
22383
|
+
# Specifies whether the DB instance is restored from the latest backup
|
22384
|
+
# time. By default, the DB instance isn't restored from the latest
|
22385
|
+
# backup time.
|
22356
22386
|
#
|
22357
|
-
# Constraints:
|
22358
|
-
#
|
22387
|
+
# Constraints:
|
22388
|
+
#
|
22389
|
+
# * Can't be specified if the `RestoreTime` parameter is provided.
|
22390
|
+
#
|
22391
|
+
# ^
|
22359
22392
|
# @return [Boolean]
|
22360
22393
|
#
|
22361
22394
|
# @!attribute [rw] db_instance_class
|
@@ -22365,7 +22398,7 @@ module Aws::RDS
|
|
22365
22398
|
# the full list of DB instance classes, and availability for your
|
22366
22399
|
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide*.
|
22367
22400
|
#
|
22368
|
-
# Default: The same
|
22401
|
+
# Default: The same DB instance class as the original DB instance.
|
22369
22402
|
#
|
22370
22403
|
#
|
22371
22404
|
#
|
@@ -22375,9 +22408,13 @@ module Aws::RDS
|
|
22375
22408
|
# @!attribute [rw] port
|
22376
22409
|
# The port number on which the database accepts connections.
|
22377
22410
|
#
|
22378
|
-
# Constraints: Value must be `1150-65535`
|
22379
|
-
#
|
22380
22411
|
# Default: The same port as the original DB instance.
|
22412
|
+
#
|
22413
|
+
# Constraints:
|
22414
|
+
#
|
22415
|
+
# * The value must be `1150-65535`.
|
22416
|
+
#
|
22417
|
+
# ^
|
22381
22418
|
# @return [Integer]
|
22382
22419
|
#
|
22383
22420
|
# @!attribute [rw] availability_zone
|
@@ -22385,8 +22422,12 @@ module Aws::RDS
|
|
22385
22422
|
#
|
22386
22423
|
# Default: A random, system-chosen Availability Zone.
|
22387
22424
|
#
|
22388
|
-
#
|
22389
|
-
#
|
22425
|
+
# Constraints:
|
22426
|
+
#
|
22427
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
22428
|
+
# instance is a Multi-AZ deployment.
|
22429
|
+
#
|
22430
|
+
# ^
|
22390
22431
|
#
|
22391
22432
|
# Example: `us-east-1a`
|
22392
22433
|
# @return [String]
|
@@ -22394,25 +22435,30 @@ module Aws::RDS
|
|
22394
22435
|
# @!attribute [rw] db_subnet_group_name
|
22395
22436
|
# The DB subnet group name to use for the new instance.
|
22396
22437
|
#
|
22397
|
-
# Constraints:
|
22398
|
-
#
|
22438
|
+
# Constraints:
|
22439
|
+
#
|
22440
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
22441
|
+
#
|
22442
|
+
# ^
|
22399
22443
|
#
|
22400
22444
|
# Example: `mydbsubnetgroup`
|
22401
22445
|
# @return [String]
|
22402
22446
|
#
|
22403
22447
|
# @!attribute [rw] multi_az
|
22404
|
-
#
|
22405
|
-
# deployment.
|
22448
|
+
# Secifies whether the DB instance is a Multi-AZ deployment.
|
22406
22449
|
#
|
22407
22450
|
# This setting doesn't apply to RDS Custom.
|
22408
22451
|
#
|
22409
|
-
#
|
22410
|
-
#
|
22452
|
+
# Constraints:
|
22453
|
+
#
|
22454
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
22455
|
+
# instance is a Multi-AZ deployment.
|
22456
|
+
#
|
22457
|
+
# ^
|
22411
22458
|
# @return [Boolean]
|
22412
22459
|
#
|
22413
22460
|
# @!attribute [rw] publicly_accessible
|
22414
|
-
#
|
22415
|
-
# accessible.
|
22461
|
+
# Specifies whether the DB instance is publicly accessible.
|
22416
22462
|
#
|
22417
22463
|
# When the DB cluster is publicly accessible, its Domain Name System
|
22418
22464
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -22429,21 +22475,21 @@ module Aws::RDS
|
|
22429
22475
|
# @return [Boolean]
|
22430
22476
|
#
|
22431
22477
|
# @!attribute [rw] auto_minor_version_upgrade
|
22432
|
-
#
|
22433
|
-
#
|
22478
|
+
# Specifies whether minor version upgrades are applied automatically
|
22479
|
+
# to the DB instance during the maintenance window.
|
22434
22480
|
#
|
22435
22481
|
# This setting doesn't apply to RDS Custom.
|
22436
22482
|
# @return [Boolean]
|
22437
22483
|
#
|
22438
22484
|
# @!attribute [rw] license_model
|
22439
|
-
#
|
22485
|
+
# The license model information for the restored DB instance.
|
22440
22486
|
#
|
22441
22487
|
# This setting doesn't apply to RDS Custom.
|
22442
22488
|
#
|
22443
|
-
#
|
22444
|
-
#
|
22445
|
-
# Valid values: `license-included` \| `bring-your-own-license` \|
|
22489
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
22446
22490
|
# `general-public-license`
|
22491
|
+
#
|
22492
|
+
# Default: Same as the source.
|
22447
22493
|
# @return [String]
|
22448
22494
|
#
|
22449
22495
|
# @!attribute [rw] db_name
|
@@ -22460,10 +22506,6 @@ module Aws::RDS
|
|
22460
22506
|
#
|
22461
22507
|
# This setting doesn't apply to RDS Custom.
|
22462
22508
|
#
|
22463
|
-
# Default: The same as source
|
22464
|
-
#
|
22465
|
-
# Constraint: Must be compatible with the engine of the source
|
22466
|
-
#
|
22467
22509
|
# Valid Values:
|
22468
22510
|
#
|
22469
22511
|
# * `mariadb`
|
@@ -22487,23 +22529,31 @@ module Aws::RDS
|
|
22487
22529
|
# * `sqlserver-ex`
|
22488
22530
|
#
|
22489
22531
|
# * `sqlserver-web`
|
22532
|
+
#
|
22533
|
+
# Default: The same as source
|
22534
|
+
#
|
22535
|
+
# Constraints:
|
22536
|
+
#
|
22537
|
+
# * Must be compatible with the engine of the source.
|
22538
|
+
#
|
22539
|
+
# ^
|
22490
22540
|
# @return [String]
|
22491
22541
|
#
|
22492
22542
|
# @!attribute [rw] iops
|
22493
22543
|
# The amount of Provisioned IOPS (input/output operations per second)
|
22494
|
-
# to
|
22544
|
+
# to initially allocate for the DB instance.
|
22495
22545
|
#
|
22496
|
-
#
|
22546
|
+
# This setting doesn't apply to SQL Server.
|
22497
22547
|
#
|
22498
|
-
#
|
22548
|
+
# Constraints:
|
22549
|
+
#
|
22550
|
+
# * Must be an integer greater than 1000.
|
22499
22551
|
#
|
22500
|
-
#
|
22501
|
-
# supported.
|
22552
|
+
# ^
|
22502
22553
|
# @return [Integer]
|
22503
22554
|
#
|
22504
22555
|
# @!attribute [rw] option_group_name
|
22505
|
-
# The name of the option group to
|
22506
|
-
# instance.
|
22556
|
+
# The name of the option group to use for the restored DB instance.
|
22507
22557
|
#
|
22508
22558
|
# Permanent options, such as the TDE option for Oracle Advanced
|
22509
22559
|
# Security TDE, can't be removed from an option group, and that
|
@@ -22514,9 +22564,8 @@ module Aws::RDS
|
|
22514
22564
|
# @return [String]
|
22515
22565
|
#
|
22516
22566
|
# @!attribute [rw] copy_tags_to_snapshot
|
22517
|
-
#
|
22518
|
-
#
|
22519
|
-
# copied.
|
22567
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
22568
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
22520
22569
|
# @return [Boolean]
|
22521
22570
|
#
|
22522
22571
|
# @!attribute [rw] tags
|
@@ -22529,14 +22578,19 @@ module Aws::RDS
|
|
22529
22578
|
# @return [Array<Types::Tag>]
|
22530
22579
|
#
|
22531
22580
|
# @!attribute [rw] storage_type
|
22532
|
-
#
|
22581
|
+
# The storage type to associate with the DB instance.
|
22533
22582
|
#
|
22534
|
-
# Valid
|
22583
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
22535
22584
|
#
|
22536
|
-
#
|
22537
|
-
# `
|
22585
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
22586
|
+
# `gp2`.
|
22538
22587
|
#
|
22539
|
-
#
|
22588
|
+
# Constraints:
|
22589
|
+
#
|
22590
|
+
# * If you specify `io1` or `gp3`, you must also include a value for
|
22591
|
+
# the `Iops` parameter.
|
22592
|
+
#
|
22593
|
+
# ^
|
22540
22594
|
# @return [String]
|
22541
22595
|
#
|
22542
22596
|
# @!attribute [rw] tde_credential_arn
|
@@ -22562,10 +22616,10 @@ module Aws::RDS
|
|
22562
22616
|
# @return [Array<String>]
|
22563
22617
|
#
|
22564
22618
|
# @!attribute [rw] domain
|
22565
|
-
#
|
22566
|
-
#
|
22567
|
-
#
|
22568
|
-
#
|
22619
|
+
# The Active Directory directory ID to restore the DB instance in.
|
22620
|
+
# Create the domain before running this command. Currently, you can
|
22621
|
+
# create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL
|
22622
|
+
# DB instances in an Active Directory Domain.
|
22569
22623
|
#
|
22570
22624
|
# This setting doesn't apply to RDS Custom.
|
22571
22625
|
#
|
@@ -22641,9 +22695,9 @@ module Aws::RDS
|
|
22641
22695
|
# @return [Array<String>]
|
22642
22696
|
#
|
22643
22697
|
# @!attribute [rw] enable_iam_database_authentication
|
22644
|
-
#
|
22645
|
-
#
|
22646
|
-
#
|
22698
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
22699
|
+
# and Access Management (IAM) accounts to database accounts. By
|
22700
|
+
# default, mapping isn't enabled.
|
22647
22701
|
#
|
22648
22702
|
# This setting doesn't apply to RDS Custom.
|
22649
22703
|
#
|
@@ -22677,8 +22731,8 @@ module Aws::RDS
|
|
22677
22731
|
# @return [Array<Types::ProcessorFeature>]
|
22678
22732
|
#
|
22679
22733
|
# @!attribute [rw] use_default_processor_features
|
22680
|
-
#
|
22681
|
-
#
|
22734
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
22735
|
+
# default processor features.
|
22682
22736
|
#
|
22683
22737
|
# This setting doesn't apply to RDS Custom.
|
22684
22738
|
# @return [Boolean]
|
@@ -22694,7 +22748,8 @@ module Aws::RDS
|
|
22694
22748
|
#
|
22695
22749
|
# Constraints:
|
22696
22750
|
#
|
22697
|
-
# * If supplied, must match the name of an existing
|
22751
|
+
# * If supplied, must match the name of an existing DB parameter
|
22752
|
+
# group.
|
22698
22753
|
#
|
22699
22754
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
22700
22755
|
#
|
@@ -22704,10 +22759,10 @@ module Aws::RDS
|
|
22704
22759
|
# @return [String]
|
22705
22760
|
#
|
22706
22761
|
# @!attribute [rw] deletion_protection
|
22707
|
-
#
|
22708
|
-
#
|
22709
|
-
#
|
22710
|
-
#
|
22762
|
+
# Specifies whether the DB instance has deletion protection enabled.
|
22763
|
+
# The database can't be deleted when deletion protection is enabled.
|
22764
|
+
# By default, deletion protection isn't enabled. For more
|
22765
|
+
# information, see [ Deleting a DB Instance][1].
|
22711
22766
|
#
|
22712
22767
|
#
|
22713
22768
|
#
|
@@ -22736,14 +22791,14 @@ module Aws::RDS
|
|
22736
22791
|
# @!attribute [rw] source_db_instance_automated_backups_arn
|
22737
22792
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
22738
22793
|
# from which to restore, for example,
|
22739
|
-
# `arn:aws:rds:
|
22794
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
22740
22795
|
#
|
22741
22796
|
# This setting doesn't apply to RDS Custom.
|
22742
22797
|
# @return [String]
|
22743
22798
|
#
|
22744
22799
|
# @!attribute [rw] enable_customer_owned_ip
|
22745
|
-
#
|
22746
|
-
#
|
22800
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for
|
22801
|
+
# an RDS on Outposts DB instance.
|
22747
22802
|
#
|
22748
22803
|
# A *CoIP* provides local or external connectivity to resources in
|
22749
22804
|
# your Outpost subnets through your on-premises network. For some use
|
@@ -22807,12 +22862,6 @@ module Aws::RDS
|
|
22807
22862
|
# @!attribute [rw] network_type
|
22808
22863
|
# The network type of the DB instance.
|
22809
22864
|
#
|
22810
|
-
# Valid values:
|
22811
|
-
#
|
22812
|
-
# * `IPV4`
|
22813
|
-
#
|
22814
|
-
# * `DUAL`
|
22815
|
-
#
|
22816
22865
|
# The network type is determined by the `DBSubnetGroup` specified for
|
22817
22866
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4
|
22818
22867
|
# protocol or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -22820,13 +22869,19 @@ module Aws::RDS
|
|
22820
22869
|
# For more information, see [ Working with a DB instance in a VPC][1]
|
22821
22870
|
# in the *Amazon RDS User Guide.*
|
22822
22871
|
#
|
22872
|
+
# Valid Values:
|
22873
|
+
#
|
22874
|
+
# * `IPV4`
|
22875
|
+
#
|
22876
|
+
# * `DUAL`
|
22877
|
+
#
|
22823
22878
|
#
|
22824
22879
|
#
|
22825
22880
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
22826
22881
|
# @return [String]
|
22827
22882
|
#
|
22828
22883
|
# @!attribute [rw] storage_throughput
|
22829
|
-
#
|
22884
|
+
# The storage throughput value for the DB instance.
|
22830
22885
|
#
|
22831
22886
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
22832
22887
|
# @return [Integer]
|
@@ -23050,9 +23105,9 @@ module Aws::RDS
|
|
23050
23105
|
# @return [Integer]
|
23051
23106
|
#
|
23052
23107
|
# @!attribute [rw] auto_pause
|
23053
|
-
#
|
23054
|
-
#
|
23055
|
-
#
|
23108
|
+
# Indicates whether to allow or disallow automatic pause for an Aurora
|
23109
|
+
# DB cluster in `serverless` DB engine mode. A DB cluster can be
|
23110
|
+
# paused only when it's idle (it has no connections).
|
23056
23111
|
#
|
23057
23112
|
# <note markdown="1"> If a DB cluster is paused for more than seven days, the DB cluster
|
23058
23113
|
# might be backed up with a snapshot. In this case, the DB cluster is
|
@@ -23131,8 +23186,8 @@ module Aws::RDS
|
|
23131
23186
|
# @return [Integer]
|
23132
23187
|
#
|
23133
23188
|
# @!attribute [rw] auto_pause
|
23134
|
-
#
|
23135
|
-
#
|
23189
|
+
# Indicates whether automatic pause is allowed for the Aurora DB
|
23190
|
+
# cluster in `serverless` DB engine mode.
|
23136
23191
|
#
|
23137
23192
|
# When the value is set to false for an Aurora Serverless v1 DB
|
23138
23193
|
# cluster, the DB cluster automatically resumes.
|
@@ -23288,8 +23343,9 @@ module Aws::RDS
|
|
23288
23343
|
# @return [String]
|
23289
23344
|
#
|
23290
23345
|
# @!attribute [rw] supports_db_instance_automated_backups_replication
|
23291
|
-
#
|
23292
|
-
# automated backups to the current Amazon Web Services
|
23346
|
+
# Indicates whether the source Amazon Web Services Region supports
|
23347
|
+
# replicating automated backups to the current Amazon Web Services
|
23348
|
+
# Region.
|
23293
23349
|
# @return [Boolean]
|
23294
23350
|
#
|
23295
23351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SourceRegion AWS API Documentation
|
@@ -23655,8 +23711,9 @@ module Aws::RDS
|
|
23655
23711
|
#
|
23656
23712
|
# @!attribute [rw] export_only
|
23657
23713
|
# The data to be exported from the snapshot or cluster. If this
|
23658
|
-
# parameter
|
23659
|
-
#
|
23714
|
+
# parameter isn't provided, all of the data is exported.
|
23715
|
+
#
|
23716
|
+
# Valid Values:
|
23660
23717
|
#
|
23661
23718
|
# * `database` - Export all the data from a specified database.
|
23662
23719
|
#
|
@@ -24234,13 +24291,13 @@ module Aws::RDS
|
|
24234
24291
|
# @return [String]
|
24235
24292
|
#
|
24236
24293
|
# @!attribute [rw] auto_upgrade
|
24237
|
-
#
|
24238
|
-
#
|
24294
|
+
# Indicates whether the target version is applied to any source DB
|
24295
|
+
# instances that have `AutoMinorVersionUpgrade` set to true.
|
24239
24296
|
# @return [Boolean]
|
24240
24297
|
#
|
24241
24298
|
# @!attribute [rw] is_major_version_upgrade
|
24242
|
-
#
|
24243
|
-
#
|
24299
|
+
# Indicates whether upgrading to the target version requires upgrading
|
24300
|
+
# the major version of the database engine.
|
24244
24301
|
# @return [Boolean]
|
24245
24302
|
#
|
24246
24303
|
# @!attribute [rw] supported_engine_modes
|
@@ -24249,25 +24306,25 @@ module Aws::RDS
|
|
24249
24306
|
# @return [Array<String>]
|
24250
24307
|
#
|
24251
24308
|
# @!attribute [rw] supports_parallel_query
|
24252
|
-
#
|
24253
|
-
#
|
24309
|
+
# Indicates whether you can use Aurora parallel query with the target
|
24310
|
+
# engine version.
|
24254
24311
|
# @return [Boolean]
|
24255
24312
|
#
|
24256
24313
|
# @!attribute [rw] supports_global_databases
|
24257
|
-
#
|
24258
|
-
#
|
24314
|
+
# Indicates whether you can use Aurora global databases with the
|
24315
|
+
# target engine version.
|
24259
24316
|
# @return [Boolean]
|
24260
24317
|
#
|
24261
24318
|
# @!attribute [rw] supports_babelfish
|
24262
|
-
#
|
24263
|
-
#
|
24319
|
+
# Indicates whether you can use Babelfish for Aurora PostgreSQL with
|
24320
|
+
# the target engine version.
|
24264
24321
|
# @return [Boolean]
|
24265
24322
|
#
|
24266
24323
|
# @!attribute [rw] supports_local_write_forwarding
|
24267
|
-
#
|
24268
|
-
#
|
24269
|
-
#
|
24270
|
-
#
|
24324
|
+
# Indicates whether the target engine version supports forwarding
|
24325
|
+
# write operations from reader DB instances to the writer DB instance
|
24326
|
+
# in the DB cluster. By default, write operations aren't allowed on
|
24327
|
+
# reader DB instances.
|
24271
24328
|
#
|
24272
24329
|
# Valid for: Aurora DB clusters only
|
24273
24330
|
# @return [Boolean]
|
@@ -24313,10 +24370,10 @@ module Aws::RDS
|
|
24313
24370
|
# @return [String]
|
24314
24371
|
#
|
24315
24372
|
# @!attribute [rw] iam_auth
|
24316
|
-
#
|
24317
|
-
# Access Management (IAM) authentication for
|
24318
|
-
# The `ENABLED` value is valid only for
|
24319
|
-
# SQL Server.
|
24373
|
+
# A value that indicates whether to require or disallow Amazon Web
|
24374
|
+
# Services Identity and Access Management (IAM) authentication for
|
24375
|
+
# connections to the proxy. The `ENABLED` value is valid only for
|
24376
|
+
# proxies with RDS for Microsoft SQL Server.
|
24320
24377
|
# @return [String]
|
24321
24378
|
#
|
24322
24379
|
# @!attribute [rw] client_password_auth_type
|
@@ -24432,8 +24489,8 @@ module Aws::RDS
|
|
24432
24489
|
# @return [Array<Types::DoubleRange>]
|
24433
24490
|
#
|
24434
24491
|
# @!attribute [rw] supports_storage_autoscaling
|
24435
|
-
#
|
24436
|
-
# instances that use the new instance class.
|
24492
|
+
# Indicates whether or not Amazon RDS can automatically scale storage
|
24493
|
+
# for DB instances that use the new instance class.
|
24437
24494
|
# @return [Boolean]
|
24438
24495
|
#
|
24439
24496
|
# @!attribute [rw] provisioned_storage_throughput
|