aws-sdk-rds 1.72.0 → 1.73.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @id = extract_id(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @snapshot_id = extract_snapshot_id(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = Aws::EmptyStructure.new
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @version = extract_version(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @id = extract_id(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @name = extract_name(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = Aws::EmptyStructure.new
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @snapshot_id = extract_snapshot_id(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @name = extract_name(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @date = extract_date(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @source_type = extract_source_type(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @name = extract_name(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -24,6 +24,7 @@ module Aws::RDS
24
24
  @name = extract_name(args, options)
25
25
  @data = options.delete(:data)
26
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
27
28
  end
28
29
 
29
30
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @id = extract_id(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @id = extract_id(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -21,6 +21,7 @@ module Aws::RDS
21
21
  @arn = extract_arn(args, options)
22
22
  @data = options.delete(:data)
23
23
  @client = options.delete(:client) || Client.new(options)
24
+ @waiter_block_warned = false
24
25
  end
25
26
 
26
27
  # @!group Read-Only Attributes
@@ -651,6 +651,155 @@ module Aws::RDS
651
651
  include Aws::Structure
652
652
  end
653
653
 
654
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
655
+ # preview release. It is subject to change.
656
+ #
657
+ # </note>
658
+ #
659
+ # Specifies the settings that control the size and behavior of the
660
+ # connection pool associated with a `DBProxyTargetGroup`.
661
+ #
662
+ # @note When making an API call, you may pass ConnectionPoolConfiguration
663
+ # data as a hash:
664
+ #
665
+ # {
666
+ # max_connections_percent: 1,
667
+ # max_idle_connections_percent: 1,
668
+ # connection_borrow_timeout: 1,
669
+ # session_pinning_filters: ["String"],
670
+ # init_query: "String",
671
+ # }
672
+ #
673
+ # @!attribute [rw] max_connections_percent
674
+ # The maximum size of the connection pool for each target in a target
675
+ # group. For Aurora MySQL, it is expressed as a percentage of the
676
+ # `max_connections` setting for the RDS DB instance or Aurora DB
677
+ # cluster used by the target group.
678
+ #
679
+ # Default: 100
680
+ #
681
+ # Constraints: between 1 and 100
682
+ # @return [Integer]
683
+ #
684
+ # @!attribute [rw] max_idle_connections_percent
685
+ # Controls how actively the proxy closes idle database connections in
686
+ # the connection pool. A high value enables the proxy to leave a high
687
+ # percentage of idle connections open. A low value causes the proxy to
688
+ # close idle client connections and return the underlying database
689
+ # connections to the connection pool. For Aurora MySQL, it is
690
+ # expressed as a percentage of the `max_connections` setting for the
691
+ # RDS DB instance or Aurora DB cluster used by the target group.
692
+ #
693
+ # Default: 50
694
+ #
695
+ # Constraints: between 0 and `MaxConnectionsPercent`
696
+ # @return [Integer]
697
+ #
698
+ # @!attribute [rw] connection_borrow_timeout
699
+ # The number of seconds for a proxy to wait for a connection to become
700
+ # available in the connection pool. Only applies when the proxy has
701
+ # opened its maximum number of connections and all connections are
702
+ # busy with client sessions.
703
+ #
704
+ # Default: 120
705
+ #
706
+ # Constraints: between 1 and 3600, or 0 representing unlimited
707
+ # @return [Integer]
708
+ #
709
+ # @!attribute [rw] session_pinning_filters
710
+ # Each item in the list represents a class of SQL operations that
711
+ # normally cause all later statements in a session using a proxy to be
712
+ # pinned to the same underlying database connection. Including an item
713
+ # in the list exempts that class of SQL operations from the pinning
714
+ # behavior.
715
+ #
716
+ # Default: no session pinning filters
717
+ # @return [Array<String>]
718
+ #
719
+ # @!attribute [rw] init_query
720
+ # One or more SQL statements for the proxy to run when opening each
721
+ # new database connection. Typically used with `SET` statements to
722
+ # make sure that each connection has identical settings such as time
723
+ # zone and character set. For multiple statements, use semicolons as
724
+ # the separator. You can also include multiple variables in a single
725
+ # `SET` statement, such as `SET x=1, y=2`.
726
+ #
727
+ # Default: no initialization query
728
+ # @return [String]
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ConnectionPoolConfiguration AWS API Documentation
731
+ #
732
+ class ConnectionPoolConfiguration < Struct.new(
733
+ :max_connections_percent,
734
+ :max_idle_connections_percent,
735
+ :connection_borrow_timeout,
736
+ :session_pinning_filters,
737
+ :init_query)
738
+ include Aws::Structure
739
+ end
740
+
741
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
742
+ # preview release. It is subject to change.
743
+ #
744
+ # </note>
745
+ #
746
+ # Displays the settings that control the size and behavior of the
747
+ # connection pool associated with a `DBProxyTarget`.
748
+ #
749
+ # @!attribute [rw] max_connections_percent
750
+ # The maximum size of the connection pool for each target in a target
751
+ # group. For Aurora MySQL, it is expressed as a percentage of the
752
+ # `max_connections` setting for the RDS DB instance or Aurora DB
753
+ # cluster used by the target group.
754
+ # @return [Integer]
755
+ #
756
+ # @!attribute [rw] max_idle_connections_percent
757
+ # Controls how actively the proxy closes idle database connections in
758
+ # the connection pool. A high value enables the proxy to leave a high
759
+ # percentage of idle connections open. A low value causes the proxy to
760
+ # close idle client connections and return the underlying database
761
+ # connections to the connection pool. For Aurora MySQL, it is
762
+ # expressed as a percentage of the `max_connections` setting for the
763
+ # RDS DB instance or Aurora DB cluster used by the target group.
764
+ # @return [Integer]
765
+ #
766
+ # @!attribute [rw] connection_borrow_timeout
767
+ # The number of seconds for a proxy to wait for a connection to become
768
+ # available in the connection pool. Only applies when the proxy has
769
+ # opened its maximum number of connections and all connections are
770
+ # busy with client sessions.
771
+ # @return [Integer]
772
+ #
773
+ # @!attribute [rw] session_pinning_filters
774
+ # Each item in the list represents a class of SQL operations that
775
+ # normally cause all later statements in a session using a proxy to be
776
+ # pinned to the same underlying database connection. Including an item
777
+ # in the list exempts that class of SQL operations from the pinning
778
+ # behavior. Currently, the only allowed value is
779
+ # `EXCLUDE_VARIABLE_SETS`.
780
+ # @return [Array<String>]
781
+ #
782
+ # @!attribute [rw] init_query
783
+ # One or more SQL statements for the proxy to run when opening each
784
+ # new database connection. Typically used with `SET` statements to
785
+ # make sure that each connection has identical settings such as time
786
+ # zone and character set. This setting is empty by default. For
787
+ # multiple statements, use semicolons as the separator. You can also
788
+ # include multiple variables in a single `SET` statement, such as `SET
789
+ # x=1, y=2`.
790
+ # @return [String]
791
+ #
792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ConnectionPoolConfigurationInfo AWS API Documentation
793
+ #
794
+ class ConnectionPoolConfigurationInfo < Struct.new(
795
+ :max_connections_percent,
796
+ :max_idle_connections_percent,
797
+ :connection_borrow_timeout,
798
+ :session_pinning_filters,
799
+ :init_query)
800
+ include Aws::Structure
801
+ end
802
+
654
803
  # @note When making an API call, you may pass CopyDBClusterParameterGroupMessage
655
804
  # data as a hash:
656
805
  #
@@ -3674,6 +3823,124 @@ module Aws::RDS
3674
3823
  include Aws::Structure
3675
3824
  end
3676
3825
 
3826
+ # @note When making an API call, you may pass CreateDBProxyRequest
3827
+ # data as a hash:
3828
+ #
3829
+ # {
3830
+ # db_proxy_name: "String", # required
3831
+ # engine_family: "MYSQL", # required, accepts MYSQL
3832
+ # auth: [ # required
3833
+ # {
3834
+ # description: "String",
3835
+ # user_name: "String",
3836
+ # auth_scheme: "SECRETS", # accepts SECRETS
3837
+ # secret_arn: "String",
3838
+ # iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
3839
+ # },
3840
+ # ],
3841
+ # role_arn: "String", # required
3842
+ # vpc_subnet_ids: ["String"], # required
3843
+ # vpc_security_group_ids: ["String"],
3844
+ # require_tls: false,
3845
+ # idle_client_timeout: 1,
3846
+ # debug_logging: false,
3847
+ # tags: [
3848
+ # {
3849
+ # key: "String",
3850
+ # value: "String",
3851
+ # },
3852
+ # ],
3853
+ # }
3854
+ #
3855
+ # @!attribute [rw] db_proxy_name
3856
+ # The identifier for the proxy. This name must be unique for all
3857
+ # proxies owned by your AWS account in the specified AWS Region. An
3858
+ # identifier must begin with a letter and must contain only ASCII
3859
+ # letters, digits, and hyphens; it can't end with a hyphen or contain
3860
+ # two consecutive hyphens.
3861
+ # @return [String]
3862
+ #
3863
+ # @!attribute [rw] engine_family
3864
+ # The kinds of databases that the proxy can connect to. This value
3865
+ # determines which database network protocol the proxy recognizes when
3866
+ # it interprets network traffic to and from the database. Currently,
3867
+ # this value is always `MYSQL`. The engine family applies to both RDS
3868
+ # MySQL and Aurora MySQL.
3869
+ # @return [String]
3870
+ #
3871
+ # @!attribute [rw] auth
3872
+ # The authorization mechanism that the proxy uses.
3873
+ # @return [Array<Types::UserAuthConfig>]
3874
+ #
3875
+ # @!attribute [rw] role_arn
3876
+ # The Amazon Resource Name (ARN) of the IAM role that the proxy uses
3877
+ # to access secrets in AWS Secrets Manager.
3878
+ # @return [String]
3879
+ #
3880
+ # @!attribute [rw] vpc_subnet_ids
3881
+ # One or more VPC subnet IDs to associate with the new proxy.
3882
+ # @return [Array<String>]
3883
+ #
3884
+ # @!attribute [rw] vpc_security_group_ids
3885
+ # One or more VPC security group IDs to associate with the new proxy.
3886
+ # @return [Array<String>]
3887
+ #
3888
+ # @!attribute [rw] require_tls
3889
+ # A Boolean parameter that specifies whether Transport Layer Security
3890
+ # (TLS) encryption is required for connections to the proxy. By
3891
+ # enabling this setting, you can enforce encrypted TLS connections to
3892
+ # the proxy.
3893
+ # @return [Boolean]
3894
+ #
3895
+ # @!attribute [rw] idle_client_timeout
3896
+ # The number of seconds that a connection to the proxy can be inactive
3897
+ # before the proxy disconnects it. You can set this value higher or
3898
+ # lower than the connection timeout limit for the associated database.
3899
+ # @return [Integer]
3900
+ #
3901
+ # @!attribute [rw] debug_logging
3902
+ # Whether the proxy includes detailed information about SQL statements
3903
+ # in its logs. This information helps you to debug issues involving
3904
+ # SQL behavior or the performance and scalability of the proxy
3905
+ # connections. The debug information includes the text of SQL
3906
+ # statements that you submit through the proxy. Thus, only enable this
3907
+ # setting when needed for debugging, and only when you have security
3908
+ # measures in place to safeguard any sensitive information that
3909
+ # appears in the logs.
3910
+ # @return [Boolean]
3911
+ #
3912
+ # @!attribute [rw] tags
3913
+ # An optional set of key-value pairs to associate arbitrary data of
3914
+ # your choosing with the proxy.
3915
+ # @return [Array<Types::Tag>]
3916
+ #
3917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxyRequest AWS API Documentation
3918
+ #
3919
+ class CreateDBProxyRequest < Struct.new(
3920
+ :db_proxy_name,
3921
+ :engine_family,
3922
+ :auth,
3923
+ :role_arn,
3924
+ :vpc_subnet_ids,
3925
+ :vpc_security_group_ids,
3926
+ :require_tls,
3927
+ :idle_client_timeout,
3928
+ :debug_logging,
3929
+ :tags)
3930
+ include Aws::Structure
3931
+ end
3932
+
3933
+ # @!attribute [rw] db_proxy
3934
+ # The `DBProxy` structure corresponding to the new proxy.
3935
+ # @return [Types::DBProxy]
3936
+ #
3937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBProxyResponse AWS API Documentation
3938
+ #
3939
+ class CreateDBProxyResponse < Struct.new(
3940
+ :db_proxy)
3941
+ include Aws::Structure
3942
+ end
3943
+
3677
3944
  # @note When making an API call, you may pass CreateDBSecurityGroupMessage
3678
3945
  # data as a hash:
3679
3946
  #
@@ -6082,6 +6349,237 @@ module Aws::RDS
6082
6349
  include Aws::Structure
6083
6350
  end
6084
6351
 
6352
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
6353
+ # preview release. It is subject to change.
6354
+ #
6355
+ # </note>
6356
+ #
6357
+ # The data structure representing a proxy managed by the RDS Proxy.
6358
+ #
6359
+ # This data type is used as a response element in the
6360
+ # `DescribeDBProxies` action.
6361
+ #
6362
+ # @!attribute [rw] db_proxy_name
6363
+ # The identifier for the proxy. This name must be unique for all
6364
+ # proxies owned by your AWS account in the specified AWS Region.
6365
+ # @return [String]
6366
+ #
6367
+ # @!attribute [rw] db_proxy_arn
6368
+ # The Amazon Resource Name (ARN) for the proxy.
6369
+ # @return [String]
6370
+ #
6371
+ # @!attribute [rw] status
6372
+ # The current status of this proxy. A status of `available` means the
6373
+ # proxy is ready to handle requests. Other values indicate that you
6374
+ # must wait for the proxy to be ready, or take some action to resolve
6375
+ # an issue.
6376
+ # @return [String]
6377
+ #
6378
+ # @!attribute [rw] engine_family
6379
+ # Currently, this value is always `MYSQL`. The engine family applies
6380
+ # to both RDS MySQL and Aurora MySQL.
6381
+ # @return [String]
6382
+ #
6383
+ # @!attribute [rw] vpc_security_group_ids
6384
+ # Provides a list of VPC security groups that the proxy belongs to.
6385
+ # @return [Array<String>]
6386
+ #
6387
+ # @!attribute [rw] vpc_subnet_ids
6388
+ # The EC2 subnet IDs for the proxy.
6389
+ # @return [Array<String>]
6390
+ #
6391
+ # @!attribute [rw] auth
6392
+ # One or more data structures specifying the authorization mechanism
6393
+ # to connect to the associated RDS DB instance or Aurora DB cluster.
6394
+ # @return [Array<Types::UserAuthConfigInfo>]
6395
+ #
6396
+ # @!attribute [rw] role_arn
6397
+ # The Amazon Resource Name (ARN) for the IAM role that the proxy uses
6398
+ # to access Amazon Secrets Manager.
6399
+ # @return [String]
6400
+ #
6401
+ # @!attribute [rw] endpoint
6402
+ # The endpoint that you can use to connect to the proxy. You include
6403
+ # the endpoint value in the connection string for a database client
6404
+ # application.
6405
+ # @return [String]
6406
+ #
6407
+ # @!attribute [rw] require_tls
6408
+ # Indicates whether Transport Layer Security (TLS) encryption is
6409
+ # required for connections to the proxy.
6410
+ # @return [Boolean]
6411
+ #
6412
+ # @!attribute [rw] idle_client_timeout
6413
+ # The number of seconds a connection to the proxy can have no activity
6414
+ # before the proxy drops the client connection. The proxy keeps the
6415
+ # underlying database connection open and puts it back into the
6416
+ # connection pool for reuse by later connection requests.
6417
+ #
6418
+ # Default: 1800 (30 minutes)
6419
+ #
6420
+ # Constraints: 1 to 28,800
6421
+ # @return [Integer]
6422
+ #
6423
+ # @!attribute [rw] debug_logging
6424
+ # Whether the proxy includes detailed information about SQL statements
6425
+ # in its logs. This information helps you to debug issues involving
6426
+ # SQL behavior or the performance and scalability of the proxy
6427
+ # connections. The debug information includes the text of SQL
6428
+ # statements that you submit through the proxy. Thus, only enable this
6429
+ # setting when needed for debugging, and only when you have security
6430
+ # measures in place to safeguard any sensitive information that
6431
+ # appears in the logs.
6432
+ # @return [Boolean]
6433
+ #
6434
+ # @!attribute [rw] created_date
6435
+ # The date and time when the proxy was first created.
6436
+ # @return [Time]
6437
+ #
6438
+ # @!attribute [rw] updated_date
6439
+ # The date and time when the proxy was last updated.
6440
+ # @return [Time]
6441
+ #
6442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxy AWS API Documentation
6443
+ #
6444
+ class DBProxy < Struct.new(
6445
+ :db_proxy_name,
6446
+ :db_proxy_arn,
6447
+ :status,
6448
+ :engine_family,
6449
+ :vpc_security_group_ids,
6450
+ :vpc_subnet_ids,
6451
+ :auth,
6452
+ :role_arn,
6453
+ :endpoint,
6454
+ :require_tls,
6455
+ :idle_client_timeout,
6456
+ :debug_logging,
6457
+ :created_date,
6458
+ :updated_date)
6459
+ include Aws::Structure
6460
+ end
6461
+
6462
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
6463
+ # preview release. It is subject to change.
6464
+ #
6465
+ # </note>
6466
+ #
6467
+ # Contains the details for an RDS Proxy target. It represents an RDS DB
6468
+ # instance or Aurora DB cluster that the proxy can connect to. One or
6469
+ # more targets are associated with an RDS Proxy target group.
6470
+ #
6471
+ # This data type is used as a response element in the
6472
+ # `DescribeDBProxyTargets` action.
6473
+ #
6474
+ # @!attribute [rw] target_arn
6475
+ # The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB
6476
+ # cluster.
6477
+ # @return [String]
6478
+ #
6479
+ # @!attribute [rw] endpoint
6480
+ # The writer endpoint for the RDS DB instance or Aurora DB cluster.
6481
+ # @return [String]
6482
+ #
6483
+ # @!attribute [rw] tracked_cluster_id
6484
+ # The DB cluster identifier when the target represents an Aurora DB
6485
+ # cluster. This field is blank when the target represents an
6486
+ # @return [String]
6487
+ #
6488
+ # @!attribute [rw] rds_resource_id
6489
+ # The identifier representing the target. It can be the instance
6490
+ # identifier for an RDS DB instance, or the cluster identifier for an
6491
+ # Aurora DB cluster.
6492
+ # @return [String]
6493
+ #
6494
+ # @!attribute [rw] port
6495
+ # The port that the RDS Proxy uses to connect to the target RDS DB
6496
+ # instance or Aurora DB cluster.
6497
+ # @return [Integer]
6498
+ #
6499
+ # @!attribute [rw] type
6500
+ # Specifies the kind of database, such as an RDS DB instance or an
6501
+ # Aurora DB cluster, that the target represents.
6502
+ # @return [String]
6503
+ #
6504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxyTarget AWS API Documentation
6505
+ #
6506
+ class DBProxyTarget < Struct.new(
6507
+ :target_arn,
6508
+ :endpoint,
6509
+ :tracked_cluster_id,
6510
+ :rds_resource_id,
6511
+ :port,
6512
+ :type)
6513
+ include Aws::Structure
6514
+ end
6515
+
6516
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
6517
+ # preview release. It is subject to change.
6518
+ #
6519
+ # </note>
6520
+ #
6521
+ # Represents a set of RDS DB instances, Aurora DB clusters, or both that
6522
+ # a proxy can connect to. Currently, each target group is associated
6523
+ # with exactly one RDS DB instance or Aurora DB cluster.
6524
+ #
6525
+ # This data type is used as a response element in the
6526
+ # `DescribeDBProxyTargetGroups` action.
6527
+ #
6528
+ # @!attribute [rw] db_proxy_name
6529
+ # The identifier for the RDS proxy associated with this target group.
6530
+ # @return [String]
6531
+ #
6532
+ # @!attribute [rw] target_group_name
6533
+ # The identifier for the target group. This name must be unique for
6534
+ # all target groups owned by your AWS account in the specified AWS
6535
+ # Region.
6536
+ # @return [String]
6537
+ #
6538
+ # @!attribute [rw] target_group_arn
6539
+ # The Amazon Resource Name (ARN) representing the target group.
6540
+ # @return [String]
6541
+ #
6542
+ # @!attribute [rw] is_default
6543
+ # Whether this target group is the first one used for connection
6544
+ # requests by the associated proxy. Because each proxy is currently
6545
+ # associated with a single target group, currently this setting is
6546
+ # always `true`.
6547
+ # @return [Boolean]
6548
+ #
6549
+ # @!attribute [rw] status
6550
+ # The current status of this target group. A status of `available`
6551
+ # means the target group is correctly associated with a database.
6552
+ # Other values indicate that you must wait for the target group to be
6553
+ # ready, or take some action to resolve an issue.
6554
+ # @return [String]
6555
+ #
6556
+ # @!attribute [rw] connection_pool_config
6557
+ # The settings that determine the size and behavior of the connection
6558
+ # pool for the target group.
6559
+ # @return [Types::ConnectionPoolConfigurationInfo]
6560
+ #
6561
+ # @!attribute [rw] created_date
6562
+ # The date and time when the target group was first created.
6563
+ # @return [Time]
6564
+ #
6565
+ # @!attribute [rw] updated_date
6566
+ # The date and time when the target group was last updated.
6567
+ # @return [Time]
6568
+ #
6569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxyTargetGroup AWS API Documentation
6570
+ #
6571
+ class DBProxyTargetGroup < Struct.new(
6572
+ :db_proxy_name,
6573
+ :target_group_name,
6574
+ :target_group_arn,
6575
+ :is_default,
6576
+ :status,
6577
+ :connection_pool_config,
6578
+ :created_date,
6579
+ :updated_date)
6580
+ include Aws::Structure
6581
+ end
6582
+
6085
6583
  # Contains the details for an Amazon RDS DB security group.
6086
6584
  #
6087
6585
  # This data type is used as a response element in the
@@ -6828,6 +7326,36 @@ module Aws::RDS
6828
7326
  include Aws::Structure
6829
7327
  end
6830
7328
 
7329
+ # @note When making an API call, you may pass DeleteDBProxyRequest
7330
+ # data as a hash:
7331
+ #
7332
+ # {
7333
+ # db_proxy_name: "String", # required
7334
+ # }
7335
+ #
7336
+ # @!attribute [rw] db_proxy_name
7337
+ # The name of the DB proxy to delete.
7338
+ # @return [String]
7339
+ #
7340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxyRequest AWS API Documentation
7341
+ #
7342
+ class DeleteDBProxyRequest < Struct.new(
7343
+ :db_proxy_name)
7344
+ include Aws::Structure
7345
+ end
7346
+
7347
+ # @!attribute [rw] db_proxy
7348
+ # The data structure representing the details of the DB proxy that you
7349
+ # delete.
7350
+ # @return [Types::DBProxy]
7351
+ #
7352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBProxyResponse AWS API Documentation
7353
+ #
7354
+ class DeleteDBProxyResponse < Struct.new(
7355
+ :db_proxy)
7356
+ include Aws::Structure
7357
+ end
7358
+
6831
7359
  # @note When making an API call, you may pass DeleteDBSecurityGroupMessage
6832
7360
  # data as a hash:
6833
7361
  #
@@ -7024,6 +7552,47 @@ module Aws::RDS
7024
7552
  include Aws::Structure
7025
7553
  end
7026
7554
 
7555
+ # @note When making an API call, you may pass DeregisterDBProxyTargetsRequest
7556
+ # data as a hash:
7557
+ #
7558
+ # {
7559
+ # db_proxy_name: "String", # required
7560
+ # target_group_name: "String",
7561
+ # db_instance_identifiers: ["String"],
7562
+ # db_cluster_identifiers: ["String"],
7563
+ # }
7564
+ #
7565
+ # @!attribute [rw] db_proxy_name
7566
+ # The identifier of the `DBProxy` that is associated with the
7567
+ # `DBProxyTargetGroup`.
7568
+ # @return [String]
7569
+ #
7570
+ # @!attribute [rw] target_group_name
7571
+ # The identifier of the `DBProxyTargetGroup`.
7572
+ # @return [String]
7573
+ #
7574
+ # @!attribute [rw] db_instance_identifiers
7575
+ # One or more DB instance identifiers.
7576
+ # @return [Array<String>]
7577
+ #
7578
+ # @!attribute [rw] db_cluster_identifiers
7579
+ # One or more DB cluster identifiers.
7580
+ # @return [Array<String>]
7581
+ #
7582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeregisterDBProxyTargetsRequest AWS API Documentation
7583
+ #
7584
+ class DeregisterDBProxyTargetsRequest < Struct.new(
7585
+ :db_proxy_name,
7586
+ :target_group_name,
7587
+ :db_instance_identifiers,
7588
+ :db_cluster_identifiers)
7589
+ include Aws::Structure
7590
+ end
7591
+
7592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeregisterDBProxyTargetsResponse AWS API Documentation
7593
+ #
7594
+ class DeregisterDBProxyTargetsResponse < Aws::EmptyStructure; end
7595
+
7027
7596
  # @api private
7028
7597
  #
7029
7598
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeAccountAttributesMessage AWS API Documentation
@@ -8040,170 +8609,389 @@ module Aws::RDS
8040
8609
  #
8041
8610
  # @!attribute [rw] max_records
8042
8611
  # The maximum number of records to include in the response. If more
8043
- # records exist than the specified MaxRecords value, a pagination
8044
- # token called a marker is included in the response so you can
8045
- # retrieve the remaining results.
8046
- # @return [Integer]
8612
+ # records exist than the specified MaxRecords value, a pagination
8613
+ # token called a marker is included in the response so you can
8614
+ # retrieve the remaining results.
8615
+ # @return [Integer]
8616
+ #
8617
+ # @!attribute [rw] marker
8618
+ # The pagination token provided in the previous request. If this
8619
+ # parameter is specified the response includes only records beyond the
8620
+ # marker, up to MaxRecords.
8621
+ # @return [String]
8622
+ #
8623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFilesMessage AWS API Documentation
8624
+ #
8625
+ class DescribeDBLogFilesMessage < Struct.new(
8626
+ :db_instance_identifier,
8627
+ :filename_contains,
8628
+ :file_last_written,
8629
+ :file_size,
8630
+ :filters,
8631
+ :max_records,
8632
+ :marker)
8633
+ include Aws::Structure
8634
+ end
8635
+
8636
+ # The response from a call to `DescribeDBLogFiles`.
8637
+ #
8638
+ # @!attribute [rw] describe_db_log_files
8639
+ # The DB log files returned.
8640
+ # @return [Array<Types::DescribeDBLogFilesDetails>]
8641
+ #
8642
+ # @!attribute [rw] marker
8643
+ # A pagination token that can be used in a subsequent
8644
+ # DescribeDBLogFiles request.
8645
+ # @return [String]
8646
+ #
8647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFilesResponse AWS API Documentation
8648
+ #
8649
+ class DescribeDBLogFilesResponse < Struct.new(
8650
+ :describe_db_log_files,
8651
+ :marker)
8652
+ include Aws::Structure
8653
+ end
8654
+
8655
+ # @note When making an API call, you may pass DescribeDBParameterGroupsMessage
8656
+ # data as a hash:
8657
+ #
8658
+ # {
8659
+ # db_parameter_group_name: "String",
8660
+ # filters: [
8661
+ # {
8662
+ # name: "String", # required
8663
+ # values: ["String"], # required
8664
+ # },
8665
+ # ],
8666
+ # max_records: 1,
8667
+ # marker: "String",
8668
+ # }
8669
+ #
8670
+ # @!attribute [rw] db_parameter_group_name
8671
+ # The name of a specific DB parameter group to return details for.
8672
+ #
8673
+ # Constraints:
8674
+ #
8675
+ # * If supplied, must match the name of an existing
8676
+ # DBClusterParameterGroup.
8677
+ #
8678
+ # ^
8679
+ # @return [String]
8680
+ #
8681
+ # @!attribute [rw] filters
8682
+ # This parameter isn't currently supported.
8683
+ # @return [Array<Types::Filter>]
8684
+ #
8685
+ # @!attribute [rw] max_records
8686
+ # The maximum number of records to include in the response. If more
8687
+ # records exist than the specified `MaxRecords` value, a pagination
8688
+ # token called a marker is included in the response so that you can
8689
+ # retrieve the remaining results.
8690
+ #
8691
+ # Default: 100
8692
+ #
8693
+ # Constraints: Minimum 20, maximum 100.
8694
+ # @return [Integer]
8695
+ #
8696
+ # @!attribute [rw] marker
8697
+ # An optional pagination token provided by a previous
8698
+ # `DescribeDBParameterGroups` request. If this parameter is specified,
8699
+ # the response includes only records beyond the marker, up to the
8700
+ # value specified by `MaxRecords`.
8701
+ # @return [String]
8702
+ #
8703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameterGroupsMessage AWS API Documentation
8704
+ #
8705
+ class DescribeDBParameterGroupsMessage < Struct.new(
8706
+ :db_parameter_group_name,
8707
+ :filters,
8708
+ :max_records,
8709
+ :marker)
8710
+ include Aws::Structure
8711
+ end
8712
+
8713
+ # @note When making an API call, you may pass DescribeDBParametersMessage
8714
+ # data as a hash:
8715
+ #
8716
+ # {
8717
+ # db_parameter_group_name: "String", # required
8718
+ # source: "String",
8719
+ # filters: [
8720
+ # {
8721
+ # name: "String", # required
8722
+ # values: ["String"], # required
8723
+ # },
8724
+ # ],
8725
+ # max_records: 1,
8726
+ # marker: "String",
8727
+ # }
8728
+ #
8729
+ # @!attribute [rw] db_parameter_group_name
8730
+ # The name of a specific DB parameter group to return details for.
8731
+ #
8732
+ # Constraints:
8733
+ #
8734
+ # * If supplied, must match the name of an existing DBParameterGroup.
8735
+ #
8736
+ # ^
8737
+ # @return [String]
8738
+ #
8739
+ # @!attribute [rw] source
8740
+ # The parameter types to return.
8741
+ #
8742
+ # Default: All parameter types returned
8743
+ #
8744
+ # Valid Values: `user | system | engine-default`
8745
+ # @return [String]
8746
+ #
8747
+ # @!attribute [rw] filters
8748
+ # This parameter isn't currently supported.
8749
+ # @return [Array<Types::Filter>]
8750
+ #
8751
+ # @!attribute [rw] max_records
8752
+ # The maximum number of records to include in the response. If more
8753
+ # records exist than the specified `MaxRecords` value, a pagination
8754
+ # token called a marker is included in the response so that you can
8755
+ # retrieve the remaining results.
8756
+ #
8757
+ # Default: 100
8758
+ #
8759
+ # Constraints: Minimum 20, maximum 100.
8760
+ # @return [Integer]
8761
+ #
8762
+ # @!attribute [rw] marker
8763
+ # An optional pagination token provided by a previous
8764
+ # `DescribeDBParameters` request. If this parameter is specified, the
8765
+ # response includes only records beyond the marker, up to the value
8766
+ # specified by `MaxRecords`.
8767
+ # @return [String]
8768
+ #
8769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParametersMessage AWS API Documentation
8770
+ #
8771
+ class DescribeDBParametersMessage < Struct.new(
8772
+ :db_parameter_group_name,
8773
+ :source,
8774
+ :filters,
8775
+ :max_records,
8776
+ :marker)
8777
+ include Aws::Structure
8778
+ end
8779
+
8780
+ # @note When making an API call, you may pass DescribeDBProxiesRequest
8781
+ # data as a hash:
8782
+ #
8783
+ # {
8784
+ # db_proxy_name: "String",
8785
+ # filters: [
8786
+ # {
8787
+ # name: "String", # required
8788
+ # values: ["String"], # required
8789
+ # },
8790
+ # ],
8791
+ # marker: "String",
8792
+ # max_records: 1,
8793
+ # }
8794
+ #
8795
+ # @!attribute [rw] db_proxy_name
8796
+ # The name of the DB proxy.
8797
+ # @return [String]
8798
+ #
8799
+ # @!attribute [rw] filters
8800
+ # This parameter is not currently supported.
8801
+ # @return [Array<Types::Filter>]
8802
+ #
8803
+ # @!attribute [rw] marker
8804
+ # An optional pagination token provided by a previous request. If this
8805
+ # parameter is specified, the response includes only records beyond
8806
+ # the marker, up to the value specified by `MaxRecords`.
8807
+ # @return [String]
8808
+ #
8809
+ # @!attribute [rw] max_records
8810
+ # The maximum number of records to include in the response. If more
8811
+ # records exist than the specified `MaxRecords` value, a pagination
8812
+ # token called a marker is included in the response so that the
8813
+ # remaining results can be retrieved.
8047
8814
  #
8048
- # @!attribute [rw] marker
8049
- # The pagination token provided in the previous request. If this
8050
- # parameter is specified the response includes only records beyond the
8051
- # marker, up to MaxRecords.
8052
- # @return [String]
8815
+ # Default: 100
8053
8816
  #
8054
- # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFilesMessage AWS API Documentation
8817
+ # Constraints: Minimum 20, maximum 100.
8818
+ # @return [Integer]
8055
8819
  #
8056
- class DescribeDBLogFilesMessage < Struct.new(
8057
- :db_instance_identifier,
8058
- :filename_contains,
8059
- :file_last_written,
8060
- :file_size,
8820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxiesRequest AWS API Documentation
8821
+ #
8822
+ class DescribeDBProxiesRequest < Struct.new(
8823
+ :db_proxy_name,
8061
8824
  :filters,
8062
- :max_records,
8063
- :marker)
8825
+ :marker,
8826
+ :max_records)
8064
8827
  include Aws::Structure
8065
8828
  end
8066
8829
 
8067
- # The response from a call to `DescribeDBLogFiles`.
8068
- #
8069
- # @!attribute [rw] describe_db_log_files
8070
- # The DB log files returned.
8071
- # @return [Array<Types::DescribeDBLogFilesDetails>]
8830
+ # @!attribute [rw] db_proxies
8831
+ # A return value representing an arbitrary number of `DBProxy` data
8832
+ # structures.
8833
+ # @return [Array<Types::DBProxy>]
8072
8834
  #
8073
8835
  # @!attribute [rw] marker
8074
- # A pagination token that can be used in a subsequent
8075
- # DescribeDBLogFiles request.
8836
+ # An optional pagination token provided by a previous request. If this
8837
+ # parameter is specified, the response includes only records beyond
8838
+ # the marker, up to the value specified by `MaxRecords`.
8076
8839
  # @return [String]
8077
8840
  #
8078
- # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBLogFilesResponse AWS API Documentation
8841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxiesResponse AWS API Documentation
8079
8842
  #
8080
- class DescribeDBLogFilesResponse < Struct.new(
8081
- :describe_db_log_files,
8843
+ class DescribeDBProxiesResponse < Struct.new(
8844
+ :db_proxies,
8082
8845
  :marker)
8083
8846
  include Aws::Structure
8084
8847
  end
8085
8848
 
8086
- # @note When making an API call, you may pass DescribeDBParameterGroupsMessage
8849
+ # @note When making an API call, you may pass DescribeDBProxyTargetGroupsRequest
8087
8850
  # data as a hash:
8088
8851
  #
8089
8852
  # {
8090
- # db_parameter_group_name: "String",
8853
+ # db_proxy_name: "String", # required
8854
+ # target_group_name: "String",
8091
8855
  # filters: [
8092
8856
  # {
8093
8857
  # name: "String", # required
8094
8858
  # values: ["String"], # required
8095
8859
  # },
8096
8860
  # ],
8097
- # max_records: 1,
8098
8861
  # marker: "String",
8862
+ # max_records: 1,
8099
8863
  # }
8100
8864
  #
8101
- # @!attribute [rw] db_parameter_group_name
8102
- # The name of a specific DB parameter group to return details for.
8103
- #
8104
- # Constraints:
8105
- #
8106
- # * If supplied, must match the name of an existing
8107
- # DBClusterParameterGroup.
8865
+ # @!attribute [rw] db_proxy_name
8866
+ # The identifier of the `DBProxy` associated with the target group.
8867
+ # @return [String]
8108
8868
  #
8109
- # ^
8869
+ # @!attribute [rw] target_group_name
8870
+ # The identifier of the `DBProxyTargetGroup` to describe.
8110
8871
  # @return [String]
8111
8872
  #
8112
8873
  # @!attribute [rw] filters
8113
- # This parameter isn't currently supported.
8874
+ # This parameter is not currently supported.
8114
8875
  # @return [Array<Types::Filter>]
8115
8876
  #
8877
+ # @!attribute [rw] marker
8878
+ # An optional pagination token provided by a previous request. If this
8879
+ # parameter is specified, the response includes only records beyond
8880
+ # the marker, up to the value specified by `MaxRecords`.
8881
+ # @return [String]
8882
+ #
8116
8883
  # @!attribute [rw] max_records
8117
8884
  # The maximum number of records to include in the response. If more
8118
8885
  # records exist than the specified `MaxRecords` value, a pagination
8119
- # token called a marker is included in the response so that you can
8120
- # retrieve the remaining results.
8886
+ # token called a marker is included in the response so that the
8887
+ # remaining results can be retrieved.
8121
8888
  #
8122
8889
  # Default: 100
8123
8890
  #
8124
8891
  # Constraints: Minimum 20, maximum 100.
8125
8892
  # @return [Integer]
8126
8893
  #
8894
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetGroupsRequest AWS API Documentation
8895
+ #
8896
+ class DescribeDBProxyTargetGroupsRequest < Struct.new(
8897
+ :db_proxy_name,
8898
+ :target_group_name,
8899
+ :filters,
8900
+ :marker,
8901
+ :max_records)
8902
+ include Aws::Structure
8903
+ end
8904
+
8905
+ # @!attribute [rw] target_groups
8906
+ # An arbitrary number of `DBProxyTargetGroup` objects, containing
8907
+ # details of the corresponding target groups.
8908
+ # @return [Array<Types::DBProxyTargetGroup>]
8909
+ #
8127
8910
  # @!attribute [rw] marker
8128
- # An optional pagination token provided by a previous
8129
- # `DescribeDBParameterGroups` request. If this parameter is specified,
8130
- # the response includes only records beyond the marker, up to the
8131
- # value specified by `MaxRecords`.
8911
+ # An optional pagination token provided by a previous request. If this
8912
+ # parameter is specified, the response includes only records beyond
8913
+ # the marker, up to the value specified by `MaxRecords`.
8132
8914
  # @return [String]
8133
8915
  #
8134
- # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParameterGroupsMessage AWS API Documentation
8916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetGroupsResponse AWS API Documentation
8135
8917
  #
8136
- class DescribeDBParameterGroupsMessage < Struct.new(
8137
- :db_parameter_group_name,
8138
- :filters,
8139
- :max_records,
8918
+ class DescribeDBProxyTargetGroupsResponse < Struct.new(
8919
+ :target_groups,
8140
8920
  :marker)
8141
8921
  include Aws::Structure
8142
8922
  end
8143
8923
 
8144
- # @note When making an API call, you may pass DescribeDBParametersMessage
8924
+ # @note When making an API call, you may pass DescribeDBProxyTargetsRequest
8145
8925
  # data as a hash:
8146
8926
  #
8147
8927
  # {
8148
- # db_parameter_group_name: "String", # required
8149
- # source: "String",
8928
+ # db_proxy_name: "String", # required
8929
+ # target_group_name: "String",
8150
8930
  # filters: [
8151
8931
  # {
8152
8932
  # name: "String", # required
8153
8933
  # values: ["String"], # required
8154
8934
  # },
8155
8935
  # ],
8156
- # max_records: 1,
8157
8936
  # marker: "String",
8937
+ # max_records: 1,
8158
8938
  # }
8159
8939
  #
8160
- # @!attribute [rw] db_parameter_group_name
8161
- # The name of a specific DB parameter group to return details for.
8162
- #
8163
- # Constraints:
8164
- #
8165
- # * If supplied, must match the name of an existing DBParameterGroup.
8166
- #
8167
- # ^
8940
+ # @!attribute [rw] db_proxy_name
8941
+ # The identifier of the `DBProxyTarget` to describe.
8168
8942
  # @return [String]
8169
8943
  #
8170
- # @!attribute [rw] source
8171
- # The parameter types to return.
8172
- #
8173
- # Default: All parameter types returned
8174
- #
8175
- # Valid Values: `user | system | engine-default`
8944
+ # @!attribute [rw] target_group_name
8945
+ # The identifier of the `DBProxyTargetGroup` to describe.
8176
8946
  # @return [String]
8177
8947
  #
8178
8948
  # @!attribute [rw] filters
8179
- # This parameter isn't currently supported.
8949
+ # This parameter is not currently supported.
8180
8950
  # @return [Array<Types::Filter>]
8181
8951
  #
8952
+ # @!attribute [rw] marker
8953
+ # An optional pagination token provided by a previous request. If this
8954
+ # parameter is specified, the response includes only records beyond
8955
+ # the marker, up to the value specified by `MaxRecords`.
8956
+ # @return [String]
8957
+ #
8182
8958
  # @!attribute [rw] max_records
8183
8959
  # The maximum number of records to include in the response. If more
8184
8960
  # records exist than the specified `MaxRecords` value, a pagination
8185
- # token called a marker is included in the response so that you can
8186
- # retrieve the remaining results.
8961
+ # token called a marker is included in the response so that the
8962
+ # remaining results can be retrieved.
8187
8963
  #
8188
8964
  # Default: 100
8189
8965
  #
8190
8966
  # Constraints: Minimum 20, maximum 100.
8191
8967
  # @return [Integer]
8192
8968
  #
8969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetsRequest AWS API Documentation
8970
+ #
8971
+ class DescribeDBProxyTargetsRequest < Struct.new(
8972
+ :db_proxy_name,
8973
+ :target_group_name,
8974
+ :filters,
8975
+ :marker,
8976
+ :max_records)
8977
+ include Aws::Structure
8978
+ end
8979
+
8980
+ # @!attribute [rw] targets
8981
+ # An arbitrary number of `DBProxyTarget` objects, containing details
8982
+ # of the corresponding targets.
8983
+ # @return [Array<Types::DBProxyTarget>]
8984
+ #
8193
8985
  # @!attribute [rw] marker
8194
- # An optional pagination token provided by a previous
8195
- # `DescribeDBParameters` request. If this parameter is specified, the
8196
- # response includes only records beyond the marker, up to the value
8197
- # specified by `MaxRecords`.
8986
+ # An optional pagination token provided by a previous request. If this
8987
+ # parameter is specified, the response includes only records beyond
8988
+ # the marker, up to the value specified by `MaxRecords`.
8198
8989
  # @return [String]
8199
8990
  #
8200
- # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBParametersMessage AWS API Documentation
8991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBProxyTargetsResponse AWS API Documentation
8201
8992
  #
8202
- class DescribeDBParametersMessage < Struct.new(
8203
- :db_parameter_group_name,
8204
- :source,
8205
- :filters,
8206
- :max_records,
8993
+ class DescribeDBProxyTargetsResponse < Struct.new(
8994
+ :targets,
8207
8995
  :marker)
8208
8996
  include Aws::Structure
8209
8997
  end
@@ -11766,6 +12554,157 @@ module Aws::RDS
11766
12554
  include Aws::Structure
11767
12555
  end
11768
12556
 
12557
+ # @note When making an API call, you may pass ModifyDBProxyRequest
12558
+ # data as a hash:
12559
+ #
12560
+ # {
12561
+ # db_proxy_name: "String", # required
12562
+ # new_db_proxy_name: "String",
12563
+ # auth: [
12564
+ # {
12565
+ # description: "String",
12566
+ # user_name: "String",
12567
+ # auth_scheme: "SECRETS", # accepts SECRETS
12568
+ # secret_arn: "String",
12569
+ # iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
12570
+ # },
12571
+ # ],
12572
+ # require_tls: false,
12573
+ # idle_client_timeout: 1,
12574
+ # debug_logging: false,
12575
+ # role_arn: "String",
12576
+ # security_groups: ["String"],
12577
+ # }
12578
+ #
12579
+ # @!attribute [rw] db_proxy_name
12580
+ # The identifier for the `DBProxy` to modify.
12581
+ # @return [String]
12582
+ #
12583
+ # @!attribute [rw] new_db_proxy_name
12584
+ # The new identifier for the `DBProxy`. An identifier must begin with
12585
+ # a letter and must contain only ASCII letters, digits, and hyphens;
12586
+ # it can't end with a hyphen or contain two consecutive hyphens.
12587
+ # @return [String]
12588
+ #
12589
+ # @!attribute [rw] auth
12590
+ # The new authentication settings for the `DBProxy`.
12591
+ # @return [Array<Types::UserAuthConfig>]
12592
+ #
12593
+ # @!attribute [rw] require_tls
12594
+ # Whether Transport Layer Security (TLS) encryption is required for
12595
+ # connections to the proxy. By enabling this setting, you can enforce
12596
+ # encrypted TLS connections to the proxy, even if the associated
12597
+ # database doesn't use TLS.
12598
+ # @return [Boolean]
12599
+ #
12600
+ # @!attribute [rw] idle_client_timeout
12601
+ # The number of seconds that a connection to the proxy can be inactive
12602
+ # before the proxy disconnects it. You can set this value higher or
12603
+ # lower than the connection timeout limit for the associated database.
12604
+ # @return [Integer]
12605
+ #
12606
+ # @!attribute [rw] debug_logging
12607
+ # Whether the proxy includes detailed information about SQL statements
12608
+ # in its logs. This information helps you to debug issues involving
12609
+ # SQL behavior or the performance and scalability of the proxy
12610
+ # connections. The debug information includes the text of SQL
12611
+ # statements that you submit through the proxy. Thus, only enable this
12612
+ # setting when needed for debugging, and only when you have security
12613
+ # measures in place to safeguard any sensitive information that
12614
+ # appears in the logs.
12615
+ # @return [Boolean]
12616
+ #
12617
+ # @!attribute [rw] role_arn
12618
+ # The Amazon Resource Name (ARN) of the IAM role that the proxy uses
12619
+ # to access secrets in AWS Secrets Manager.
12620
+ # @return [String]
12621
+ #
12622
+ # @!attribute [rw] security_groups
12623
+ # The new list of security groups for the `DBProxy`.
12624
+ # @return [Array<String>]
12625
+ #
12626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyRequest AWS API Documentation
12627
+ #
12628
+ class ModifyDBProxyRequest < Struct.new(
12629
+ :db_proxy_name,
12630
+ :new_db_proxy_name,
12631
+ :auth,
12632
+ :require_tls,
12633
+ :idle_client_timeout,
12634
+ :debug_logging,
12635
+ :role_arn,
12636
+ :security_groups)
12637
+ include Aws::Structure
12638
+ end
12639
+
12640
+ # @!attribute [rw] db_proxy
12641
+ # The `DBProxy` object representing the new settings for the proxy.
12642
+ # @return [Types::DBProxy]
12643
+ #
12644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyResponse AWS API Documentation
12645
+ #
12646
+ class ModifyDBProxyResponse < Struct.new(
12647
+ :db_proxy)
12648
+ include Aws::Structure
12649
+ end
12650
+
12651
+ # @note When making an API call, you may pass ModifyDBProxyTargetGroupRequest
12652
+ # data as a hash:
12653
+ #
12654
+ # {
12655
+ # target_group_name: "String", # required
12656
+ # db_proxy_name: "String", # required
12657
+ # connection_pool_config: {
12658
+ # max_connections_percent: 1,
12659
+ # max_idle_connections_percent: 1,
12660
+ # connection_borrow_timeout: 1,
12661
+ # session_pinning_filters: ["String"],
12662
+ # init_query: "String",
12663
+ # },
12664
+ # new_name: "String",
12665
+ # }
12666
+ #
12667
+ # @!attribute [rw] target_group_name
12668
+ # The name of the new target group to assign to the proxy.
12669
+ # @return [String]
12670
+ #
12671
+ # @!attribute [rw] db_proxy_name
12672
+ # The name of the new proxy to which to assign the target group.
12673
+ # @return [String]
12674
+ #
12675
+ # @!attribute [rw] connection_pool_config
12676
+ # The settings that determine the size and behavior of the connection
12677
+ # pool for the target group.
12678
+ # @return [Types::ConnectionPoolConfiguration]
12679
+ #
12680
+ # @!attribute [rw] new_name
12681
+ # The new name for the modified `DBProxyTarget`. An identifier must
12682
+ # begin with a letter and must contain only ASCII letters, digits, and
12683
+ # hyphens; it can't end with a hyphen or contain two consecutive
12684
+ # hyphens.
12685
+ # @return [String]
12686
+ #
12687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyTargetGroupRequest AWS API Documentation
12688
+ #
12689
+ class ModifyDBProxyTargetGroupRequest < Struct.new(
12690
+ :target_group_name,
12691
+ :db_proxy_name,
12692
+ :connection_pool_config,
12693
+ :new_name)
12694
+ include Aws::Structure
12695
+ end
12696
+
12697
+ # @!attribute [rw] db_proxy_target_group
12698
+ # The settings of the modified `DBProxyTarget`.
12699
+ # @return [Types::DBProxyTargetGroup]
12700
+ #
12701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyTargetGroupResponse AWS API Documentation
12702
+ #
12703
+ class ModifyDBProxyTargetGroupResponse < Struct.new(
12704
+ :db_proxy_target_group)
12705
+ include Aws::Structure
12706
+ end
12707
+
11769
12708
  # @note When making an API call, you may pass ModifyDBSnapshotAttributeMessage
11770
12709
  # data as a hash:
11771
12710
  #
@@ -13443,6 +14382,55 @@ module Aws::RDS
13443
14382
  include Aws::Structure
13444
14383
  end
13445
14384
 
14385
+ # @note When making an API call, you may pass RegisterDBProxyTargetsRequest
14386
+ # data as a hash:
14387
+ #
14388
+ # {
14389
+ # db_proxy_name: "String", # required
14390
+ # target_group_name: "String",
14391
+ # db_instance_identifiers: ["String"],
14392
+ # db_cluster_identifiers: ["String"],
14393
+ # }
14394
+ #
14395
+ # @!attribute [rw] db_proxy_name
14396
+ # The identifier of the `DBProxy` that is associated with the
14397
+ # `DBProxyTargetGroup`.
14398
+ # @return [String]
14399
+ #
14400
+ # @!attribute [rw] target_group_name
14401
+ # The identifier of the `DBProxyTargetGroup`.
14402
+ # @return [String]
14403
+ #
14404
+ # @!attribute [rw] db_instance_identifiers
14405
+ # One or more DB instance identifiers.
14406
+ # @return [Array<String>]
14407
+ #
14408
+ # @!attribute [rw] db_cluster_identifiers
14409
+ # One or more DB cluster identifiers.
14410
+ # @return [Array<String>]
14411
+ #
14412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RegisterDBProxyTargetsRequest AWS API Documentation
14413
+ #
14414
+ class RegisterDBProxyTargetsRequest < Struct.new(
14415
+ :db_proxy_name,
14416
+ :target_group_name,
14417
+ :db_instance_identifiers,
14418
+ :db_cluster_identifiers)
14419
+ include Aws::Structure
14420
+ end
14421
+
14422
+ # @!attribute [rw] db_proxy_targets
14423
+ # One or more `DBProxyTarget` objects that are created when you
14424
+ # register targets with a target group.
14425
+ # @return [Array<Types::DBProxyTarget>]
14426
+ #
14427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RegisterDBProxyTargetsResponse AWS API Documentation
14428
+ #
14429
+ class RegisterDBProxyTargetsResponse < Struct.new(
14430
+ :db_proxy_targets)
14431
+ include Aws::Structure
14432
+ end
14433
+
13446
14434
  # @note When making an API call, you may pass RemoveFromGlobalClusterMessage
13447
14435
  # data as a hash:
13448
14436
  #
@@ -16920,6 +17908,105 @@ module Aws::RDS
16920
17908
  include Aws::Structure
16921
17909
  end
16922
17910
 
17911
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
17912
+ # preview release. It is subject to change.
17913
+ #
17914
+ # </note>
17915
+ #
17916
+ # Specifies the details of authentication used by a proxy to log in as a
17917
+ # specific database user.
17918
+ #
17919
+ # @note When making an API call, you may pass UserAuthConfig
17920
+ # data as a hash:
17921
+ #
17922
+ # {
17923
+ # description: "String",
17924
+ # user_name: "String",
17925
+ # auth_scheme: "SECRETS", # accepts SECRETS
17926
+ # secret_arn: "String",
17927
+ # iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
17928
+ # }
17929
+ #
17930
+ # @!attribute [rw] description
17931
+ # A user-specified description about the authentication used by a
17932
+ # proxy to log in as a specific database user.
17933
+ # @return [String]
17934
+ #
17935
+ # @!attribute [rw] user_name
17936
+ # The name of the database user to which the proxy connects.
17937
+ # @return [String]
17938
+ #
17939
+ # @!attribute [rw] auth_scheme
17940
+ # The type of authentication that the proxy uses for connections from
17941
+ # the proxy to the underlying database.
17942
+ # @return [String]
17943
+ #
17944
+ # @!attribute [rw] secret_arn
17945
+ # The Amazon Resource Name (ARN) representing the secret that the
17946
+ # proxy uses to authenticate to the RDS DB instance or Aurora DB
17947
+ # cluster. These secrets are stored within Amazon Secrets Manager.
17948
+ # @return [String]
17949
+ #
17950
+ # @!attribute [rw] iam_auth
17951
+ # Whether to require or disallow AWS Identity and Access Management
17952
+ # (IAM) authentication for connections to the proxy.
17953
+ # @return [String]
17954
+ #
17955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/UserAuthConfig AWS API Documentation
17956
+ #
17957
+ class UserAuthConfig < Struct.new(
17958
+ :description,
17959
+ :user_name,
17960
+ :auth_scheme,
17961
+ :secret_arn,
17962
+ :iam_auth)
17963
+ include Aws::Structure
17964
+ end
17965
+
17966
+ # <note markdown="1"> This is prerelease documentation for the RDS Database Proxy feature in
17967
+ # preview release. It is subject to change.
17968
+ #
17969
+ # </note>
17970
+ #
17971
+ # Returns the details of authentication used by a proxy to log in as a
17972
+ # specific database user.
17973
+ #
17974
+ # @!attribute [rw] description
17975
+ # A user-specified description about the authentication used by a
17976
+ # proxy to log in as a specific database user.
17977
+ # @return [String]
17978
+ #
17979
+ # @!attribute [rw] user_name
17980
+ # The name of the database user to which the proxy connects.
17981
+ # @return [String]
17982
+ #
17983
+ # @!attribute [rw] auth_scheme
17984
+ # The type of authentication that the proxy uses for connections from
17985
+ # the proxy to the underlying database.
17986
+ # @return [String]
17987
+ #
17988
+ # @!attribute [rw] secret_arn
17989
+ # The Amazon Resource Name (ARN) representing the secret that the
17990
+ # proxy uses to authenticate to the RDS DB instance or Aurora DB
17991
+ # cluster. These secrets are stored within Amazon Secrets Manager.
17992
+ # @return [String]
17993
+ #
17994
+ # @!attribute [rw] iam_auth
17995
+ # Whether to require or disallow AWS Identity and Access Management
17996
+ # (IAM) authentication for connections to the proxy.
17997
+ # @return [String]
17998
+ #
17999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/UserAuthConfigInfo AWS API Documentation
18000
+ #
18001
+ class UserAuthConfigInfo < Struct.new(
18002
+ :description,
18003
+ :user_name,
18004
+ :auth_scheme,
18005
+ :secret_arn,
18006
+ :iam_auth)
18007
+ include Aws::Structure
18008
+ end
18009
+
16923
18010
  # Information about valid modifications that you can make to your DB
16924
18011
  # instance. Contains the result of a successful call to the
16925
18012
  # `DescribeValidDBInstanceModifications` action. You can use this