aws-sdk-rds 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +875 -310
- data/lib/aws-sdk-rds/client_api.rb +69 -0
- data/lib/aws-sdk-rds/db_cluster.rb +66 -59
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +8 -3
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +24 -20
- data/lib/aws-sdk-rds/db_instance.rb +182 -156
- data/lib/aws-sdk-rds/db_parameter_group.rb +12 -2
- data/lib/aws-sdk-rds/db_security_group.rb +7 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +53 -35
- data/lib/aws-sdk-rds/db_subnet_group.rb +6 -1
- data/lib/aws-sdk-rds/event_subscription.rb +7 -2
- data/lib/aws-sdk-rds/option_group.rb +12 -2
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +6 -1
- data/lib/aws-sdk-rds/resource.rb +156 -113
- data/lib/aws-sdk-rds/types.rb +918 -731
- metadata +2 -2
@@ -351,6 +351,8 @@ module Aws::RDS
|
|
351
351
|
RestoreDBClusterToPointInTimeResult = Shapes::StructureShape.new(name: 'RestoreDBClusterToPointInTimeResult')
|
352
352
|
RestoreDBInstanceFromDBSnapshotMessage = Shapes::StructureShape.new(name: 'RestoreDBInstanceFromDBSnapshotMessage')
|
353
353
|
RestoreDBInstanceFromDBSnapshotResult = Shapes::StructureShape.new(name: 'RestoreDBInstanceFromDBSnapshotResult')
|
354
|
+
RestoreDBInstanceFromS3Message = Shapes::StructureShape.new(name: 'RestoreDBInstanceFromS3Message')
|
355
|
+
RestoreDBInstanceFromS3Result = Shapes::StructureShape.new(name: 'RestoreDBInstanceFromS3Result')
|
354
356
|
RestoreDBInstanceToPointInTimeMessage = Shapes::StructureShape.new(name: 'RestoreDBInstanceToPointInTimeMessage')
|
355
357
|
RestoreDBInstanceToPointInTimeResult = Shapes::StructureShape.new(name: 'RestoreDBInstanceToPointInTimeResult')
|
356
358
|
RevokeDBSecurityGroupIngressMessage = Shapes::StructureShape.new(name: 'RevokeDBSecurityGroupIngressMessage')
|
@@ -1901,6 +1903,49 @@ module Aws::RDS
|
|
1901
1903
|
RestoreDBInstanceFromDBSnapshotResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
1902
1904
|
RestoreDBInstanceFromDBSnapshotResult.struct_class = Types::RestoreDBInstanceFromDBSnapshotResult
|
1903
1905
|
|
1906
|
+
RestoreDBInstanceFromS3Message.add_member(:db_name, Shapes::ShapeRef.new(shape: String, location_name: "DBName"))
|
1907
|
+
RestoreDBInstanceFromS3Message.add_member(:db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBInstanceIdentifier"))
|
1908
|
+
RestoreDBInstanceFromS3Message.add_member(:allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "AllocatedStorage"))
|
1909
|
+
RestoreDBInstanceFromS3Message.add_member(:db_instance_class, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBInstanceClass"))
|
1910
|
+
RestoreDBInstanceFromS3Message.add_member(:engine, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Engine"))
|
1911
|
+
RestoreDBInstanceFromS3Message.add_member(:master_username, Shapes::ShapeRef.new(shape: String, location_name: "MasterUsername"))
|
1912
|
+
RestoreDBInstanceFromS3Message.add_member(:master_user_password, Shapes::ShapeRef.new(shape: String, location_name: "MasterUserPassword"))
|
1913
|
+
RestoreDBInstanceFromS3Message.add_member(:db_security_groups, Shapes::ShapeRef.new(shape: DBSecurityGroupNameList, location_name: "DBSecurityGroups"))
|
1914
|
+
RestoreDBInstanceFromS3Message.add_member(:vpc_security_group_ids, Shapes::ShapeRef.new(shape: VpcSecurityGroupIdList, location_name: "VpcSecurityGroupIds"))
|
1915
|
+
RestoreDBInstanceFromS3Message.add_member(:availability_zone, Shapes::ShapeRef.new(shape: String, location_name: "AvailabilityZone"))
|
1916
|
+
RestoreDBInstanceFromS3Message.add_member(:db_subnet_group_name, Shapes::ShapeRef.new(shape: String, location_name: "DBSubnetGroupName"))
|
1917
|
+
RestoreDBInstanceFromS3Message.add_member(:preferred_maintenance_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredMaintenanceWindow"))
|
1918
|
+
RestoreDBInstanceFromS3Message.add_member(:db_parameter_group_name, Shapes::ShapeRef.new(shape: String, location_name: "DBParameterGroupName"))
|
1919
|
+
RestoreDBInstanceFromS3Message.add_member(:backup_retention_period, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "BackupRetentionPeriod"))
|
1920
|
+
RestoreDBInstanceFromS3Message.add_member(:preferred_backup_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredBackupWindow"))
|
1921
|
+
RestoreDBInstanceFromS3Message.add_member(:port, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Port"))
|
1922
|
+
RestoreDBInstanceFromS3Message.add_member(:multi_az, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "MultiAZ"))
|
1923
|
+
RestoreDBInstanceFromS3Message.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
1924
|
+
RestoreDBInstanceFromS3Message.add_member(:auto_minor_version_upgrade, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "AutoMinorVersionUpgrade"))
|
1925
|
+
RestoreDBInstanceFromS3Message.add_member(:license_model, Shapes::ShapeRef.new(shape: String, location_name: "LicenseModel"))
|
1926
|
+
RestoreDBInstanceFromS3Message.add_member(:iops, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Iops"))
|
1927
|
+
RestoreDBInstanceFromS3Message.add_member(:option_group_name, Shapes::ShapeRef.new(shape: String, location_name: "OptionGroupName"))
|
1928
|
+
RestoreDBInstanceFromS3Message.add_member(:publicly_accessible, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "PubliclyAccessible"))
|
1929
|
+
RestoreDBInstanceFromS3Message.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1930
|
+
RestoreDBInstanceFromS3Message.add_member(:storage_type, Shapes::ShapeRef.new(shape: String, location_name: "StorageType"))
|
1931
|
+
RestoreDBInstanceFromS3Message.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
|
1932
|
+
RestoreDBInstanceFromS3Message.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KmsKeyId"))
|
1933
|
+
RestoreDBInstanceFromS3Message.add_member(:copy_tags_to_snapshot, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CopyTagsToSnapshot"))
|
1934
|
+
RestoreDBInstanceFromS3Message.add_member(:monitoring_interval, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MonitoringInterval"))
|
1935
|
+
RestoreDBInstanceFromS3Message.add_member(:monitoring_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "MonitoringRoleArn"))
|
1936
|
+
RestoreDBInstanceFromS3Message.add_member(:enable_iam_database_authentication, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableIAMDatabaseAuthentication"))
|
1937
|
+
RestoreDBInstanceFromS3Message.add_member(:source_engine, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceEngine"))
|
1938
|
+
RestoreDBInstanceFromS3Message.add_member(:source_engine_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceEngineVersion"))
|
1939
|
+
RestoreDBInstanceFromS3Message.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "S3BucketName"))
|
1940
|
+
RestoreDBInstanceFromS3Message.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: String, location_name: "S3Prefix"))
|
1941
|
+
RestoreDBInstanceFromS3Message.add_member(:s3_ingestion_role_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "S3IngestionRoleArn"))
|
1942
|
+
RestoreDBInstanceFromS3Message.add_member(:enable_performance_insights, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnablePerformanceInsights"))
|
1943
|
+
RestoreDBInstanceFromS3Message.add_member(:performance_insights_kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "PerformanceInsightsKMSKeyId"))
|
1944
|
+
RestoreDBInstanceFromS3Message.struct_class = Types::RestoreDBInstanceFromS3Message
|
1945
|
+
|
1946
|
+
RestoreDBInstanceFromS3Result.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
1947
|
+
RestoreDBInstanceFromS3Result.struct_class = Types::RestoreDBInstanceFromS3Result
|
1948
|
+
|
1904
1949
|
RestoreDBInstanceToPointInTimeMessage.add_member(:source_db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceDBInstanceIdentifier"))
|
1905
1950
|
RestoreDBInstanceToPointInTimeMessage.add_member(:target_db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TargetDBInstanceIdentifier"))
|
1906
1951
|
RestoreDBInstanceToPointInTimeMessage.add_member(:restore_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "RestoreTime"))
|
@@ -3131,6 +3176,30 @@ module Aws::RDS
|
|
3131
3176
|
o.errors << Shapes::ShapeRef.new(shape: DomainNotFoundFault)
|
3132
3177
|
end)
|
3133
3178
|
|
3179
|
+
api.add_operation(:restore_db_instance_from_s3, Seahorse::Model::Operation.new.tap do |o|
|
3180
|
+
o.name = "RestoreDBInstanceFromS3"
|
3181
|
+
o.http_method = "POST"
|
3182
|
+
o.http_request_uri = "/"
|
3183
|
+
o.input = Shapes::ShapeRef.new(shape: RestoreDBInstanceFromS3Message)
|
3184
|
+
o.output = Shapes::ShapeRef.new(shape: RestoreDBInstanceFromS3Result)
|
3185
|
+
o.errors << Shapes::ShapeRef.new(shape: DBInstanceAlreadyExistsFault)
|
3186
|
+
o.errors << Shapes::ShapeRef.new(shape: InsufficientDBInstanceCapacityFault)
|
3187
|
+
o.errors << Shapes::ShapeRef.new(shape: DBParameterGroupNotFoundFault)
|
3188
|
+
o.errors << Shapes::ShapeRef.new(shape: DBSecurityGroupNotFoundFault)
|
3189
|
+
o.errors << Shapes::ShapeRef.new(shape: InstanceQuotaExceededFault)
|
3190
|
+
o.errors << Shapes::ShapeRef.new(shape: StorageQuotaExceededFault)
|
3191
|
+
o.errors << Shapes::ShapeRef.new(shape: DBSubnetGroupNotFoundFault)
|
3192
|
+
o.errors << Shapes::ShapeRef.new(shape: DBSubnetGroupDoesNotCoverEnoughAZs)
|
3193
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidSubnet)
|
3194
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidVPCNetworkStateFault)
|
3195
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3BucketFault)
|
3196
|
+
o.errors << Shapes::ShapeRef.new(shape: ProvisionedIopsNotAvailableInAZFault)
|
3197
|
+
o.errors << Shapes::ShapeRef.new(shape: OptionGroupNotFoundFault)
|
3198
|
+
o.errors << Shapes::ShapeRef.new(shape: StorageTypeNotSupportedFault)
|
3199
|
+
o.errors << Shapes::ShapeRef.new(shape: AuthorizationNotFoundFault)
|
3200
|
+
o.errors << Shapes::ShapeRef.new(shape: KMSKeyNotAccessibleFault)
|
3201
|
+
end)
|
3202
|
+
|
3134
3203
|
api.add_operation(:restore_db_instance_to_point_in_time, Seahorse::Model::Operation.new.tap do |o|
|
3135
3204
|
o.name = "RestoreDBInstanceToPointInTime"
|
3136
3205
|
o.http_method = "POST"
|
@@ -225,16 +225,16 @@ module Aws::RDS
|
|
225
225
|
data[:storage_encrypted]
|
226
226
|
end
|
227
227
|
|
228
|
-
# If `StorageEncrypted` is true, the KMS key identifier for the
|
228
|
+
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
229
229
|
# encrypted DB cluster.
|
230
230
|
# @return [String]
|
231
231
|
def kms_key_id
|
232
232
|
data[:kms_key_id]
|
233
233
|
end
|
234
234
|
|
235
|
-
# The
|
236
|
-
# identifier is found in AWS CloudTrail log entries whenever the KMS
|
237
|
-
# for the DB cluster is accessed.
|
235
|
+
# The AWS Region-unique, immutable identifier for the DB cluster. This
|
236
|
+
# identifier is found in AWS CloudTrail log entries whenever the AWS KMS
|
237
|
+
# key for the DB cluster is accessed.
|
238
238
|
# @return [String]
|
239
239
|
def db_cluster_resource_id
|
240
240
|
data[:db_cluster_resource_id]
|
@@ -256,7 +256,7 @@ module Aws::RDS
|
|
256
256
|
end
|
257
257
|
|
258
258
|
# True if mapping of AWS Identity and Access Management (IAM) accounts
|
259
|
-
# to database accounts is enabled
|
259
|
+
# to database accounts is enabled, and otherwise false.
|
260
260
|
# @return [Boolean]
|
261
261
|
def iam_database_authentication_enabled
|
262
262
|
data[:iam_database_authentication_enabled]
|
@@ -441,8 +441,8 @@ module Aws::RDS
|
|
441
441
|
# @param [Hash] options ({})
|
442
442
|
# @option options [Array<String>] :availability_zones
|
443
443
|
# A list of EC2 Availability Zones that instances in the DB cluster can
|
444
|
-
# be created in. For information on
|
445
|
-
# [Regions and Availability Zones][1].
|
444
|
+
# be created in. For information on AWS Regions and Availability Zones,
|
445
|
+
# see [Regions and Availability Zones][1].
|
446
446
|
#
|
447
447
|
#
|
448
448
|
#
|
@@ -487,7 +487,7 @@ module Aws::RDS
|
|
487
487
|
# @option options [required, String] :engine
|
488
488
|
# The name of the database engine to be used for this DB cluster.
|
489
489
|
#
|
490
|
-
# Valid Values: `aurora`
|
490
|
+
# Valid Values: `aurora`, `aurora-postgresql`
|
491
491
|
# @option options [String] :engine_version
|
492
492
|
# The version number of the database engine to use.
|
493
493
|
#
|
@@ -518,23 +518,24 @@ module Aws::RDS
|
|
518
518
|
# A value that indicates that the DB cluster should be associated with
|
519
519
|
# the specified option group.
|
520
520
|
#
|
521
|
-
# Permanent options
|
522
|
-
# group
|
521
|
+
# Permanent options can't be removed from an option group. The option
|
522
|
+
# group can't be removed from a DB cluster once it is associated with a
|
523
523
|
# DB cluster.
|
524
524
|
# @option options [String] :preferred_backup_window
|
525
525
|
# The daily time range during which automated backups are created if
|
526
526
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
527
527
|
# parameter.
|
528
528
|
#
|
529
|
-
#
|
530
|
-
# time
|
531
|
-
# the Preferred Maintenance Window][1] in the *Amazon
|
529
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
530
|
+
# block of time for each AWS Region. To see the time blocks available,
|
531
|
+
# see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
|
532
|
+
# RDS User Guide.*
|
532
533
|
#
|
533
534
|
# Constraints:
|
534
535
|
#
|
535
536
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
536
537
|
#
|
537
|
-
# *
|
538
|
+
# * Must be in Universal Coordinated Time (UTC).
|
538
539
|
#
|
539
540
|
# * Must not conflict with the preferred maintenance window.
|
540
541
|
#
|
@@ -549,12 +550,12 @@ module Aws::RDS
|
|
549
550
|
#
|
550
551
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
551
552
|
#
|
552
|
-
#
|
553
|
-
# time
|
554
|
-
# time blocks available, see [ Adjusting the Preferred
|
555
|
-
# Window][1] in the *Amazon RDS User Guide.*
|
553
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
554
|
+
# block of time for each AWS Region, occurring on a random day of the
|
555
|
+
# week. To see the time blocks available, see [ Adjusting the Preferred
|
556
|
+
# Maintenance Window][1] in the *Amazon RDS User Guide.*
|
556
557
|
#
|
557
|
-
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
558
|
+
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
558
559
|
#
|
559
560
|
# Constraints: Minimum 30-minute window.
|
560
561
|
#
|
@@ -565,11 +566,16 @@ module Aws::RDS
|
|
565
566
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
566
567
|
# if this DB cluster is created as a Read Replica.
|
567
568
|
# @option options [Array<Types::Tag>] :tags
|
568
|
-
# A list of tags.
|
569
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
570
|
+
# Resources][1].
|
571
|
+
#
|
572
|
+
#
|
573
|
+
#
|
574
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
569
575
|
# @option options [Boolean] :storage_encrypted
|
570
576
|
# Specifies whether the DB cluster is encrypted.
|
571
577
|
# @option options [String] :kms_key_id
|
572
|
-
# The KMS key identifier for an encrypted DB cluster.
|
578
|
+
# The AWS KMS key identifier for an encrypted DB cluster.
|
573
579
|
#
|
574
580
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
575
581
|
# encryption key. If you are creating a DB cluster with the same AWS
|
@@ -609,9 +615,9 @@ module Aws::RDS
|
|
609
615
|
# The pre-signed URL request must contain the following parameter
|
610
616
|
# values:
|
611
617
|
#
|
612
|
-
# * `KmsKeyId` - The KMS key identifier for the key to use to
|
613
|
-
# the copy of the DB cluster in the destination AWS Region.
|
614
|
-
# should refer to the same KMS key for both the `CreateDBCluster`
|
618
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
619
|
+
# encrypt the copy of the DB cluster in the destination AWS Region.
|
620
|
+
# This should refer to the same KMS key for both the `CreateDBCluster`
|
615
621
|
# action that is called in the destination AWS Region, and the action
|
616
622
|
# contained in the pre-signed URL.
|
617
623
|
#
|
@@ -622,8 +628,8 @@ module Aws::RDS
|
|
622
628
|
# encrypted DB cluster to be copied. This identifier must be in the
|
623
629
|
# Amazon Resource Name (ARN) format for the source AWS Region. For
|
624
630
|
# example, if you are copying an encrypted DB cluster from the
|
625
|
-
# us-west-2
|
626
|
-
# like Example:
|
631
|
+
# us-west-2 AWS Region, then your `ReplicationSourceIdentifier` would
|
632
|
+
# look like Example:
|
627
633
|
# `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`.
|
628
634
|
#
|
629
635
|
# To learn how to generate a Signature Version 4 signed request, see [
|
@@ -635,9 +641,8 @@ module Aws::RDS
|
|
635
641
|
# [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
636
642
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
637
643
|
# @option options [Boolean] :enable_iam_database_authentication
|
638
|
-
#
|
639
|
-
#
|
640
|
-
# false.
|
644
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
645
|
+
# accounts to database accounts, and otherwise false.
|
641
646
|
#
|
642
647
|
# Default: `false`
|
643
648
|
# @option options [String] :destination_region
|
@@ -843,23 +848,24 @@ module Aws::RDS
|
|
843
848
|
# brief (sub-second) period during which new connections are rejected
|
844
849
|
# but existing connections are not interrupted.
|
845
850
|
#
|
846
|
-
# Permanent options
|
847
|
-
# group
|
851
|
+
# Permanent options can't be removed from an option group. The option
|
852
|
+
# group can't be removed from a DB cluster once it is associated with a
|
848
853
|
# DB cluster.
|
849
854
|
# @option options [String] :preferred_backup_window
|
850
855
|
# The daily time range during which automated backups are created if
|
851
856
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
852
857
|
# parameter.
|
853
858
|
#
|
854
|
-
#
|
855
|
-
# time
|
856
|
-
# the Preferred Maintenance Window][1] in the *Amazon
|
859
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
860
|
+
# block of time for each AWS Region. To see the time blocks available,
|
861
|
+
# see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
|
862
|
+
# RDS User Guide.*
|
857
863
|
#
|
858
864
|
# Constraints:
|
859
865
|
#
|
860
866
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
861
867
|
#
|
862
|
-
# *
|
868
|
+
# * Must be in Universal Coordinated Time (UTC).
|
863
869
|
#
|
864
870
|
# * Must not conflict with the preferred maintenance window.
|
865
871
|
#
|
@@ -874,12 +880,12 @@ module Aws::RDS
|
|
874
880
|
#
|
875
881
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
876
882
|
#
|
877
|
-
#
|
878
|
-
# time
|
879
|
-
# time blocks available, see [ Adjusting the Preferred
|
880
|
-
# Window][1] in the *Amazon RDS User Guide.*
|
883
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
884
|
+
# block of time for each AWS Region, occurring on a random day of the
|
885
|
+
# week. To see the time blocks available, see [ Adjusting the Preferred
|
886
|
+
# Maintenance Window][1] in the *Amazon RDS User Guide.*
|
881
887
|
#
|
882
|
-
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
888
|
+
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
883
889
|
#
|
884
890
|
# Constraints: Minimum 30-minute window.
|
885
891
|
#
|
@@ -887,9 +893,8 @@ module Aws::RDS
|
|
887
893
|
#
|
888
894
|
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
|
889
895
|
# @option options [Boolean] :enable_iam_database_authentication
|
890
|
-
#
|
891
|
-
#
|
892
|
-
# false.
|
896
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
897
|
+
# accounts to database accounts, and otherwise false.
|
893
898
|
#
|
894
899
|
# Default: `false`
|
895
900
|
# @return [DBCluster]
|
@@ -944,7 +949,7 @@ module Aws::RDS
|
|
944
949
|
# * `copy-on-write` - The new DB cluster is restored as a clone of the
|
945
950
|
# source DB cluster.
|
946
951
|
#
|
947
|
-
# Constraints: You
|
952
|
+
# Constraints: You can't specify `copy-on-write` if the engine version
|
948
953
|
# of the source DB cluster is earlier than 1.11.
|
949
954
|
#
|
950
955
|
# If you don't specify a `RestoreType` value, then the new DB cluster
|
@@ -993,10 +998,15 @@ module Aws::RDS
|
|
993
998
|
# @option options [Array<String>] :vpc_security_group_ids
|
994
999
|
# A list of VPC security groups that the new DB cluster belongs to.
|
995
1000
|
# @option options [Array<Types::Tag>] :tags
|
996
|
-
# A list of tags.
|
1001
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1002
|
+
# Resources][1].
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
#
|
1006
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
997
1007
|
# @option options [String] :kms_key_id
|
998
|
-
# The KMS key identifier to use when restoring an encrypted DB
|
999
|
-
# from an encrypted DB cluster.
|
1008
|
+
# The AWS KMS key identifier to use when restoring an encrypted DB
|
1009
|
+
# cluster from an encrypted DB cluster.
|
1000
1010
|
#
|
1001
1011
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
1002
1012
|
# encryption key. If you are restoring a DB cluster with the same AWS
|
@@ -1022,9 +1032,8 @@ module Aws::RDS
|
|
1022
1032
|
# If `DBClusterIdentifier` refers to a DB cluster that is not encrypted,
|
1023
1033
|
# then the restore request is rejected.
|
1024
1034
|
# @option options [Boolean] :enable_iam_database_authentication
|
1025
|
-
#
|
1026
|
-
#
|
1027
|
-
# false.
|
1035
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
1036
|
+
# accounts to database accounts, and otherwise false.
|
1028
1037
|
#
|
1029
1038
|
# Default: `false`
|
1030
1039
|
# @return [DBCluster]
|
@@ -1165,7 +1174,7 @@ module Aws::RDS
|
|
1165
1174
|
# @param [Hash] options ({})
|
1166
1175
|
# @option options [String] :db_cluster_snapshot_identifier
|
1167
1176
|
# A specific DB cluster snapshot identifier to describe. This parameter
|
1168
|
-
#
|
1177
|
+
# can't be used in conjunction with the `DBClusterIdentifier`
|
1169
1178
|
# parameter. This value is stored as a lowercase string.
|
1170
1179
|
#
|
1171
1180
|
# Constraints:
|
@@ -1219,19 +1228,17 @@ module Aws::RDS
|
|
1219
1228
|
# the response includes only records beyond the marker, up to the value
|
1220
1229
|
# specified by `MaxRecords`.
|
1221
1230
|
# @option options [Boolean] :include_shared
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
# The default is `false`.
|
1231
|
+
# True to include shared manual DB cluster snapshots from other AWS
|
1232
|
+
# accounts that this AWS account has been given permission to copy or
|
1233
|
+
# restore, and otherwise false. The default is `false`.
|
1226
1234
|
#
|
1227
1235
|
# You can give an AWS account permission to restore a manual DB cluster
|
1228
1236
|
# snapshot from another AWS account by the
|
1229
1237
|
# ModifyDBClusterSnapshotAttribute API action.
|
1230
1238
|
# @option options [Boolean] :include_public
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
# false.
|
1239
|
+
# True to include manual DB cluster snapshots that are public and can be
|
1240
|
+
# copied or restored by any AWS account, and otherwise false. The
|
1241
|
+
# default is `false`. The default is false.
|
1235
1242
|
#
|
1236
1243
|
# You can share a manual DB cluster snapshot as public by using the
|
1237
1244
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -205,7 +205,12 @@ module Aws::RDS
|
|
205
205
|
# @option options [required, String] :description
|
206
206
|
# The description for the DB cluster parameter group.
|
207
207
|
# @option options [Array<Types::Tag>] :tags
|
208
|
-
# A list of tags.
|
208
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
209
|
+
# Resources][1].
|
210
|
+
#
|
211
|
+
#
|
212
|
+
#
|
213
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
209
214
|
# @return [DBClusterParameterGroup]
|
210
215
|
def create(options = {})
|
211
216
|
options = options.merge(db_cluster_parameter_group_name: @name)
|
@@ -282,11 +287,11 @@ module Aws::RDS
|
|
282
287
|
# @option options [Boolean] :reset_all_parameters
|
283
288
|
# A value that is set to `true` to reset all parameters in the DB
|
284
289
|
# cluster parameter group to their default values, and `false`
|
285
|
-
# otherwise. You
|
290
|
+
# otherwise. You can't use this parameter if there is a list of
|
286
291
|
# parameter names specified for the `Parameters` parameter.
|
287
292
|
# @option options [Array<Types::Parameter>] :parameters
|
288
293
|
# A list of parameter names in the DB cluster parameter group to reset
|
289
|
-
# to the default values. You
|
294
|
+
# to the default values. You can't use this parameter if the
|
290
295
|
# `ResetAllParameters` parameter is set to `true`.
|
291
296
|
# @return [DBClusterParameterGroup]
|
292
297
|
def reset(options = {})
|
@@ -130,7 +130,7 @@ module Aws::RDS
|
|
130
130
|
data[:storage_encrypted]
|
131
131
|
end
|
132
132
|
|
133
|
-
# If `StorageEncrypted` is true, the KMS key identifier for the
|
133
|
+
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
134
134
|
# encrypted DB cluster snapshot.
|
135
135
|
# @return [String]
|
136
136
|
def kms_key_id
|
@@ -145,14 +145,14 @@ module Aws::RDS
|
|
145
145
|
|
146
146
|
# If the DB cluster snapshot was copied from a source DB cluster
|
147
147
|
# snapshot, the Amazon Resource Name (ARN) for the source DB cluster
|
148
|
-
# snapshot
|
148
|
+
# snapshot, otherwise, a null value.
|
149
149
|
# @return [String]
|
150
150
|
def source_db_cluster_snapshot_arn
|
151
151
|
data[:source_db_cluster_snapshot_arn]
|
152
152
|
end
|
153
153
|
|
154
154
|
# True if mapping of AWS Identity and Access Management (IAM) accounts
|
155
|
-
# to database accounts is enabled
|
155
|
+
# to database accounts is enabled, and otherwise false.
|
156
156
|
# @return [Boolean]
|
157
157
|
def iam_database_authentication_enabled
|
158
158
|
data[:iam_database_authentication_enabled]
|
@@ -348,9 +348,9 @@ module Aws::RDS
|
|
348
348
|
#
|
349
349
|
# Example: `my-cluster-snapshot2`
|
350
350
|
# @option options [String] :kms_key_id
|
351
|
-
# The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS
|
352
|
-
# ID is the Amazon Resource Name (ARN), KMS key identifier, or the
|
353
|
-
# key alias for the KMS encryption key.
|
351
|
+
# The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS
|
352
|
+
# key ID is the Amazon Resource Name (ARN), KMS key identifier, or the
|
353
|
+
# KMS key alias for the KMS encryption key.
|
354
354
|
#
|
355
355
|
# If you copy an unencrypted DB cluster snapshot and specify a value for
|
356
356
|
# the `KmsKeyId` parameter, Amazon RDS encrypts the target DB cluster
|
@@ -369,7 +369,7 @@ module Aws::RDS
|
|
369
369
|
# must set `KmsKeyId` to the KMS key ID you want to use to encrypt the
|
370
370
|
# copy of the DB cluster snapshot in the destination AWS Region. KMS
|
371
371
|
# encryption keys are specific to the AWS Region that they are created
|
372
|
-
# in, and you
|
372
|
+
# in, and you can't use encryption keys from one AWS Region in another
|
373
373
|
# AWS Region.
|
374
374
|
# @option options [String] :pre_signed_url
|
375
375
|
# The URL that contains a Signature Version 4 signed request for the
|
@@ -384,11 +384,11 @@ module Aws::RDS
|
|
384
384
|
# copied. The pre-signed URL request must contain the following
|
385
385
|
# parameter values:
|
386
386
|
#
|
387
|
-
# * `KmsKeyId` - The KMS key identifier for the key to use to
|
388
|
-
# the copy of the DB cluster snapshot in the destination AWS
|
389
|
-
# This is the same identifier for both the
|
390
|
-
# action that is called in the destination AWS
|
391
|
-
# contained in the pre-signed URL.
|
387
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
388
|
+
# encrypt the copy of the DB cluster snapshot in the destination AWS
|
389
|
+
# Region. This is the same identifier for both the
|
390
|
+
# `CopyDBClusterSnapshot` action that is called in the destination AWS
|
391
|
+
# Region, and the action contained in the pre-signed URL.
|
392
392
|
#
|
393
393
|
# * `DestinationRegion` - The name of the AWS Region that the DB cluster
|
394
394
|
# snapshot will be created in.
|
@@ -397,7 +397,7 @@ module Aws::RDS
|
|
397
397
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
398
398
|
# identifier must be in the Amazon Resource Name (ARN) format for the
|
399
399
|
# source AWS Region. For example, if you are copying an encrypted DB
|
400
|
-
# cluster snapshot from the us-west-2
|
400
|
+
# cluster snapshot from the us-west-2 AWS Region, then your
|
401
401
|
# `SourceDBClusterSnapshotIdentifier` looks like the following
|
402
402
|
# example:
|
403
403
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
|
@@ -412,9 +412,14 @@ module Aws::RDS
|
|
412
412
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
413
413
|
# @option options [Boolean] :copy_tags
|
414
414
|
# True to copy all tags from the source DB cluster snapshot to the
|
415
|
-
# target DB cluster snapshot
|
415
|
+
# target DB cluster snapshot, and otherwise false. The default is false.
|
416
416
|
# @option options [Array<Types::Tag>] :tags
|
417
|
-
# A list of tags.
|
417
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
418
|
+
# Resources][1].
|
419
|
+
#
|
420
|
+
#
|
421
|
+
#
|
422
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
418
423
|
# @option options [String] :destination_region
|
419
424
|
# @option options [String] :source_region
|
420
425
|
# The source region of the snapshot. This is only needed when the
|
@@ -515,8 +520,8 @@ module Aws::RDS
|
|
515
520
|
# @option options [Array<Types::Tag>] :tags
|
516
521
|
# The tags to be assigned to the restored DB cluster.
|
517
522
|
# @option options [String] :kms_key_id
|
518
|
-
# The KMS key identifier to use when restoring an encrypted DB
|
519
|
-
# from a DB snapshot or DB cluster snapshot.
|
523
|
+
# The AWS KMS key identifier to use when restoring an encrypted DB
|
524
|
+
# cluster from a DB snapshot or DB cluster snapshot.
|
520
525
|
#
|
521
526
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
522
527
|
# encryption key. If you are restoring a DB cluster with the same AWS
|
@@ -534,9 +539,8 @@ module Aws::RDS
|
|
534
539
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
|
535
540
|
# not encrypted, then the restored DB cluster is not encrypted.
|
536
541
|
# @option options [Boolean] :enable_iam_database_authentication
|
537
|
-
#
|
538
|
-
#
|
539
|
-
# false.
|
542
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
543
|
+
# accounts to database accounts, and otherwise false.
|
540
544
|
#
|
541
545
|
# Default: `false`
|
542
546
|
# @return [DBCluster]
|