aws-sdk-rds 1.209.0 → 1.210.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 +325 -1
- data/lib/aws-sdk-rds/client_api.rb +172 -0
- data/lib/aws-sdk-rds/endpoints.rb +28 -0
- data/lib/aws-sdk-rds/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-rds/types.rb +758 -0
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -1112,6 +1112,25 @@ module Aws::RDS
|
|
1112
1112
|
include Aws::Structure
|
1113
1113
|
end
|
1114
1114
|
|
1115
|
+
# The additional attributes of `RecommendedAction` data type.
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] key
|
1118
|
+
# The key of `ContextAttribute`.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] value
|
1122
|
+
# The value of `ContextAttribute`.
|
1123
|
+
# @return [String]
|
1124
|
+
#
|
1125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ContextAttribute AWS API Documentation
|
1126
|
+
#
|
1127
|
+
class ContextAttribute < Struct.new(
|
1128
|
+
:key,
|
1129
|
+
:value)
|
1130
|
+
SENSITIVE = []
|
1131
|
+
include Aws::Structure
|
1132
|
+
end
|
1133
|
+
|
1115
1134
|
# @!attribute [rw] source_db_cluster_parameter_group_identifier
|
1116
1135
|
# The identifier or Amazon Resource Name (ARN) for the source DB
|
1117
1136
|
# cluster parameter group. For information about creating an ARN, see
|
@@ -9699,6 +9718,198 @@ module Aws::RDS
|
|
9699
9718
|
#
|
9700
9719
|
class DBProxyTargetNotFoundFault < Aws::EmptyStructure; end
|
9701
9720
|
|
9721
|
+
# The recommendation for your DB instances, DB clusters, and DB
|
9722
|
+
# parameter groups.
|
9723
|
+
#
|
9724
|
+
# @!attribute [rw] recommendation_id
|
9725
|
+
# The unique identifier of the recommendation.
|
9726
|
+
# @return [String]
|
9727
|
+
#
|
9728
|
+
# @!attribute [rw] type_id
|
9729
|
+
# A value that indicates the type of recommendation. This value
|
9730
|
+
# determines how the description is rendered.
|
9731
|
+
# @return [String]
|
9732
|
+
#
|
9733
|
+
# @!attribute [rw] severity
|
9734
|
+
# The severity level of the recommendation. The severity level can
|
9735
|
+
# help you decide the urgency with which to address the
|
9736
|
+
# recommendation.
|
9737
|
+
#
|
9738
|
+
# Valid values:
|
9739
|
+
#
|
9740
|
+
# * `high`
|
9741
|
+
#
|
9742
|
+
# * `medium`
|
9743
|
+
#
|
9744
|
+
# * `low`
|
9745
|
+
#
|
9746
|
+
# * `informational`
|
9747
|
+
# @return [String]
|
9748
|
+
#
|
9749
|
+
# @!attribute [rw] resource_arn
|
9750
|
+
# The Amazon Resource Name (ARN) of the RDS resource associated with
|
9751
|
+
# the recommendation.
|
9752
|
+
# @return [String]
|
9753
|
+
#
|
9754
|
+
# @!attribute [rw] status
|
9755
|
+
# The current status of the recommendation.
|
9756
|
+
#
|
9757
|
+
# Valid values:
|
9758
|
+
#
|
9759
|
+
# * `active` - The recommendations which are ready for you to apply.
|
9760
|
+
#
|
9761
|
+
# * `pending` - The applied or scheduled recommendations which are in
|
9762
|
+
# progress.
|
9763
|
+
#
|
9764
|
+
# * `resolved` - The recommendations which are completed.
|
9765
|
+
#
|
9766
|
+
# * `dismissed` - The recommendations that you dismissed.
|
9767
|
+
# @return [String]
|
9768
|
+
#
|
9769
|
+
# @!attribute [rw] created_time
|
9770
|
+
# The time when the recommendation was created. For example,
|
9771
|
+
# `2023-09-28T01:13:53.931000+00:00`.
|
9772
|
+
# @return [Time]
|
9773
|
+
#
|
9774
|
+
# @!attribute [rw] updated_time
|
9775
|
+
# The time when the recommendation was last updated.
|
9776
|
+
# @return [Time]
|
9777
|
+
#
|
9778
|
+
# @!attribute [rw] detection
|
9779
|
+
# A short description of the issue identified for this recommendation.
|
9780
|
+
# The description might contain markdown.
|
9781
|
+
# @return [String]
|
9782
|
+
#
|
9783
|
+
# @!attribute [rw] recommendation
|
9784
|
+
# A short description of the recommendation to resolve an issue. The
|
9785
|
+
# description might contain markdown.
|
9786
|
+
# @return [String]
|
9787
|
+
#
|
9788
|
+
# @!attribute [rw] description
|
9789
|
+
# A detailed description of the recommendation. The description might
|
9790
|
+
# contain markdown.
|
9791
|
+
# @return [String]
|
9792
|
+
#
|
9793
|
+
# @!attribute [rw] reason
|
9794
|
+
# The reason why this recommendation was created. The information
|
9795
|
+
# might contain markdown.
|
9796
|
+
# @return [String]
|
9797
|
+
#
|
9798
|
+
# @!attribute [rw] recommended_actions
|
9799
|
+
# A list of recommended actions.
|
9800
|
+
# @return [Array<Types::RecommendedAction>]
|
9801
|
+
#
|
9802
|
+
# @!attribute [rw] category
|
9803
|
+
# The category of the recommendation.
|
9804
|
+
#
|
9805
|
+
# Valid values:
|
9806
|
+
#
|
9807
|
+
# * `performance efficiency`
|
9808
|
+
#
|
9809
|
+
# * `security`
|
9810
|
+
#
|
9811
|
+
# * `reliability`
|
9812
|
+
#
|
9813
|
+
# * `cost optimization`
|
9814
|
+
#
|
9815
|
+
# * `operational excellence`
|
9816
|
+
#
|
9817
|
+
# * `sustainability`
|
9818
|
+
# @return [String]
|
9819
|
+
#
|
9820
|
+
# @!attribute [rw] source
|
9821
|
+
# The Amazon Web Services service that generated the recommendations.
|
9822
|
+
# @return [String]
|
9823
|
+
#
|
9824
|
+
# @!attribute [rw] type_detection
|
9825
|
+
# A short description of the recommendation type. The description
|
9826
|
+
# might contain markdown.
|
9827
|
+
# @return [String]
|
9828
|
+
#
|
9829
|
+
# @!attribute [rw] type_recommendation
|
9830
|
+
# A short description that summarizes the recommendation to fix all
|
9831
|
+
# the issues of the recommendation type. The description might contain
|
9832
|
+
# markdown.
|
9833
|
+
# @return [String]
|
9834
|
+
#
|
9835
|
+
# @!attribute [rw] impact
|
9836
|
+
# A short description that explains the possible impact of an issue.
|
9837
|
+
# @return [String]
|
9838
|
+
#
|
9839
|
+
# @!attribute [rw] additional_info
|
9840
|
+
# Additional information about the recommendation. The information
|
9841
|
+
# might contain markdown.
|
9842
|
+
# @return [String]
|
9843
|
+
#
|
9844
|
+
# @!attribute [rw] links
|
9845
|
+
# A link to documentation that provides additional information about
|
9846
|
+
# the recommendation.
|
9847
|
+
# @return [Array<Types::DocLink>]
|
9848
|
+
#
|
9849
|
+
# @!attribute [rw] issue_details
|
9850
|
+
# Details of the issue that caused the recommendation.
|
9851
|
+
# @return [Types::IssueDetails]
|
9852
|
+
#
|
9853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBRecommendation AWS API Documentation
|
9854
|
+
#
|
9855
|
+
class DBRecommendation < Struct.new(
|
9856
|
+
:recommendation_id,
|
9857
|
+
:type_id,
|
9858
|
+
:severity,
|
9859
|
+
:resource_arn,
|
9860
|
+
:status,
|
9861
|
+
:created_time,
|
9862
|
+
:updated_time,
|
9863
|
+
:detection,
|
9864
|
+
:recommendation,
|
9865
|
+
:description,
|
9866
|
+
:reason,
|
9867
|
+
:recommended_actions,
|
9868
|
+
:category,
|
9869
|
+
:source,
|
9870
|
+
:type_detection,
|
9871
|
+
:type_recommendation,
|
9872
|
+
:impact,
|
9873
|
+
:additional_info,
|
9874
|
+
:links,
|
9875
|
+
:issue_details)
|
9876
|
+
SENSITIVE = []
|
9877
|
+
include Aws::Structure
|
9878
|
+
end
|
9879
|
+
|
9880
|
+
# @!attribute [rw] db_recommendation
|
9881
|
+
# The recommendation for your DB instances, DB clusters, and DB
|
9882
|
+
# parameter groups.
|
9883
|
+
# @return [Types::DBRecommendation]
|
9884
|
+
#
|
9885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBRecommendationMessage AWS API Documentation
|
9886
|
+
#
|
9887
|
+
class DBRecommendationMessage < Struct.new(
|
9888
|
+
:db_recommendation)
|
9889
|
+
SENSITIVE = []
|
9890
|
+
include Aws::Structure
|
9891
|
+
end
|
9892
|
+
|
9893
|
+
# @!attribute [rw] db_recommendations
|
9894
|
+
# A list of recommendations which is returned from
|
9895
|
+
# `DescribeDBRecommendations` API request.
|
9896
|
+
# @return [Array<Types::DBRecommendation>]
|
9897
|
+
#
|
9898
|
+
# @!attribute [rw] marker
|
9899
|
+
# An optional pagination token provided by a previous
|
9900
|
+
# `DBRecommendationsMessage` request. This token can be used later in
|
9901
|
+
# a `DescribeDBRecomendations` request.
|
9902
|
+
# @return [String]
|
9903
|
+
#
|
9904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBRecommendationsMessage AWS API Documentation
|
9905
|
+
#
|
9906
|
+
class DBRecommendationsMessage < Struct.new(
|
9907
|
+
:db_recommendations,
|
9908
|
+
:marker)
|
9909
|
+
SENSITIVE = []
|
9910
|
+
include Aws::Structure
|
9911
|
+
end
|
9912
|
+
|
9702
9913
|
# Contains the details for an Amazon RDS DB security group.
|
9703
9914
|
#
|
9704
9915
|
# This data type is used as a response element in the
|
@@ -12528,6 +12739,133 @@ module Aws::RDS
|
|
12528
12739
|
include Aws::Structure
|
12529
12740
|
end
|
12530
12741
|
|
12742
|
+
# @!attribute [rw] last_updated_after
|
12743
|
+
# A filter to include only the recommendations that were updated after
|
12744
|
+
# this specified time.
|
12745
|
+
# @return [Time]
|
12746
|
+
#
|
12747
|
+
# @!attribute [rw] last_updated_before
|
12748
|
+
# A filter to include only the recommendations that were updated
|
12749
|
+
# before this specified time.
|
12750
|
+
# @return [Time]
|
12751
|
+
#
|
12752
|
+
# @!attribute [rw] locale
|
12753
|
+
# The language that you choose to return the list of recommendations.
|
12754
|
+
#
|
12755
|
+
# Valid values:
|
12756
|
+
#
|
12757
|
+
# * `en`
|
12758
|
+
#
|
12759
|
+
# * `en_UK`
|
12760
|
+
#
|
12761
|
+
# * `de`
|
12762
|
+
#
|
12763
|
+
# * `es`
|
12764
|
+
#
|
12765
|
+
# * `fr`
|
12766
|
+
#
|
12767
|
+
# * `id`
|
12768
|
+
#
|
12769
|
+
# * `it`
|
12770
|
+
#
|
12771
|
+
# * `ja`
|
12772
|
+
#
|
12773
|
+
# * `ko`
|
12774
|
+
#
|
12775
|
+
# * `pt_BR`
|
12776
|
+
#
|
12777
|
+
# * `zh_TW`
|
12778
|
+
#
|
12779
|
+
# * `zh_CN`
|
12780
|
+
# @return [String]
|
12781
|
+
#
|
12782
|
+
# @!attribute [rw] filters
|
12783
|
+
# A filter that specifies one or more recommendations to describe.
|
12784
|
+
#
|
12785
|
+
# Supported Filters:
|
12786
|
+
#
|
12787
|
+
# * `recommendation-id` - Accepts a list of recommendation
|
12788
|
+
# identifiers. The results list only includes the recommendations
|
12789
|
+
# whose identifier is one of the specified filter values.
|
12790
|
+
#
|
12791
|
+
# * `status` - Accepts a list of recommendation statuses.
|
12792
|
+
#
|
12793
|
+
# Valid values:
|
12794
|
+
#
|
12795
|
+
# * `active` - The recommendations which are ready for you to apply.
|
12796
|
+
#
|
12797
|
+
# * `pending` - The applied or scheduled recommendations which are
|
12798
|
+
# in progress.
|
12799
|
+
#
|
12800
|
+
# * `resolved` - The recommendations which are completed.
|
12801
|
+
#
|
12802
|
+
# * `dismissed` - The recommendations that you dismissed.
|
12803
|
+
#
|
12804
|
+
# The results list only includes the recommendations whose status is
|
12805
|
+
# one of the specified filter values.
|
12806
|
+
#
|
12807
|
+
# * `severity` - Accepts a list of recommendation severities. The
|
12808
|
+
# results list only includes the recommendations whose severity is
|
12809
|
+
# one of the specified filter values.
|
12810
|
+
#
|
12811
|
+
# Valid values:
|
12812
|
+
#
|
12813
|
+
# * `high`
|
12814
|
+
#
|
12815
|
+
# * `medium`
|
12816
|
+
#
|
12817
|
+
# * `low`
|
12818
|
+
#
|
12819
|
+
# * `informational`
|
12820
|
+
#
|
12821
|
+
# * `type-id` - Accepts a list of recommendation type identifiers. The
|
12822
|
+
# results list only includes the recommendations whose type is one
|
12823
|
+
# of the specified filter values.
|
12824
|
+
#
|
12825
|
+
# * `dbi-resource-id` - Accepts a list of database resource
|
12826
|
+
# identifiers. The results list only includes the recommendations
|
12827
|
+
# that generated for the specified databases.
|
12828
|
+
#
|
12829
|
+
# * `cluster-resource-id` - Accepts a list of cluster resource
|
12830
|
+
# identifiers. The results list only includes the recommendations
|
12831
|
+
# that generated for the specified clusters.
|
12832
|
+
#
|
12833
|
+
# * `pg-arn` - Accepts a list of parameter group ARNs. The results
|
12834
|
+
# list only includes the recommendations that generated for the
|
12835
|
+
# specified parameter groups.
|
12836
|
+
#
|
12837
|
+
# * `cluster-pg-arn` - Accepts a list of cluster parameter group ARNs.
|
12838
|
+
# The results list only includes the recommendations that generated
|
12839
|
+
# for the specified cluster parameter groups.
|
12840
|
+
# @return [Array<Types::Filter>]
|
12841
|
+
#
|
12842
|
+
# @!attribute [rw] max_records
|
12843
|
+
# The maximum number of recommendations to include in the response. If
|
12844
|
+
# more records exist than the specified `MaxRecords` value, a
|
12845
|
+
# pagination token called a marker is included in the response so that
|
12846
|
+
# you can retrieve the remaining results.
|
12847
|
+
# @return [Integer]
|
12848
|
+
#
|
12849
|
+
# @!attribute [rw] marker
|
12850
|
+
# An optional pagination token provided by a previous
|
12851
|
+
# `DescribeDBRecommendations` request. If this parameter is specified,
|
12852
|
+
# the response includes only records beyond the marker, up to the
|
12853
|
+
# value specified by `MaxRecords`.
|
12854
|
+
# @return [String]
|
12855
|
+
#
|
12856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBRecommendationsMessage AWS API Documentation
|
12857
|
+
#
|
12858
|
+
class DescribeDBRecommendationsMessage < Struct.new(
|
12859
|
+
:last_updated_after,
|
12860
|
+
:last_updated_before,
|
12861
|
+
:locale,
|
12862
|
+
:filters,
|
12863
|
+
:max_records,
|
12864
|
+
:marker)
|
12865
|
+
SENSITIVE = []
|
12866
|
+
include Aws::Structure
|
12867
|
+
end
|
12868
|
+
|
12531
12869
|
# @!attribute [rw] db_security_group_name
|
12532
12870
|
# The name of the DB security group to return details for.
|
12533
12871
|
# @return [String]
|
@@ -14031,6 +14369,26 @@ module Aws::RDS
|
|
14031
14369
|
include Aws::Structure
|
14032
14370
|
end
|
14033
14371
|
|
14372
|
+
# A link to documentation that provides additional information for a
|
14373
|
+
# recommendation.
|
14374
|
+
#
|
14375
|
+
# @!attribute [rw] text
|
14376
|
+
# The text with the link to documentation for the recommendation.
|
14377
|
+
# @return [String]
|
14378
|
+
#
|
14379
|
+
# @!attribute [rw] url
|
14380
|
+
# The URL for the documentation for the recommendation.
|
14381
|
+
# @return [String]
|
14382
|
+
#
|
14383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DocLink AWS API Documentation
|
14384
|
+
#
|
14385
|
+
class DocLink < Struct.new(
|
14386
|
+
:text,
|
14387
|
+
:url)
|
14388
|
+
SENSITIVE = []
|
14389
|
+
include Aws::Structure
|
14390
|
+
end
|
14391
|
+
|
14034
14392
|
# An Active Directory Domain membership record associated with the DB
|
14035
14393
|
# instance or cluster.
|
14036
14394
|
#
|
@@ -14883,6 +15241,8 @@ module Aws::RDS
|
|
14883
15241
|
#
|
14884
15242
|
# * `DescribeDBInstances`
|
14885
15243
|
#
|
15244
|
+
# * `DescribeDBRecommendations`
|
15245
|
+
#
|
14886
15246
|
# * `DescribePendingMaintenanceActions`
|
14887
15247
|
#
|
14888
15248
|
# @!attribute [rw] name
|
@@ -15440,6 +15800,22 @@ module Aws::RDS
|
|
15440
15800
|
#
|
15441
15801
|
class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end
|
15442
15802
|
|
15803
|
+
# The details of an issue with your DB instances, DB clusters, and DB
|
15804
|
+
# parameter groups.
|
15805
|
+
#
|
15806
|
+
# @!attribute [rw] performance_issue_details
|
15807
|
+
# A detailed description of the issue when the recommendation category
|
15808
|
+
# is `performance`.
|
15809
|
+
# @return [Types::PerformanceIssueDetails]
|
15810
|
+
#
|
15811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/IssueDetails AWS API Documentation
|
15812
|
+
#
|
15813
|
+
class IssueDetails < Struct.new(
|
15814
|
+
:performance_issue_details)
|
15815
|
+
SENSITIVE = []
|
15816
|
+
include Aws::Structure
|
15817
|
+
end
|
15818
|
+
|
15443
15819
|
# An error occurred accessing an Amazon Web Services KMS key.
|
15444
15820
|
#
|
15445
15821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/KMSKeyNotAccessibleFault AWS API Documentation
|
@@ -15525,6 +15901,70 @@ module Aws::RDS
|
|
15525
15901
|
include Aws::Structure
|
15526
15902
|
end
|
15527
15903
|
|
15904
|
+
# The representation of a metric.
|
15905
|
+
#
|
15906
|
+
# @!attribute [rw] name
|
15907
|
+
# The name of a metric.
|
15908
|
+
# @return [String]
|
15909
|
+
#
|
15910
|
+
# @!attribute [rw] references
|
15911
|
+
# A list of metric references (thresholds).
|
15912
|
+
# @return [Array<Types::MetricReference>]
|
15913
|
+
#
|
15914
|
+
# @!attribute [rw] statistics_details
|
15915
|
+
# The details of different statistics for a metric. The description
|
15916
|
+
# might contain markdown.
|
15917
|
+
# @return [String]
|
15918
|
+
#
|
15919
|
+
# @!attribute [rw] metric_query
|
15920
|
+
# The query to retrieve metric data points.
|
15921
|
+
# @return [Types::MetricQuery]
|
15922
|
+
#
|
15923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/Metric AWS API Documentation
|
15924
|
+
#
|
15925
|
+
class Metric < Struct.new(
|
15926
|
+
:name,
|
15927
|
+
:references,
|
15928
|
+
:statistics_details,
|
15929
|
+
:metric_query)
|
15930
|
+
SENSITIVE = []
|
15931
|
+
include Aws::Structure
|
15932
|
+
end
|
15933
|
+
|
15934
|
+
# The query to retrieve metric data points.
|
15935
|
+
#
|
15936
|
+
# @!attribute [rw] performance_insights_metric_query
|
15937
|
+
# The Performance Insights query that you can use to retrieve
|
15938
|
+
# Performance Insights metric data points.
|
15939
|
+
# @return [Types::PerformanceInsightsMetricQuery]
|
15940
|
+
#
|
15941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/MetricQuery AWS API Documentation
|
15942
|
+
#
|
15943
|
+
class MetricQuery < Struct.new(
|
15944
|
+
:performance_insights_metric_query)
|
15945
|
+
SENSITIVE = []
|
15946
|
+
include Aws::Structure
|
15947
|
+
end
|
15948
|
+
|
15949
|
+
# The reference (threshold) for a metric.
|
15950
|
+
#
|
15951
|
+
# @!attribute [rw] name
|
15952
|
+
# The name of the metric reference.
|
15953
|
+
# @return [String]
|
15954
|
+
#
|
15955
|
+
# @!attribute [rw] reference_details
|
15956
|
+
# The details of a performance issue.
|
15957
|
+
# @return [Types::ReferenceDetails]
|
15958
|
+
#
|
15959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/MetricReference AWS API Documentation
|
15960
|
+
#
|
15961
|
+
class MetricReference < Struct.new(
|
15962
|
+
:name,
|
15963
|
+
:reference_details)
|
15964
|
+
SENSITIVE = []
|
15965
|
+
include Aws::Structure
|
15966
|
+
end
|
15967
|
+
|
15528
15968
|
# The minimum DB engine version required for each corresponding allowed
|
15529
15969
|
# value for an option setting.
|
15530
15970
|
#
|
@@ -18137,6 +18577,40 @@ module Aws::RDS
|
|
18137
18577
|
include Aws::Structure
|
18138
18578
|
end
|
18139
18579
|
|
18580
|
+
# @!attribute [rw] recommendation_id
|
18581
|
+
# The identifier of the recommendation to update.
|
18582
|
+
# @return [String]
|
18583
|
+
#
|
18584
|
+
# @!attribute [rw] locale
|
18585
|
+
# The language of the modified recommendation.
|
18586
|
+
# @return [String]
|
18587
|
+
#
|
18588
|
+
# @!attribute [rw] status
|
18589
|
+
# The recommendation status to update.
|
18590
|
+
#
|
18591
|
+
# Valid values:
|
18592
|
+
#
|
18593
|
+
# * active
|
18594
|
+
#
|
18595
|
+
# * dismissed
|
18596
|
+
# @return [String]
|
18597
|
+
#
|
18598
|
+
# @!attribute [rw] recommended_action_updates
|
18599
|
+
# The list of recommended action status to update. You can update
|
18600
|
+
# multiple recommended actions at one time.
|
18601
|
+
# @return [Array<Types::RecommendedActionUpdate>]
|
18602
|
+
#
|
18603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBRecommendationMessage AWS API Documentation
|
18604
|
+
#
|
18605
|
+
class ModifyDBRecommendationMessage < Struct.new(
|
18606
|
+
:recommendation_id,
|
18607
|
+
:locale,
|
18608
|
+
:status,
|
18609
|
+
:recommended_action_updates)
|
18610
|
+
SENSITIVE = []
|
18611
|
+
include Aws::Structure
|
18612
|
+
end
|
18613
|
+
|
18140
18614
|
# @!attribute [rw] db_snapshot_identifier
|
18141
18615
|
# The identifier for the DB snapshot to modify the attributes for.
|
18142
18616
|
# @return [String]
|
@@ -19701,6 +20175,141 @@ module Aws::RDS
|
|
19701
20175
|
include Aws::Structure
|
19702
20176
|
end
|
19703
20177
|
|
20178
|
+
# A logical grouping of Performance Insights metrics for a related
|
20179
|
+
# subject area. For example, the `db.sql` dimension group consists of
|
20180
|
+
# the following dimensions:
|
20181
|
+
#
|
20182
|
+
# * `db.sql.id` - The hash of a running SQL statement, generated by
|
20183
|
+
# Performance Insights.
|
20184
|
+
#
|
20185
|
+
# * `db.sql.db_id` - Either the SQL ID generated by the database engine,
|
20186
|
+
# or a value generated by Performance Insights that begins with `pi-`.
|
20187
|
+
#
|
20188
|
+
# * `db.sql.statement` - The full text of the SQL statement that is
|
20189
|
+
# running, for example, `SELECT * FROM employees`.
|
20190
|
+
#
|
20191
|
+
# * `db.sql_tokenized.id` - The hash of the SQL digest generated by
|
20192
|
+
# Performance Insights.
|
20193
|
+
#
|
20194
|
+
# <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
|
20195
|
+
# elements, such as SQL statements, only the first 500 bytes are
|
20196
|
+
# returned.
|
20197
|
+
#
|
20198
|
+
# </note>
|
20199
|
+
#
|
20200
|
+
# @!attribute [rw] dimensions
|
20201
|
+
# A list of specific dimensions from a dimension group. If this list
|
20202
|
+
# isn't included, then all of the dimensions in the group were
|
20203
|
+
# requested, or are present in the response.
|
20204
|
+
# @return [Array<String>]
|
20205
|
+
#
|
20206
|
+
# @!attribute [rw] group
|
20207
|
+
# The available dimension groups for Performance Insights metric type.
|
20208
|
+
# @return [String]
|
20209
|
+
#
|
20210
|
+
# @!attribute [rw] limit
|
20211
|
+
# The maximum number of items to fetch for this dimension group.
|
20212
|
+
# @return [Integer]
|
20213
|
+
#
|
20214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PerformanceInsightsMetricDimensionGroup AWS API Documentation
|
20215
|
+
#
|
20216
|
+
class PerformanceInsightsMetricDimensionGroup < Struct.new(
|
20217
|
+
:dimensions,
|
20218
|
+
:group,
|
20219
|
+
:limit)
|
20220
|
+
SENSITIVE = []
|
20221
|
+
include Aws::Structure
|
20222
|
+
end
|
20223
|
+
|
20224
|
+
# A single Performance Insights metric query to process. You must
|
20225
|
+
# provide the metric to the query. If other parameters aren't
|
20226
|
+
# specified, Performance Insights returns all data points for the
|
20227
|
+
# specified metric. Optionally, you can request the data points to be
|
20228
|
+
# aggregated by dimension group (`GroupBy`) and return only those data
|
20229
|
+
# points that match your criteria (`Filter`).
|
20230
|
+
#
|
20231
|
+
# Constraints:
|
20232
|
+
#
|
20233
|
+
# * Must be a valid Performance Insights query.
|
20234
|
+
#
|
20235
|
+
# ^
|
20236
|
+
#
|
20237
|
+
# @!attribute [rw] group_by
|
20238
|
+
# A specification for how to aggregate the data points from a query
|
20239
|
+
# result. You must specify a valid dimension group. Performance
|
20240
|
+
# Insights will return all of the dimensions within that group, unless
|
20241
|
+
# you provide the names of specific dimensions within that group. You
|
20242
|
+
# can also request that Performance Insights return a limited number
|
20243
|
+
# of values for a dimension.
|
20244
|
+
# @return [Types::PerformanceInsightsMetricDimensionGroup]
|
20245
|
+
#
|
20246
|
+
# @!attribute [rw] metric
|
20247
|
+
# The name of a Performance Insights metric to be measured.
|
20248
|
+
#
|
20249
|
+
# Valid Values:
|
20250
|
+
#
|
20251
|
+
# * `db.load.avg` - A scaled representation of the number of active
|
20252
|
+
# sessions for the database engine.
|
20253
|
+
#
|
20254
|
+
# * `db.sampledload.avg` - The raw number of active sessions for the
|
20255
|
+
# database engine.
|
20256
|
+
#
|
20257
|
+
# * The counter metrics listed in [Performance Insights operating
|
20258
|
+
# system counters][1] in the *Amazon Aurora User Guide*.
|
20259
|
+
#
|
20260
|
+
# If the number of active sessions is less than an internal
|
20261
|
+
# Performance Insights threshold, `db.load.avg` and
|
20262
|
+
# `db.sampledload.avg` are the same value. If the number of active
|
20263
|
+
# sessions is greater than the internal threshold, Performance
|
20264
|
+
# Insights samples the active sessions, with `db.load.avg` showing the
|
20265
|
+
# scaled values, `db.sampledload.avg` showing the raw values, and
|
20266
|
+
# `db.sampledload.avg` less than `db.load.avg`. For most use cases,
|
20267
|
+
# you can query `db.load.avg` only.
|
20268
|
+
#
|
20269
|
+
#
|
20270
|
+
#
|
20271
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS
|
20272
|
+
# @return [String]
|
20273
|
+
#
|
20274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PerformanceInsightsMetricQuery AWS API Documentation
|
20275
|
+
#
|
20276
|
+
class PerformanceInsightsMetricQuery < Struct.new(
|
20277
|
+
:group_by,
|
20278
|
+
:metric)
|
20279
|
+
SENSITIVE = []
|
20280
|
+
include Aws::Structure
|
20281
|
+
end
|
20282
|
+
|
20283
|
+
# Details of the performance issue.
|
20284
|
+
#
|
20285
|
+
# @!attribute [rw] start_time
|
20286
|
+
# The time when the performance issue started.
|
20287
|
+
# @return [Time]
|
20288
|
+
#
|
20289
|
+
# @!attribute [rw] end_time
|
20290
|
+
# The time when the performance issue stopped.
|
20291
|
+
# @return [Time]
|
20292
|
+
#
|
20293
|
+
# @!attribute [rw] metrics
|
20294
|
+
# The metrics that are relevant to the performance issue.
|
20295
|
+
# @return [Array<Types::Metric>]
|
20296
|
+
#
|
20297
|
+
# @!attribute [rw] analysis
|
20298
|
+
# The analysis of the performance issue. The information might contain
|
20299
|
+
# markdown.
|
20300
|
+
# @return [String]
|
20301
|
+
#
|
20302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PerformanceIssueDetails AWS API Documentation
|
20303
|
+
#
|
20304
|
+
class PerformanceIssueDetails < Struct.new(
|
20305
|
+
:start_time,
|
20306
|
+
:end_time,
|
20307
|
+
:metrics,
|
20308
|
+
:analysis)
|
20309
|
+
SENSITIVE = []
|
20310
|
+
include Aws::Structure
|
20311
|
+
end
|
20312
|
+
|
19704
20313
|
# `SourceDBInstanceIdentifier` refers to a DB instance with
|
19705
20314
|
# `BackupRetentionPeriod` equal to 0.
|
19706
20315
|
#
|
@@ -20135,6 +20744,127 @@ module Aws::RDS
|
|
20135
20744
|
include Aws::Structure
|
20136
20745
|
end
|
20137
20746
|
|
20747
|
+
# The recommended actions to apply to resolve the issues associated with
|
20748
|
+
# your DB instances, DB clusters, and DB parameter groups.
|
20749
|
+
#
|
20750
|
+
# @!attribute [rw] action_id
|
20751
|
+
# The unique identifier of the recommended action.
|
20752
|
+
# @return [String]
|
20753
|
+
#
|
20754
|
+
# @!attribute [rw] title
|
20755
|
+
# A short description to summarize the action. The description might
|
20756
|
+
# contain markdown.
|
20757
|
+
# @return [String]
|
20758
|
+
#
|
20759
|
+
# @!attribute [rw] description
|
20760
|
+
# A detailed description of the action. The description might contain
|
20761
|
+
# markdown.
|
20762
|
+
# @return [String]
|
20763
|
+
#
|
20764
|
+
# @!attribute [rw] operation
|
20765
|
+
# An API operation for the action.
|
20766
|
+
# @return [String]
|
20767
|
+
#
|
20768
|
+
# @!attribute [rw] parameters
|
20769
|
+
# The parameters for the API operation.
|
20770
|
+
# @return [Array<Types::RecommendedActionParameter>]
|
20771
|
+
#
|
20772
|
+
# @!attribute [rw] apply_modes
|
20773
|
+
# The methods to apply the recommended action.
|
20774
|
+
#
|
20775
|
+
# Valid values:
|
20776
|
+
#
|
20777
|
+
# * `manual` - The action requires you to resolve the recommendation
|
20778
|
+
# manually.
|
20779
|
+
#
|
20780
|
+
# * `immediately` - The action is applied immediately.
|
20781
|
+
#
|
20782
|
+
# * `next-maintainance-window` - The action is applied during the next
|
20783
|
+
# scheduled maintainance.
|
20784
|
+
# @return [Array<String>]
|
20785
|
+
#
|
20786
|
+
# @!attribute [rw] status
|
20787
|
+
# The status of the action.
|
20788
|
+
#
|
20789
|
+
# * `ready`
|
20790
|
+
#
|
20791
|
+
# * `applied`
|
20792
|
+
#
|
20793
|
+
# * `scheduled`
|
20794
|
+
#
|
20795
|
+
# * `resolved`
|
20796
|
+
# @return [String]
|
20797
|
+
#
|
20798
|
+
# @!attribute [rw] issue_details
|
20799
|
+
# The details of the issue.
|
20800
|
+
# @return [Types::IssueDetails]
|
20801
|
+
#
|
20802
|
+
# @!attribute [rw] context_attributes
|
20803
|
+
# The supporting attributes to explain the recommended action.
|
20804
|
+
# @return [Array<Types::ContextAttribute>]
|
20805
|
+
#
|
20806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RecommendedAction AWS API Documentation
|
20807
|
+
#
|
20808
|
+
class RecommendedAction < Struct.new(
|
20809
|
+
:action_id,
|
20810
|
+
:title,
|
20811
|
+
:description,
|
20812
|
+
:operation,
|
20813
|
+
:parameters,
|
20814
|
+
:apply_modes,
|
20815
|
+
:status,
|
20816
|
+
:issue_details,
|
20817
|
+
:context_attributes)
|
20818
|
+
SENSITIVE = []
|
20819
|
+
include Aws::Structure
|
20820
|
+
end
|
20821
|
+
|
20822
|
+
# A single parameter to use with the `RecommendedAction` API operation
|
20823
|
+
# to apply the action.
|
20824
|
+
#
|
20825
|
+
# @!attribute [rw] key
|
20826
|
+
# The key of the parameter to use with the `RecommendedAction` API
|
20827
|
+
# operation.
|
20828
|
+
# @return [String]
|
20829
|
+
#
|
20830
|
+
# @!attribute [rw] value
|
20831
|
+
# The value of the parameter to use with the `RecommendedAction` API
|
20832
|
+
# operation.
|
20833
|
+
# @return [String]
|
20834
|
+
#
|
20835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RecommendedActionParameter AWS API Documentation
|
20836
|
+
#
|
20837
|
+
class RecommendedActionParameter < Struct.new(
|
20838
|
+
:key,
|
20839
|
+
:value)
|
20840
|
+
SENSITIVE = []
|
20841
|
+
include Aws::Structure
|
20842
|
+
end
|
20843
|
+
|
20844
|
+
# The recommended status to update for the specified recommendation
|
20845
|
+
# action ID.
|
20846
|
+
#
|
20847
|
+
# @!attribute [rw] action_id
|
20848
|
+
# A unique identifier of the updated recommendation action.
|
20849
|
+
# @return [String]
|
20850
|
+
#
|
20851
|
+
# @!attribute [rw] status
|
20852
|
+
# The status of the updated recommendation action.
|
20853
|
+
#
|
20854
|
+
# * `applied`
|
20855
|
+
#
|
20856
|
+
# * `scheduled`
|
20857
|
+
# @return [String]
|
20858
|
+
#
|
20859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RecommendedActionUpdate AWS API Documentation
|
20860
|
+
#
|
20861
|
+
class RecommendedActionUpdate < Struct.new(
|
20862
|
+
:action_id,
|
20863
|
+
:status)
|
20864
|
+
SENSITIVE = []
|
20865
|
+
include Aws::Structure
|
20866
|
+
end
|
20867
|
+
|
20138
20868
|
# This data type is used as a response element in the
|
20139
20869
|
# `DescribeReservedDBInstances` and
|
20140
20870
|
# `DescribeReservedDBInstancesOfferings` actions.
|
@@ -20156,6 +20886,20 @@ module Aws::RDS
|
|
20156
20886
|
include Aws::Structure
|
20157
20887
|
end
|
20158
20888
|
|
20889
|
+
# The reference details of a metric.
|
20890
|
+
#
|
20891
|
+
# @!attribute [rw] scalar_reference_details
|
20892
|
+
# The metric reference details when the reference is a scalar.
|
20893
|
+
# @return [Types::ScalarReferenceDetails]
|
20894
|
+
#
|
20895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ReferenceDetails AWS API Documentation
|
20896
|
+
#
|
20897
|
+
class ReferenceDetails < Struct.new(
|
20898
|
+
:scalar_reference_details)
|
20899
|
+
SENSITIVE = []
|
20900
|
+
include Aws::Structure
|
20901
|
+
end
|
20902
|
+
|
20159
20903
|
# @!attribute [rw] db_proxy_name
|
20160
20904
|
# The identifier of the `DBProxy` that is associated with the
|
20161
20905
|
# `DBProxyTargetGroup`.
|
@@ -24168,6 +24912,20 @@ module Aws::RDS
|
|
24168
24912
|
#
|
24169
24913
|
class SNSTopicArnNotFoundFault < Aws::EmptyStructure; end
|
24170
24914
|
|
24915
|
+
# The metric reference details when the reference is a scalar.
|
24916
|
+
#
|
24917
|
+
# @!attribute [rw] value
|
24918
|
+
# The value of a scalar reference.
|
24919
|
+
# @return [Float]
|
24920
|
+
#
|
24921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ScalarReferenceDetails AWS API Documentation
|
24922
|
+
#
|
24923
|
+
class ScalarReferenceDetails < Struct.new(
|
24924
|
+
:value)
|
24925
|
+
SENSITIVE = []
|
24926
|
+
include Aws::Structure
|
24927
|
+
end
|
24928
|
+
|
24171
24929
|
# Contains the scaling configuration of an Aurora Serverless v1 DB
|
24172
24930
|
# cluster.
|
24173
24931
|
#
|