aws-sdk-rds 1.336.0 → 1.337.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +763 -1
- data/lib/aws-sdk-rds/client_api.rb +14 -0
- data/lib/aws-sdk-rds/db_cluster.rb +193 -5
- data/lib/aws-sdk-rds/db_instance.rb +22 -0
- data/lib/aws-sdk-rds/resource.rb +51 -0
- data/lib/aws-sdk-rds/types.rb +270 -8
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +6 -1
- data/sig/db_cluster.rbs +6 -1
- data/sig/db_instance.rbs +6 -0
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +15 -0
- metadata +1 -1
|
@@ -643,6 +643,7 @@ module Aws::RDS
|
|
|
643
643
|
PointInTimeRestoreNotEnabledFault = Shapes::StructureShape.new(name: 'PointInTimeRestoreNotEnabledFault', error: {"code" => "PointInTimeRestoreNotEnabled", "httpStatusCode" => 400, "senderFault" => true})
|
|
644
644
|
PotentiallySensitiveOptionSettingValue = Shapes::StringShape.new(name: 'PotentiallySensitiveOptionSettingValue')
|
|
645
645
|
PotentiallySensitiveParameterValue = Shapes::StringShape.new(name: 'PotentiallySensitiveParameterValue')
|
|
646
|
+
PrimaryEndpoint = Shapes::StructureShape.new(name: 'PrimaryEndpoint')
|
|
646
647
|
ProcessorFeature = Shapes::StructureShape.new(name: 'ProcessorFeature')
|
|
647
648
|
ProcessorFeatureList = Shapes::ListShape.new(name: 'ProcessorFeatureList')
|
|
648
649
|
PromoteReadReplicaDBClusterMessage = Shapes::StructureShape.new(name: 'PromoteReadReplicaDBClusterMessage')
|
|
@@ -1034,6 +1035,8 @@ module Aws::RDS
|
|
|
1034
1035
|
ClusterPendingModifiedValues.add_member(:rds_custom_cluster_configuration, Shapes::ShapeRef.new(shape: RdsCustomClusterConfiguration, location_name: "RdsCustomClusterConfiguration"))
|
|
1035
1036
|
ClusterPendingModifiedValues.add_member(:iops, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Iops"))
|
|
1036
1037
|
ClusterPendingModifiedValues.add_member(:certificate_details, Shapes::ShapeRef.new(shape: CertificateDetails, location_name: "CertificateDetails"))
|
|
1038
|
+
ClusterPendingModifiedValues.add_member(:vpc_networking_enabled, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "VPCNetworkingEnabled"))
|
|
1039
|
+
ClusterPendingModifiedValues.add_member(:internet_access_gateway_enabled, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "InternetAccessGatewayEnabled"))
|
|
1037
1040
|
ClusterPendingModifiedValues.struct_class = Types::ClusterPendingModifiedValues
|
|
1038
1041
|
|
|
1039
1042
|
ConnectionPoolConfiguration.add_member(:max_connections_percent, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxConnectionsPercent"))
|
|
@@ -1228,7 +1231,9 @@ module Aws::RDS
|
|
|
1228
1231
|
CreateDBClusterMessage.add_member(:engine_lifecycle_support, Shapes::ShapeRef.new(shape: String, location_name: "EngineLifecycleSupport"))
|
|
1229
1232
|
CreateDBClusterMessage.add_member(:tag_specifications, Shapes::ShapeRef.new(shape: TagSpecificationList, location_name: "TagSpecifications"))
|
|
1230
1233
|
CreateDBClusterMessage.add_member(:master_user_authentication_type, Shapes::ShapeRef.new(shape: MasterUserAuthenticationType, location_name: "MasterUserAuthenticationType"))
|
|
1234
|
+
CreateDBClusterMessage.add_member(:enable_vpc_networking, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableVPCNetworking"))
|
|
1231
1235
|
CreateDBClusterMessage.add_member(:with_express_configuration, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "WithExpressConfiguration"))
|
|
1236
|
+
CreateDBClusterMessage.add_member(:enable_internet_access_gateway, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableInternetAccessGateway"))
|
|
1232
1237
|
CreateDBClusterMessage.add_member(:associated_roles, Shapes::ShapeRef.new(shape: DBClusterAssociatedRoles, location_name: "AssociatedRoles"))
|
|
1233
1238
|
CreateDBClusterMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
|
|
1234
1239
|
CreateDBClusterMessage.struct_class = Types::CreateDBClusterMessage
|
|
@@ -1909,6 +1914,7 @@ module Aws::RDS
|
|
|
1909
1914
|
DBInstance.add_member(:master_username, Shapes::ShapeRef.new(shape: String, location_name: "MasterUsername"))
|
|
1910
1915
|
DBInstance.add_member(:db_name, Shapes::ShapeRef.new(shape: String, location_name: "DBName"))
|
|
1911
1916
|
DBInstance.add_member(:endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "Endpoint"))
|
|
1917
|
+
DBInstance.add_member(:primary_endpoint, Shapes::ShapeRef.new(shape: PrimaryEndpoint, location_name: "PrimaryEndpoint"))
|
|
1912
1918
|
DBInstance.add_member(:allocated_storage, Shapes::ShapeRef.new(shape: Integer, location_name: "AllocatedStorage"))
|
|
1913
1919
|
DBInstance.add_member(:instance_create_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "InstanceCreateTime"))
|
|
1914
1920
|
DBInstance.add_member(:preferred_backup_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredBackupWindow"))
|
|
@@ -1996,6 +2002,7 @@ module Aws::RDS
|
|
|
1996
2002
|
DBInstance.add_member(:storage_operation_status, Shapes::ShapeRef.new(shape: String, location_name: "StorageOperationStatus"))
|
|
1997
2003
|
DBInstance.add_member(:storage_operation_percent_progress, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "StorageOperationPercentProgress"))
|
|
1998
2004
|
DBInstance.add_member(:db_capacity_reservation_identifier, Shapes::ShapeRef.new(shape: DBCapacityReservationIdentifier, location_name: "DBCapacityReservationIdentifier"))
|
|
2005
|
+
DBInstance.add_member(:vpc_networking_enabled, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "VPCNetworkingEnabled"))
|
|
1999
2006
|
DBInstance.struct_class = Types::DBInstance
|
|
2000
2007
|
|
|
2001
2008
|
DBInstanceAlreadyExistsFault.struct_class = Types::DBInstanceAlreadyExistsFault
|
|
@@ -3398,6 +3405,9 @@ module Aws::RDS
|
|
|
3398
3405
|
ModifyDBClusterMessage.add_member(:ca_certificate_identifier, Shapes::ShapeRef.new(shape: String, location_name: "CACertificateIdentifier"))
|
|
3399
3406
|
ModifyDBClusterMessage.add_member(:master_user_authentication_type, Shapes::ShapeRef.new(shape: MasterUserAuthenticationType, location_name: "MasterUserAuthenticationType"))
|
|
3400
3407
|
ModifyDBClusterMessage.add_member(:engine_lifecycle_support, Shapes::ShapeRef.new(shape: String, location_name: "EngineLifecycleSupport"))
|
|
3408
|
+
ModifyDBClusterMessage.add_member(:enable_internet_access_gateway, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableInternetAccessGateway"))
|
|
3409
|
+
ModifyDBClusterMessage.add_member(:enable_vpc_networking, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableVPCNetworking"))
|
|
3410
|
+
ModifyDBClusterMessage.add_member(:db_subnet_group_name, Shapes::ShapeRef.new(shape: String, location_name: "DBSubnetGroupName"))
|
|
3401
3411
|
ModifyDBClusterMessage.struct_class = Types::ModifyDBClusterMessage
|
|
3402
3412
|
|
|
3403
3413
|
ModifyDBClusterParameterGroupMessage.add_member(:db_cluster_parameter_group_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBClusterParameterGroupName"))
|
|
@@ -3856,6 +3866,10 @@ module Aws::RDS
|
|
|
3856
3866
|
|
|
3857
3867
|
PointInTimeRestoreNotEnabledFault.struct_class = Types::PointInTimeRestoreNotEnabledFault
|
|
3858
3868
|
|
|
3869
|
+
PrimaryEndpoint.add_member(:address, Shapes::ShapeRef.new(shape: String, location_name: "Address"))
|
|
3870
|
+
PrimaryEndpoint.add_member(:hosted_zone_id, Shapes::ShapeRef.new(shape: String, location_name: "HostedZoneId"))
|
|
3871
|
+
PrimaryEndpoint.struct_class = Types::PrimaryEndpoint
|
|
3872
|
+
|
|
3859
3873
|
ProcessorFeature.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
|
3860
3874
|
ProcessorFeature.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
|
|
3861
3875
|
ProcessorFeature.struct_class = Types::ProcessorFeature
|
|
@@ -812,10 +812,11 @@ module Aws::RDS
|
|
|
812
812
|
data[:engine_lifecycle_support]
|
|
813
813
|
end
|
|
814
814
|
|
|
815
|
-
# Indicates whether the DB cluster uses VPC-based networking.
|
|
815
|
+
# Indicates whether the DB cluster uses VPC-based networking. The value
|
|
816
|
+
# is `false` only for an Aurora PostgreSQL DB cluster without VPC
|
|
817
|
+
# networking.
|
|
816
818
|
#
|
|
817
|
-
#
|
|
818
|
-
# through express configuration.
|
|
819
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
819
820
|
# @return [Boolean]
|
|
820
821
|
def vpc_networking_enabled
|
|
821
822
|
data[:vpc_networking_enabled]
|
|
@@ -824,8 +825,7 @@ module Aws::RDS
|
|
|
824
825
|
# Indicates whether the DB cluster has internet-based connectivity
|
|
825
826
|
# enabled through an internet access gateway.
|
|
826
827
|
#
|
|
827
|
-
#
|
|
828
|
-
# through express configuration.
|
|
828
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
829
829
|
# @return [Boolean]
|
|
830
830
|
def internet_access_gateway_enabled
|
|
831
831
|
data[:internet_access_gateway_enabled]
|
|
@@ -1059,7 +1059,9 @@ module Aws::RDS
|
|
|
1059
1059
|
# },
|
|
1060
1060
|
# ],
|
|
1061
1061
|
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
1062
|
+
# enable_vpc_networking: false,
|
|
1062
1063
|
# with_express_configuration: false,
|
|
1064
|
+
# enable_internet_access_gateway: false,
|
|
1063
1065
|
# associated_roles: [
|
|
1064
1066
|
# {
|
|
1065
1067
|
# role_arn: "IAMRoleArn", # required
|
|
@@ -1137,12 +1139,18 @@ module Aws::RDS
|
|
|
1137
1139
|
# @option options [Array<String>] :vpc_security_group_ids
|
|
1138
1140
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
1139
1141
|
#
|
|
1142
|
+
# Valid only for DB clusters inside a VPC. Don't specify it when you
|
|
1143
|
+
# set `EnableVPCNetworking` to `false`.
|
|
1144
|
+
#
|
|
1140
1145
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1141
1146
|
# @option options [String] :db_subnet_group_name
|
|
1142
1147
|
# A DB subnet group to associate with this DB cluster.
|
|
1143
1148
|
#
|
|
1144
1149
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
1145
1150
|
#
|
|
1151
|
+
# Valid only for DB clusters inside a VPC. Don't specify it when you
|
|
1152
|
+
# set `EnableVPCNetworking` to `false`.
|
|
1153
|
+
#
|
|
1146
1154
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1147
1155
|
#
|
|
1148
1156
|
# Constraints:
|
|
@@ -1699,6 +1707,8 @@ module Aws::RDS
|
|
|
1699
1707
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1700
1708
|
# the *Amazon Aurora User Guide.*
|
|
1701
1709
|
#
|
|
1710
|
+
# Don't specify it when you set `EnableVPCNetworking` to `false`.
|
|
1711
|
+
#
|
|
1702
1712
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
1703
1713
|
#
|
|
1704
1714
|
# Valid Values: `IPV4 | DUAL`
|
|
@@ -1940,13 +1950,54 @@ module Aws::RDS
|
|
|
1940
1950
|
#
|
|
1941
1951
|
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
1942
1952
|
# engines.
|
|
1953
|
+
# @option options [Boolean] :enable_vpc_networking
|
|
1954
|
+
# Specifies whether VPC networking is enabled for the DB cluster. Set to
|
|
1955
|
+
# `false` to create a DB cluster without VPC networking.
|
|
1956
|
+
#
|
|
1957
|
+
# A DB cluster without VPC networking needs an internet access gateway
|
|
1958
|
+
# and IAM database authentication. Set `EnableInternetAccessGateway` and
|
|
1959
|
+
# `EnableIAMDatabaseAuthentication` to `true`, and set
|
|
1960
|
+
# `MasterUserAuthenticationType` to `iam-db-auth`.
|
|
1961
|
+
#
|
|
1962
|
+
# Default: `true`. With `WithExpressConfiguration`, the default is
|
|
1963
|
+
# `false`.
|
|
1964
|
+
#
|
|
1965
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
1943
1966
|
# @option options [Boolean] :with_express_configuration
|
|
1944
1967
|
# Specifies to create an Aurora DB Cluster with express configuration in
|
|
1945
1968
|
# seconds. Express configuration provides a cluster with a writer
|
|
1946
1969
|
# instance and feature specific values set to all other input parameters
|
|
1947
1970
|
# of this API.
|
|
1948
1971
|
#
|
|
1972
|
+
# By default, a DB cluster with express configuration doesn't use VPC
|
|
1973
|
+
# networking. You connect to it over the internet through an internet
|
|
1974
|
+
# access gateway.
|
|
1975
|
+
#
|
|
1976
|
+
# To create the DB cluster in a VPC instead, set `EnableVPCNetworking`
|
|
1977
|
+
# to `true` and `EnableInternetAccessGateway` to `false`. You can also
|
|
1978
|
+
# specify `DBSubnetGroupName`, `VpcSecurityGroupIds`, and `NetworkType`.
|
|
1979
|
+
# If you don't specify `DBSubnetGroupName`, the DB cluster uses the
|
|
1980
|
+
# default DB subnet group for your Amazon Web Services account, in your
|
|
1981
|
+
# default VPC.
|
|
1982
|
+
#
|
|
1983
|
+
# A DB cluster with express configuration in a VPC takes longer to
|
|
1984
|
+
# become available than one without VPC networking.
|
|
1985
|
+
#
|
|
1949
1986
|
# Valid for Cluster Type: Aurora DB clusters
|
|
1987
|
+
# @option options [Boolean] :enable_internet_access_gateway
|
|
1988
|
+
# Specifies whether the DB cluster uses an internet access gateway. With
|
|
1989
|
+
# an internet access gateway, you connect to the DB cluster over the
|
|
1990
|
+
# internet without a VPC.
|
|
1991
|
+
#
|
|
1992
|
+
# Set to `true` only when you set `EnableVPCNetworking` to `false`. A DB
|
|
1993
|
+
# cluster can't use VPC networking and an internet access gateway at
|
|
1994
|
+
# the same time.
|
|
1995
|
+
#
|
|
1996
|
+
# Default: `false`. With `WithExpressConfiguration`, the default is
|
|
1997
|
+
# `true`. To create a DB cluster with express configuration in a VPC,
|
|
1998
|
+
# set this parameter to `false`.
|
|
1999
|
+
#
|
|
2000
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
1950
2001
|
# @option options [Array<Types::DBClusterAssociatedRole>] :associated_roles
|
|
1951
2002
|
# A list of Amazon Web Services Identity and Access Management (IAM)
|
|
1952
2003
|
# roles to associate with the DB cluster. Each role grants the DB
|
|
@@ -2159,6 +2210,9 @@ module Aws::RDS
|
|
|
2159
2210
|
# ca_certificate_identifier: "String",
|
|
2160
2211
|
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
2161
2212
|
# engine_lifecycle_support: "String",
|
|
2213
|
+
# enable_internet_access_gateway: false,
|
|
2214
|
+
# enable_vpc_networking: false,
|
|
2215
|
+
# db_subnet_group_name: "String",
|
|
2162
2216
|
# })
|
|
2163
2217
|
# @param [Hash] options ({})
|
|
2164
2218
|
# @option options [String] :new_db_cluster_identifier
|
|
@@ -2211,6 +2265,19 @@ module Aws::RDS
|
|
|
2211
2265
|
# @option options [Array<String>] :vpc_security_group_ids
|
|
2212
2266
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
2213
2267
|
#
|
|
2268
|
+
# Valid only for DB clusters inside a VPC. For a DB cluster that uses an
|
|
2269
|
+
# internet access gateway, specify this parameter only when you
|
|
2270
|
+
# re-enable VPC networking. Set `EnableVPCNetworking` to `true` and
|
|
2271
|
+
# `EnableInternetAccessGateway` to `false`.
|
|
2272
|
+
#
|
|
2273
|
+
# When you move the DB cluster to a different DB subnet group with
|
|
2274
|
+
# `DBSubnetGroupName`, or re-enable VPC networking, the security groups
|
|
2275
|
+
# must belong to the VPC of the DB subnet group. If you leave out this
|
|
2276
|
+
# parameter in those requests, the DB cluster uses the default security
|
|
2277
|
+
# group of that VPC, even for a move within the same VPC. To keep the
|
|
2278
|
+
# current security groups, specify their IDs. If the VPC is a shared
|
|
2279
|
+
# VPC, you must specify this parameter.
|
|
2280
|
+
#
|
|
2214
2281
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2215
2282
|
# @option options [Integer] :port
|
|
2216
2283
|
# The port number on which the DB cluster accepts connections.
|
|
@@ -2577,6 +2644,17 @@ module Aws::RDS
|
|
|
2577
2644
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2578
2645
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2579
2646
|
#
|
|
2647
|
+
# If the subnets in the DB subnet group support only the IPv4 protocol,
|
|
2648
|
+
# you can't set this parameter to `DUAL`.
|
|
2649
|
+
#
|
|
2650
|
+
# If you don't specify this parameter when you move the DB cluster to a
|
|
2651
|
+
# different DB subnet group with `DBSubnetGroupName`, the DB cluster
|
|
2652
|
+
# uses `IPV4`, even if it currently uses `DUAL`. To keep dual-stack
|
|
2653
|
+
# mode, specify `DUAL`. The new DB subnet group must support the network
|
|
2654
|
+
# type.
|
|
2655
|
+
#
|
|
2656
|
+
# Don't specify it when you set `EnableVPCNetworking` to `false`.
|
|
2657
|
+
#
|
|
2580
2658
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2581
2659
|
# the *Amazon Aurora User Guide.*
|
|
2582
2660
|
#
|
|
@@ -2867,6 +2945,116 @@ module Aws::RDS
|
|
|
2867
2945
|
#
|
|
2868
2946
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
|
|
2869
2947
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
2948
|
+
# @option options [Boolean] :enable_internet_access_gateway
|
|
2949
|
+
# Specifies whether the DB cluster uses an internet access gateway. With
|
|
2950
|
+
# an internet access gateway, you connect to the DB cluster over the
|
|
2951
|
+
# internet without a VPC.
|
|
2952
|
+
#
|
|
2953
|
+
# Set to `true` together with `EnableVPCNetworking` set to `false` to
|
|
2954
|
+
# move the DB cluster out of its VPC. Set to `false` together with
|
|
2955
|
+
# `EnableVPCNetworking` set to `true` to move the DB cluster into a VPC.
|
|
2956
|
+
# A DB cluster can't use VPC networking and an internet access gateway
|
|
2957
|
+
# at the same time.
|
|
2958
|
+
#
|
|
2959
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
2960
|
+
# @option options [Boolean] :enable_vpc_networking
|
|
2961
|
+
# Specifies whether VPC networking is enabled for the DB cluster. Set to
|
|
2962
|
+
# `false` to disable VPC networking for the DB cluster.
|
|
2963
|
+
#
|
|
2964
|
+
# A DB cluster without VPC networking needs an internet access gateway
|
|
2965
|
+
# and IAM database authentication. Set `EnableInternetAccessGateway` and
|
|
2966
|
+
# `EnableIAMDatabaseAuthentication` to `true`, and set
|
|
2967
|
+
# `MasterUserAuthenticationType` to `iam-db-auth`.
|
|
2968
|
+
#
|
|
2969
|
+
# Set to `true` to re-enable VPC networking for a DB cluster that uses
|
|
2970
|
+
# an internet access gateway. You can also specify `DBSubnetGroupName`,
|
|
2971
|
+
# `VpcSecurityGroupIds`, and `NetworkType`.
|
|
2972
|
+
#
|
|
2973
|
+
# The change is applied during the next maintenance window unless
|
|
2974
|
+
# `ApplyImmediately` is enabled.
|
|
2975
|
+
#
|
|
2976
|
+
# To move a DB cluster that already uses VPC networking to a different
|
|
2977
|
+
# DB subnet group, you don't need to set this parameter. Specify
|
|
2978
|
+
# `DBSubnetGroupName` instead.
|
|
2979
|
+
#
|
|
2980
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
2981
|
+
# @option options [String] :db_subnet_group_name
|
|
2982
|
+
# The DB subnet group for the DB cluster.
|
|
2983
|
+
#
|
|
2984
|
+
# Specify this parameter for one of these purposes:
|
|
2985
|
+
#
|
|
2986
|
+
# * To move an Aurora MySQL or Aurora PostgreSQL DB cluster that uses
|
|
2987
|
+
# VPC networking to a different DB subnet group. The new DB subnet
|
|
2988
|
+
# group can be in the same VPC or in a different VPC.
|
|
2989
|
+
#
|
|
2990
|
+
# * To enable VPC networking for an Aurora PostgreSQL DB cluster that
|
|
2991
|
+
# uses an internet access gateway. Set `EnableVPCNetworking` to `true`
|
|
2992
|
+
# and `EnableInternetAccessGateway` to `false`.
|
|
2993
|
+
#
|
|
2994
|
+
# When you move a DB cluster to a different DB subnet group, you don't
|
|
2995
|
+
# need to set `EnableVPCNetworking`. If you set it to `false`, Aurora
|
|
2996
|
+
# rejects the request. Security groups in `VpcSecurityGroupIds` must
|
|
2997
|
+
# belong to the VPC of the new DB subnet group. If you don't specify
|
|
2998
|
+
# `VpcSecurityGroupIds`, the DB cluster uses the default security group
|
|
2999
|
+
# of that VPC. If you don't specify `NetworkType`, the DB cluster uses
|
|
3000
|
+
# `IPV4`. Both defaults apply even if the DB cluster stays in the same
|
|
3001
|
+
# VPC.
|
|
3002
|
+
#
|
|
3003
|
+
# An outage occurs during the move. The DB cluster uses VPC networking
|
|
3004
|
+
# before, during, and after the move, and the move doesn't turn on an
|
|
3005
|
+
# internet access gateway. If you specify the DB subnet group that the
|
|
3006
|
+
# DB cluster already uses, the DB cluster isn't moved. The change is
|
|
3007
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
|
3008
|
+
# is enabled.
|
|
3009
|
+
#
|
|
3010
|
+
# Aurora rejects the move if the DB cluster:
|
|
3011
|
+
#
|
|
3012
|
+
# * Is a member of an Aurora global database.
|
|
3013
|
+
#
|
|
3014
|
+
# * Uses Aurora Limitless Database.
|
|
3015
|
+
#
|
|
3016
|
+
# * Is a cross-Region or in-Region read replica, or is the source of
|
|
3017
|
+
# one. Aurora Replicas in the DB cluster don't block the move.
|
|
3018
|
+
#
|
|
3019
|
+
# * Has enhanced binlog (Aurora MySQL), enhanced logical replication
|
|
3020
|
+
# (Aurora PostgreSQL), or Babelfish turned on.
|
|
3021
|
+
#
|
|
3022
|
+
# * Is a target of an RDS Proxy.
|
|
3023
|
+
#
|
|
3024
|
+
# * Is part of a blue/green deployment.
|
|
3025
|
+
#
|
|
3026
|
+
# * Is the source of a zero-ETL integration.
|
|
3027
|
+
#
|
|
3028
|
+
# * Has a database activity stream that isn't stopped.
|
|
3029
|
+
#
|
|
3030
|
+
# The move also fails if the DB cluster is switching to a different DB
|
|
3031
|
+
# cluster parameter group, or if a change to enhanced binlog, enhanced
|
|
3032
|
+
# logical replication, or Babelfish is pending in its DB cluster
|
|
3033
|
+
# parameter group. Apply the change, and reboot if required, before you
|
|
3034
|
+
# move the DB cluster.
|
|
3035
|
+
#
|
|
3036
|
+
# If the move fails, Aurora returns the DB cluster to its original DB
|
|
3037
|
+
# subnet group and cancels the change. To try again, call
|
|
3038
|
+
# `ModifyDBCluster` again.
|
|
3039
|
+
#
|
|
3040
|
+
# Aurora can't always return the DB cluster. If the move fails after
|
|
3041
|
+
# Aurora starts to update the DB cluster endpoints, or if the rollback
|
|
3042
|
+
# fails, the change doesn't complete. If Aurora can't restore the
|
|
3043
|
+
# original network configuration, the DB instances in the DB cluster
|
|
3044
|
+
# enter the `incompatible-network` state. In these cases, contact Amazon
|
|
3045
|
+
# Web Services Support.
|
|
3046
|
+
#
|
|
3047
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
3048
|
+
#
|
|
3049
|
+
# Default: If you don't specify this parameter when you enable VPC
|
|
3050
|
+
# networking, the DB cluster uses the default DB subnet group for your
|
|
3051
|
+
# Amazon Web Services account.
|
|
3052
|
+
#
|
|
3053
|
+
# Constraints: The DB subnet group must contain a subnet in each
|
|
3054
|
+
# Availability Zone that the DB instances in the DB cluster are located
|
|
3055
|
+
# in.
|
|
3056
|
+
#
|
|
3057
|
+
# Example: `mydbsubnetgroup`
|
|
2870
3058
|
# @return [DBCluster]
|
|
2871
3059
|
def modify(options = {})
|
|
2872
3060
|
options = options.merge(db_cluster_identifier: @id)
|
|
@@ -86,6 +86,20 @@ module Aws::RDS
|
|
|
86
86
|
data[:endpoint]
|
|
87
87
|
end
|
|
88
88
|
|
|
89
|
+
# Specifies the connection endpoint for the DB instance that currently
|
|
90
|
+
# has the primary role.
|
|
91
|
+
#
|
|
92
|
+
# This endpoint points to the new primary DB instance after a
|
|
93
|
+
# switchover, so you don't have to connect to a different DNS name.
|
|
94
|
+
#
|
|
95
|
+
# A read replica reports the same primary endpoint as the DB instance it
|
|
96
|
+
# replicates from. When you promote a read replica, it reports its own
|
|
97
|
+
# primary endpoint.
|
|
98
|
+
# @return [Types::PrimaryEndpoint]
|
|
99
|
+
def primary_endpoint
|
|
100
|
+
data[:primary_endpoint]
|
|
101
|
+
end
|
|
102
|
+
|
|
89
103
|
# The amount of storage in gibibytes (GiB) allocated for the DB
|
|
90
104
|
# instance.
|
|
91
105
|
# @return [Integer]
|
|
@@ -894,6 +908,14 @@ module Aws::RDS
|
|
|
894
908
|
data[:db_capacity_reservation_identifier]
|
|
895
909
|
end
|
|
896
910
|
|
|
911
|
+
# Indicates whether the DB instance uses VPC networking. For a DB
|
|
912
|
+
# instance in an Aurora PostgreSQL DB cluster without VPC networking,
|
|
913
|
+
# the value is `false`.
|
|
914
|
+
# @return [Boolean]
|
|
915
|
+
def vpc_networking_enabled
|
|
916
|
+
data[:vpc_networking_enabled]
|
|
917
|
+
end
|
|
918
|
+
|
|
897
919
|
# @!endgroup
|
|
898
920
|
|
|
899
921
|
# @return [Client]
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
|
@@ -126,7 +126,9 @@ module Aws::RDS
|
|
|
126
126
|
# },
|
|
127
127
|
# ],
|
|
128
128
|
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
129
|
+
# enable_vpc_networking: false,
|
|
129
130
|
# with_express_configuration: false,
|
|
131
|
+
# enable_internet_access_gateway: false,
|
|
130
132
|
# associated_roles: [
|
|
131
133
|
# {
|
|
132
134
|
# role_arn: "IAMRoleArn", # required
|
|
@@ -220,12 +222,18 @@ module Aws::RDS
|
|
|
220
222
|
# @option options [Array<String>] :vpc_security_group_ids
|
|
221
223
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
|
222
224
|
#
|
|
225
|
+
# Valid only for DB clusters inside a VPC. Don't specify it when you
|
|
226
|
+
# set `EnableVPCNetworking` to `false`.
|
|
227
|
+
#
|
|
223
228
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
224
229
|
# @option options [String] :db_subnet_group_name
|
|
225
230
|
# A DB subnet group to associate with this DB cluster.
|
|
226
231
|
#
|
|
227
232
|
# This setting is required to create a Multi-AZ DB cluster.
|
|
228
233
|
#
|
|
234
|
+
# Valid only for DB clusters inside a VPC. Don't specify it when you
|
|
235
|
+
# set `EnableVPCNetworking` to `false`.
|
|
236
|
+
#
|
|
229
237
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
230
238
|
#
|
|
231
239
|
# Constraints:
|
|
@@ -782,6 +790,8 @@ module Aws::RDS
|
|
|
782
790
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
783
791
|
# the *Amazon Aurora User Guide.*
|
|
784
792
|
#
|
|
793
|
+
# Don't specify it when you set `EnableVPCNetworking` to `false`.
|
|
794
|
+
#
|
|
785
795
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
786
796
|
#
|
|
787
797
|
# Valid Values: `IPV4 | DUAL`
|
|
@@ -1023,13 +1033,54 @@ module Aws::RDS
|
|
|
1023
1033
|
#
|
|
1024
1034
|
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
1025
1035
|
# engines.
|
|
1036
|
+
# @option options [Boolean] :enable_vpc_networking
|
|
1037
|
+
# Specifies whether VPC networking is enabled for the DB cluster. Set to
|
|
1038
|
+
# `false` to create a DB cluster without VPC networking.
|
|
1039
|
+
#
|
|
1040
|
+
# A DB cluster without VPC networking needs an internet access gateway
|
|
1041
|
+
# and IAM database authentication. Set `EnableInternetAccessGateway` and
|
|
1042
|
+
# `EnableIAMDatabaseAuthentication` to `true`, and set
|
|
1043
|
+
# `MasterUserAuthenticationType` to `iam-db-auth`.
|
|
1044
|
+
#
|
|
1045
|
+
# Default: `true`. With `WithExpressConfiguration`, the default is
|
|
1046
|
+
# `false`.
|
|
1047
|
+
#
|
|
1048
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
1026
1049
|
# @option options [Boolean] :with_express_configuration
|
|
1027
1050
|
# Specifies to create an Aurora DB Cluster with express configuration in
|
|
1028
1051
|
# seconds. Express configuration provides a cluster with a writer
|
|
1029
1052
|
# instance and feature specific values set to all other input parameters
|
|
1030
1053
|
# of this API.
|
|
1031
1054
|
#
|
|
1055
|
+
# By default, a DB cluster with express configuration doesn't use VPC
|
|
1056
|
+
# networking. You connect to it over the internet through an internet
|
|
1057
|
+
# access gateway.
|
|
1058
|
+
#
|
|
1059
|
+
# To create the DB cluster in a VPC instead, set `EnableVPCNetworking`
|
|
1060
|
+
# to `true` and `EnableInternetAccessGateway` to `false`. You can also
|
|
1061
|
+
# specify `DBSubnetGroupName`, `VpcSecurityGroupIds`, and `NetworkType`.
|
|
1062
|
+
# If you don't specify `DBSubnetGroupName`, the DB cluster uses the
|
|
1063
|
+
# default DB subnet group for your Amazon Web Services account, in your
|
|
1064
|
+
# default VPC.
|
|
1065
|
+
#
|
|
1066
|
+
# A DB cluster with express configuration in a VPC takes longer to
|
|
1067
|
+
# become available than one without VPC networking.
|
|
1068
|
+
#
|
|
1032
1069
|
# Valid for Cluster Type: Aurora DB clusters
|
|
1070
|
+
# @option options [Boolean] :enable_internet_access_gateway
|
|
1071
|
+
# Specifies whether the DB cluster uses an internet access gateway. With
|
|
1072
|
+
# an internet access gateway, you connect to the DB cluster over the
|
|
1073
|
+
# internet without a VPC.
|
|
1074
|
+
#
|
|
1075
|
+
# Set to `true` only when you set `EnableVPCNetworking` to `false`. A DB
|
|
1076
|
+
# cluster can't use VPC networking and an internet access gateway at
|
|
1077
|
+
# the same time.
|
|
1078
|
+
#
|
|
1079
|
+
# Default: `false`. With `WithExpressConfiguration`, the default is
|
|
1080
|
+
# `true`. To create a DB cluster with express configuration in a VPC,
|
|
1081
|
+
# set this parameter to `false`.
|
|
1082
|
+
#
|
|
1083
|
+
# Valid for Cluster Type: Aurora PostgreSQL DB clusters only
|
|
1033
1084
|
# @option options [Array<Types::DBClusterAssociatedRole>] :associated_roles
|
|
1034
1085
|
# A list of Amazon Web Services Identity and Access Management (IAM)
|
|
1035
1086
|
# roles to associate with the DB cluster. Each role grants the DB
|