@pgarbe/cdk-ecr-sync 0.5.18 → 0.5.22
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.
- package/.gitattributes +19 -19
- package/.jsii +2588 -1305
- package/.projenrc.ts +51 -0
- package/API.md +177 -46
- package/lib/ecr-sync.d.ts +6 -6
- package/lib/ecr-sync.js +16 -15
- package/node_modules/aws-sdk/CHANGELOG.md +419 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.min.json +5 -4
- package/node_modules/aws-sdk/apis/account-2021-02-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/account-2021-02-01.min.json +123 -0
- package/node_modules/aws-sdk/apis/account-2021-02-01.paginators.json +4 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.min.json +442 -11
- package/node_modules/aws-sdk/apis/amp-2020-08-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.waiters2.json +43 -0
- package/node_modules/aws-sdk/apis/amplifybackend-2020-08-11.min.json +347 -3
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.examples.json +5 -0
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.min.json +1036 -0
- package/node_modules/aws-sdk/apis/amplifyuibuilder-2021-08-11.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/appconfig-2019-10-09.examples.json +715 -0
- package/node_modules/aws-sdk/apis/appconfig-2019-10-09.min.json +48 -38
- package/node_modules/aws-sdk/apis/appconfigdata-2021-11-11.examples.json +5 -0
- package/node_modules/aws-sdk/apis/appconfigdata-2021-11-11.min.json +87 -0
- package/node_modules/aws-sdk/apis/appconfigdata-2021-11-11.paginators.json +4 -0
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +43 -37
- package/node_modules/aws-sdk/apis/appintegrations-2020-07-29.min.json +222 -8
- package/node_modules/aws-sdk/apis/application-insights-2018-11-25.min.json +51 -30
- package/node_modules/aws-sdk/apis/apprunner-2020-05-15.min.json +10 -10
- package/node_modules/aws-sdk/apis/appstream-2016-12-01.min.json +505 -141
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +97 -77
- package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.min.json +464 -12
- package/node_modules/aws-sdk/apis/auditmanager-2017-07-25.paginators.json +25 -0
- package/node_modules/aws-sdk/apis/autoscaling-2011-01-01.min.json +344 -114
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +189 -60
- package/node_modules/aws-sdk/apis/backup-gateway-2021-01-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/backup-gateway-2021-01-01.min.json +420 -0
- package/node_modules/aws-sdk/apis/backup-gateway-2021-01-01.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/batch-2016-08-10.examples.json +30 -6
- package/node_modules/aws-sdk/apis/batch-2016-08-10.min.json +267 -72
- package/node_modules/aws-sdk/apis/batch-2016-08-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/braket-2019-09-01.min.json +388 -11
- package/node_modules/aws-sdk/apis/braket-2019-09-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/chime-2018-05-01.min.json +287 -201
- package/node_modules/aws-sdk/apis/chime-sdk-identity-2021-04-20.min.json +362 -13
- package/node_modules/aws-sdk/apis/chime-sdk-identity-2021-04-20.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.min.json +503 -0
- package/node_modules/aws-sdk/apis/chime-sdk-meetings-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/chime-sdk-messaging-2021-05-15.min.json +752 -88
- package/node_modules/aws-sdk/apis/chime-sdk-messaging-2021-05-15.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.min.json +271 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +14 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +31 -0
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +50 -27
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +702 -180
- package/node_modules/aws-sdk/apis/codebuild-2016-10-06.min.json +74 -73
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -1
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.min.json +224 -125
- package/node_modules/aws-sdk/apis/comprehend-2017-11-27.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +242 -68
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +805 -103
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +17 -0
- package/node_modules/aws-sdk/apis/connectparticipant-2018-09-07.min.json +3 -0
- package/node_modules/aws-sdk/apis/customer-profiles-2020-08-15.min.json +322 -50
- package/node_modules/aws-sdk/apis/databrew-2017-07-25.min.json +430 -110
- package/node_modules/aws-sdk/apis/databrew-2017-07-25.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/dataexchange-2017-07-25.min.json +460 -39
- package/node_modules/aws-sdk/apis/dataexchange-2017-07-25.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +207 -56
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +676 -140
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.paginators.json +31 -2
- package/node_modules/aws-sdk/apis/directconnect-2012-10-25.min.json +133 -36
- package/node_modules/aws-sdk/apis/dms-2016-01-01.min.json +120 -73
- package/node_modules/aws-sdk/apis/drs-2020-02-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +1347 -0
- package/node_modules/aws-sdk/apis/drs-2020-02-26.paginators.json +40 -0
- package/node_modules/aws-sdk/apis/dynamodb-2012-08-10.min.json +296 -261
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +4613 -1377
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +90 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +6 -0
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +445 -31
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +114 -75
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +3 -0
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +131 -124
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json +32 -26
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +5 -1
- package/node_modules/aws-sdk/apis/emr-containers-2020-10-01.min.json +18 -6
- package/node_modules/aws-sdk/apis/es-2015-01-01.min.json +24 -4
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +1853 -0
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.paginators.json +28 -0
- package/node_modules/aws-sdk/apis/finspace-2021-03-12.min.json +24 -4
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.min.json +602 -36
- package/node_modules/aws-sdk/apis/finspace-data-2020-07-13.paginators.json +18 -0
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +198 -82
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.min.json +507 -76
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +358 -75
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +817 -138
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/gamelift-2015-10-01.min.json +149 -149
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +388 -367
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.examples.json +5 -0
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +728 -0
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +2 -1
- package/node_modules/aws-sdk/apis/imagebuilder-2019-12-02.min.json +124 -82
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.examples.json +5 -0
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.min.json +1993 -0
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.paginators.json +57 -0
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +375 -209
- package/node_modules/aws-sdk/apis/iotdeviceadvisor-2020-09-18.min.json +31 -3
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +360 -124
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.examples.json +5 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.min.json +1675 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.paginators.json +29 -0
- package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +1073 -94
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/ivs-2020-07-14.min.json +276 -98
- package/node_modules/aws-sdk/apis/ivs-2020-07-14.paginators.json +7 -12
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +459 -78
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kafkaconnect-2021-09-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/kafkaconnect-2021-09-14.min.json +960 -0
- package/node_modules/aws-sdk/apis/kafkaconnect-2021-09-14.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +691 -130
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +14 -0
- package/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json +64 -24
- package/node_modules/aws-sdk/apis/kinesisanalyticsv2-2018-05-23.min.json +3 -6
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +608 -8
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +858 -81
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.paginators.json +50 -5
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +180 -120
- package/node_modules/aws-sdk/apis/license-manager-2018-08-01.min.json +186 -72
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +166 -147
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +39 -7
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +9 -7
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +198 -108
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +321 -130
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +301 -227
- package/node_modules/aws-sdk/apis/mediapackage-2017-10-12.min.json +4 -0
- package/node_modules/aws-sdk/apis/mediapackage-vod-2018-11-07.min.json +7 -0
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.min.json +411 -149
- package/node_modules/aws-sdk/apis/mediatailor-2018-04-23.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/metadata.json +68 -0
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.min.json +156 -43
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/migration-hub-refactor-spaces-2021-10-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/migration-hub-refactor-spaces-2021-10-26.min.json +1230 -0
- package/node_modules/aws-sdk/apis/migration-hub-refactor-spaces-2021-10-26.paginators.json +34 -0
- package/node_modules/aws-sdk/apis/migrationhubstrategy-2020-02-19.examples.json +5 -0
- package/node_modules/aws-sdk/apis/migrationhubstrategy-2020-02-19.min.json +1032 -0
- package/node_modules/aws-sdk/apis/migrationhubstrategy-2020-02-19.paginators.json +34 -0
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +850 -157
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +192 -128
- package/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json +4 -0
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +65 -31
- package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.min.json +2044 -118
- package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.paginators.json +60 -0
- package/node_modules/aws-sdk/apis/nimble-2020-08-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/nimble-2020-08-01.min.json +752 -957
- package/node_modules/aws-sdk/apis/nimble-2020-08-01.paginators.json +50 -56
- package/node_modules/aws-sdk/apis/nimble-2020-08-01.waiters2.json +234 -0
- package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +24 -4
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +507 -49
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/panorama-2019-07-24.examples.json +5 -0
- package/node_modules/aws-sdk/apis/panorama-2019-07-24.min.json +1622 -0
- package/node_modules/aws-sdk/apis/panorama-2019-07-24.paginators.json +49 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +338 -31
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/personalize-runtime-2018-05-22.min.json +2 -4
- package/node_modules/aws-sdk/apis/pinpoint-2016-12-01.min.json +869 -352
- package/node_modules/aws-sdk/apis/proton-2020-07-20.min.json +752 -74
- package/node_modules/aws-sdk/apis/proton-2020-07-20.paginators.json +41 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +327 -194
- package/node_modules/aws-sdk/apis/ram-2018-01-04.min.json +16 -11
- package/node_modules/aws-sdk/apis/rbin-2021-06-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/rbin-2021-06-15.min.json +325 -0
- package/node_modules/aws-sdk/apis/rbin-2021-06-15.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +538 -323
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +253 -148
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.paginators.json +30 -0
- package/node_modules/aws-sdk/apis/redshift-data-2019-12-20.min.json +0 -6
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +362 -121
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +1863 -0
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.paginators.json +74 -0
- package/node_modules/aws-sdk/apis/robomaker-2018-06-29.min.json +263 -198
- package/node_modules/aws-sdk/apis/route53resolver-2018-04-01.min.json +85 -13
- package/node_modules/aws-sdk/apis/route53resolver-2018-04-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/rum-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/rum-2018-05-10.min.json +458 -0
- package/node_modules/aws-sdk/apis/rum-2018-05-10.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/runtime.lex.v2-2020-08-07.min.json +14 -13
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +138 -138
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +196 -163
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +15 -7
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +2264 -1025
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.paginators.json +29 -0
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +779 -259
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/sesv2-2019-09-27.min.json +72 -70
- package/node_modules/aws-sdk/apis/shield-2016-06-02.min.json +93 -14
- package/node_modules/aws-sdk/apis/snowball-2016-06-30.min.json +35 -25
- package/node_modules/aws-sdk/apis/sns-2010-03-31.min.json +90 -18
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +379 -351
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/storagegateway-2013-06-30.min.json +58 -11
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +39 -9
- package/node_modules/aws-sdk/apis/textract-2018-06-27.min.json +163 -30
- package/node_modules/aws-sdk/apis/timestream-query-2018-11-01.min.json +623 -42
- package/node_modules/aws-sdk/apis/timestream-query-2018-11-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/timestream-write-2018-11-01.min.json +81 -13
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +80 -24
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +44 -43
- package/node_modules/aws-sdk/apis/translate-2017-07-01.min.json +66 -30
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.examples.json +5 -0
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.min.json +903 -0
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +166 -97
- package/node_modules/aws-sdk/apis/wellarchitected-2020-03-31.min.json +398 -59
- package/node_modules/aws-sdk/apis/wellarchitected-2020-03-31.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.examples.json +5 -0
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.min.json +1525 -0
- package/node_modules/aws-sdk/apis/wisdom-2020-10-19.paginators.json +46 -0
- package/node_modules/aws-sdk/apis/workmail-2017-10-01.min.json +308 -27
- package/node_modules/aws-sdk/apis/workmail-2017-10-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +83 -50
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.examples.json +5 -0
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +1579 -0
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.paginators.json +39 -0
- package/node_modules/aws-sdk/clients/accessanalyzer.d.ts +6 -1
- package/node_modules/aws-sdk/clients/account.d.ts +136 -0
- package/node_modules/aws-sdk/clients/account.js +18 -0
- package/node_modules/aws-sdk/clients/all.d.ts +21 -0
- package/node_modules/aws-sdk/clients/all.js +22 -1
- package/node_modules/aws-sdk/clients/amp.d.ts +387 -0
- package/node_modules/aws-sdk/clients/amp.js +1 -0
- package/node_modules/aws-sdk/clients/amplifybackend.d.ts +313 -1
- package/node_modules/aws-sdk/clients/amplifyuibuilder.d.ts +1003 -0
- package/node_modules/aws-sdk/clients/amplifyuibuilder.js +18 -0
- package/node_modules/aws-sdk/clients/apigateway.d.ts +1 -1
- package/node_modules/aws-sdk/clients/appconfig.d.ts +86 -68
- package/node_modules/aws-sdk/clients/appconfigdata.d.ts +102 -0
- package/node_modules/aws-sdk/clients/appconfigdata.js +18 -0
- package/node_modules/aws-sdk/clients/appflow.d.ts +8 -0
- package/node_modules/aws-sdk/clients/appintegrations.d.ts +273 -2
- package/node_modules/aws-sdk/clients/applicationautoscaling.d.ts +38 -38
- package/node_modules/aws-sdk/clients/applicationinsights.d.ts +18 -3
- package/node_modules/aws-sdk/clients/apprunner.d.ts +55 -54
- package/node_modules/aws-sdk/clients/appstream.d.ts +482 -15
- package/node_modules/aws-sdk/clients/appsync.d.ts +35 -13
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +801 -313
- package/node_modules/aws-sdk/clients/autoscaling.d.ts +341 -51
- package/node_modules/aws-sdk/clients/backup.d.ts +162 -32
- package/node_modules/aws-sdk/clients/backupgateway.d.ts +571 -0
- package/node_modules/aws-sdk/clients/backupgateway.js +18 -0
- package/node_modules/aws-sdk/clients/batch.d.ts +250 -34
- package/node_modules/aws-sdk/clients/braket.d.ts +409 -0
- package/node_modules/aws-sdk/clients/chime.d.ts +135 -8
- package/node_modules/aws-sdk/clients/chimesdkidentity.d.ts +314 -2
- package/node_modules/aws-sdk/clients/chimesdkmeetings.d.ts +546 -0
- package/node_modules/aws-sdk/clients/chimesdkmeetings.js +18 -0
- package/node_modules/aws-sdk/clients/chimesdkmessaging.d.ts +620 -16
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +385 -0
- package/node_modules/aws-sdk/clients/cloudcontrol.js +19 -0
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +46 -14
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +494 -40
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +3 -3
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +71 -17
- package/node_modules/aws-sdk/clients/codebuild.d.ts +8 -3
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +60 -23
- package/node_modules/aws-sdk/clients/comprehend.d.ts +200 -1
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +249 -10
- package/node_modules/aws-sdk/clients/configservice.d.ts +1 -1
- package/node_modules/aws-sdk/clients/connect.d.ts +846 -48
- package/node_modules/aws-sdk/clients/connectparticipant.d.ts +18 -13
- package/node_modules/aws-sdk/clients/customerprofiles.d.ts +322 -11
- package/node_modules/aws-sdk/clients/databrew.d.ts +358 -1
- package/node_modules/aws-sdk/clients/dataexchange.d.ts +525 -23
- package/node_modules/aws-sdk/clients/datasync.d.ts +241 -11
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +707 -81
- package/node_modules/aws-sdk/clients/directconnect.d.ts +208 -49
- package/node_modules/aws-sdk/clients/dms.d.ts +116 -34
- package/node_modules/aws-sdk/clients/drs.d.ts +1737 -0
- package/node_modules/aws-sdk/clients/drs.js +18 -0
- package/node_modules/aws-sdk/clients/dynamodb.d.ts +113 -61
- package/node_modules/aws-sdk/clients/ec2.d.ts +4037 -416
- package/node_modules/aws-sdk/clients/ecr.d.ts +713 -56
- package/node_modules/aws-sdk/clients/ecs.d.ts +416 -345
- package/node_modules/aws-sdk/clients/efs.d.ts +10 -10
- package/node_modules/aws-sdk/clients/eks.d.ts +27 -23
- package/node_modules/aws-sdk/clients/elasticache.d.ts +51 -30
- package/node_modules/aws-sdk/clients/elbv2.d.ts +29 -12
- package/node_modules/aws-sdk/clients/emr.d.ts +38 -18
- package/node_modules/aws-sdk/clients/emrcontainers.d.ts +18 -3
- package/node_modules/aws-sdk/clients/es.d.ts +39 -3
- package/node_modules/aws-sdk/clients/evidently.d.ts +1892 -0
- package/node_modules/aws-sdk/clients/evidently.js +18 -0
- package/node_modules/aws-sdk/clients/finspace.d.ts +26 -0
- package/node_modules/aws-sdk/clients/finspace.js +0 -1
- package/node_modules/aws-sdk/clients/finspacedata.d.ts +741 -65
- package/node_modules/aws-sdk/clients/finspacedata.js +0 -1
- package/node_modules/aws-sdk/clients/firehose.d.ts +62 -0
- package/node_modules/aws-sdk/clients/forecastservice.d.ts +561 -9
- package/node_modules/aws-sdk/clients/frauddetector.d.ts +434 -26
- package/node_modules/aws-sdk/clients/fsx.d.ts +905 -139
- package/node_modules/aws-sdk/clients/gamelift.d.ts +9 -7
- package/node_modules/aws-sdk/clients/glue.d.ts +59 -2
- package/node_modules/aws-sdk/clients/grafana.d.ts +718 -0
- package/node_modules/aws-sdk/clients/grafana.js +18 -0
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +8 -4
- package/node_modules/aws-sdk/clients/health.d.ts +49 -49
- package/node_modules/aws-sdk/clients/iam.d.ts +85 -85
- package/node_modules/aws-sdk/clients/imagebuilder.d.ts +102 -42
- package/node_modules/aws-sdk/clients/inspector2.d.ts +2448 -0
- package/node_modules/aws-sdk/clients/inspector2.js +18 -0
- package/node_modules/aws-sdk/clients/iot.d.ts +252 -18
- package/node_modules/aws-sdk/clients/iotdeviceadvisor.d.ts +90 -60
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +254 -12
- package/node_modules/aws-sdk/clients/iottwinmaker.d.ts +1672 -0
- package/node_modules/aws-sdk/clients/iottwinmaker.js +19 -0
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +637 -6
- package/node_modules/aws-sdk/clients/ivs.d.ts +353 -124
- package/node_modules/aws-sdk/clients/kafka.d.ts +503 -18
- package/node_modules/aws-sdk/clients/kafkaconnect.d.ts +1132 -0
- package/node_modules/aws-sdk/clients/kafkaconnect.js +18 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +797 -60
- package/node_modules/aws-sdk/clients/kinesis.d.ts +114 -46
- package/node_modules/aws-sdk/clients/kinesisanalyticsv2.d.ts +30 -30
- package/node_modules/aws-sdk/clients/kms.d.ts +2 -2
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +935 -97
- package/node_modules/aws-sdk/clients/lambda.d.ts +102 -37
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +834 -21
- package/node_modules/aws-sdk/clients/lexmodelsv2.js +0 -1
- package/node_modules/aws-sdk/clients/lexruntimev2.d.ts +12 -7
- package/node_modules/aws-sdk/clients/licensemanager.d.ts +215 -42
- package/node_modules/aws-sdk/clients/lightsail.d.ts +25 -2
- package/node_modules/aws-sdk/clients/location.d.ts +124 -60
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +23 -14
- package/node_modules/aws-sdk/clients/lookoutmetrics.js +0 -1
- package/node_modules/aws-sdk/clients/macie2.d.ts +171 -82
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +280 -81
- package/node_modules/aws-sdk/clients/medialive.d.ts +81 -5
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -0
- package/node_modules/aws-sdk/clients/mediapackagevod.d.ts +8 -0
- package/node_modules/aws-sdk/clients/mediatailor.d.ts +271 -1
- package/node_modules/aws-sdk/clients/mgn.d.ts +140 -3
- package/node_modules/aws-sdk/clients/migrationhubrefactorspaces.d.ts +1686 -0
- package/node_modules/aws-sdk/clients/migrationhubrefactorspaces.js +18 -0
- package/node_modules/aws-sdk/clients/migrationhubstrategy.d.ts +1335 -0
- package/node_modules/aws-sdk/clients/migrationhubstrategy.js +18 -0
- package/node_modules/aws-sdk/clients/neptune.d.ts +20 -12
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +61 -10
- package/node_modules/aws-sdk/clients/networkmanager.d.ts +2680 -519
- package/node_modules/aws-sdk/clients/nimble.d.ts +499 -299
- package/node_modules/aws-sdk/clients/nimble.js +1 -0
- package/node_modules/aws-sdk/clients/opensearch.d.ts +43 -1
- package/node_modules/aws-sdk/clients/outposts.d.ts +520 -12
- package/node_modules/aws-sdk/clients/panorama.d.ts +1926 -0
- package/node_modules/aws-sdk/clients/panorama.js +18 -0
- package/node_modules/aws-sdk/clients/personalize.d.ts +456 -9
- package/node_modules/aws-sdk/clients/personalizeruntime.d.ts +8 -4
- package/node_modules/aws-sdk/clients/pinpoint.d.ts +534 -4
- package/node_modules/aws-sdk/clients/proton.d.ts +984 -152
- package/node_modules/aws-sdk/clients/quicksight.d.ts +337 -193
- package/node_modules/aws-sdk/clients/ram.d.ts +234 -212
- package/node_modules/aws-sdk/clients/rbin.d.ts +355 -0
- package/node_modules/aws-sdk/clients/rbin.js +18 -0
- package/node_modules/aws-sdk/clients/rds.d.ts +758 -388
- package/node_modules/aws-sdk/clients/redshift.d.ts +170 -8
- package/node_modules/aws-sdk/clients/redshiftdata.d.ts +34 -34
- package/node_modules/aws-sdk/clients/rekognition.d.ts +347 -28
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +2101 -0
- package/node_modules/aws-sdk/clients/resiliencehub.js +18 -0
- package/node_modules/aws-sdk/clients/resourcegroupstaggingapi.d.ts +29 -29
- package/node_modules/aws-sdk/clients/robomaker.d.ts +139 -13
- package/node_modules/aws-sdk/clients/route53resolver.d.ts +94 -0
- package/node_modules/aws-sdk/clients/rum.d.ts +509 -0
- package/node_modules/aws-sdk/clients/rum.js +18 -0
- package/node_modules/aws-sdk/clients/s3.d.ts +123 -75
- package/node_modules/aws-sdk/clients/s3control.d.ts +11 -1
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +1757 -95
- package/node_modules/aws-sdk/clients/sagemakerruntime.d.ts +7 -7
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +27 -27
- package/node_modules/aws-sdk/clients/securityhub.d.ts +829 -13
- package/node_modules/aws-sdk/clients/sesv2.d.ts +128 -108
- package/node_modules/aws-sdk/clients/shield.d.ts +125 -43
- package/node_modules/aws-sdk/clients/snowball.d.ts +73 -55
- package/node_modules/aws-sdk/clients/sns.d.ts +127 -34
- package/node_modules/aws-sdk/clients/sqs.d.ts +8 -8
- package/node_modules/aws-sdk/clients/ssm.d.ts +349 -283
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +66 -66
- package/node_modules/aws-sdk/clients/storagegateway.d.ts +101 -36
- package/node_modules/aws-sdk/clients/sts.d.ts +18 -18
- package/node_modules/aws-sdk/clients/synthetics.d.ts +40 -0
- package/node_modules/aws-sdk/clients/textract.d.ts +167 -8
- package/node_modules/aws-sdk/clients/timestreamquery.d.ts +661 -19
- package/node_modules/aws-sdk/clients/timestreamwrite.d.ts +135 -42
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +75 -12
- package/node_modules/aws-sdk/clients/transfer.d.ts +21 -16
- package/node_modules/aws-sdk/clients/translate.d.ts +74 -21
- package/node_modules/aws-sdk/clients/voiceid.d.ts +1133 -0
- package/node_modules/aws-sdk/clients/voiceid.js +18 -0
- package/node_modules/aws-sdk/clients/wafv2.d.ts +113 -31
- package/node_modules/aws-sdk/clients/wellarchitected.d.ts +355 -13
- package/node_modules/aws-sdk/clients/wisdom.d.ts +1499 -0
- package/node_modules/aws-sdk/clients/wisdom.js +18 -0
- package/node_modules/aws-sdk/clients/workmail.d.ts +383 -5
- package/node_modules/aws-sdk/clients/workspaces.d.ts +87 -40
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +1520 -0
- package/node_modules/aws-sdk/clients/workspacesweb.js +18 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +129 -80
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +1300 -550
- package/node_modules/aws-sdk/dist/aws-sdk.js +12256 -4407
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +90 -87
- package/node_modules/aws-sdk/lib/config-base.d.ts +8 -0
- package/node_modules/aws-sdk/lib/config.js +15 -3
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +42 -0
- package/node_modules/aws-sdk/lib/config_use_dualstack.d.ts +3 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/dynamodb/document_client.d.ts +91 -39
- package/node_modules/aws-sdk/lib/event_listeners.js +1 -2
- package/node_modules/aws-sdk/lib/http_request.d.ts +1 -1
- package/node_modules/aws-sdk/lib/metadata_service/get_endpoint.js +8 -0
- package/node_modules/aws-sdk/lib/metadata_service/get_endpoint_config_options.js +12 -0
- package/node_modules/aws-sdk/lib/metadata_service/get_endpoint_mode.js +8 -0
- package/node_modules/aws-sdk/lib/metadata_service/get_endpoint_mode_config_options.js +14 -0
- package/node_modules/aws-sdk/lib/metadata_service/get_metadata_service_endpoint.js +4 -4
- package/node_modules/aws-sdk/lib/node_loader.js +63 -21
- package/node_modules/aws-sdk/lib/protocol/rest_json.js +6 -12
- package/node_modules/aws-sdk/lib/region/utils.js +21 -0
- package/node_modules/aws-sdk/lib/region_config.js +13 -13
- package/node_modules/aws-sdk/lib/region_config_data.json +141 -6
- package/node_modules/aws-sdk/lib/request.js +4 -6
- package/node_modules/aws-sdk/lib/service.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3.js +16 -20
- package/node_modules/aws-sdk/lib/services/s3control.js +12 -3
- package/node_modules/aws-sdk/lib/services/s3util.js +17 -7
- package/node_modules/aws-sdk/lib/signers/v4.js +1 -1
- package/node_modules/aws-sdk/package.json +4 -5
- package/node_modules/aws-sdk/scripts/region-checker/allowlist.js +18 -14
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/.eslintrc.json +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/AUTHORS +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/CHANGELOG.md +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/LICENSE.md +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/README.md +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/README_js.md +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/bin/uuid +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/index.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/bytesToUuid.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/md5-browser.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/md5.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/rng-browser.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/rng.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/sha1-browser.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/sha1.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/lib/v35.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/package.json +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/v1.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/v3.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/v4.js +0 -0
- package/node_modules/{aws-sdk/node_modules/uuid → uuid}/v5.js +0 -0
- package/package.json +42 -69
- package/node_modules/aws-sdk/lib/metadata_service/endpoint.js +0 -6
- package/node_modules/aws-sdk/lib/metadata_service/endpoint_config_options.js +0 -14
- package/node_modules/aws-sdk/lib/metadata_service/endpoint_mode.js +0 -6
- package/node_modules/aws-sdk/lib/metadata_service/endpoint_mode_config_options.js +0 -16
- package/node_modules/aws-sdk/lib/services/finspace.js +0 -23
- package/node_modules/aws-sdk/lib/services/finspacedata.js +0 -23
- package/node_modules/aws-sdk/lib/services/lexmodelsv2.js +0 -23
- package/node_modules/aws-sdk/lib/services/lookoutmetrics.js +0 -22
- package/node_modules/aws-sdk/scripts/check-node-version.js +0 -8
|
@@ -14,19 +14,19 @@ declare class RDS extends Service {
|
|
|
14
14
|
constructor(options?: RDS.Types.ClientConfiguration)
|
|
15
15
|
config: Config & RDS.Types.ClientConfiguration;
|
|
16
16
|
/**
|
|
17
|
-
* Associates an Identity and Access Management (IAM) role
|
|
17
|
+
* Associates an Identity and Access Management (IAM) role with a DB cluster.
|
|
18
18
|
*/
|
|
19
19
|
addRoleToDBCluster(params: RDS.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
20
20
|
/**
|
|
21
|
-
* Associates an Identity and Access Management (IAM) role
|
|
21
|
+
* Associates an Identity and Access Management (IAM) role with a DB cluster.
|
|
22
22
|
*/
|
|
23
23
|
addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
24
24
|
/**
|
|
25
|
-
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
|
|
25
|
+
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom.
|
|
26
26
|
*/
|
|
27
27
|
addRoleToDBInstance(params: RDS.Types.AddRoleToDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
28
28
|
/**
|
|
29
|
-
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
|
|
29
|
+
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom.
|
|
30
30
|
*/
|
|
31
31
|
addRoleToDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
32
32
|
/**
|
|
@@ -54,11 +54,11 @@ declare class RDS extends Service {
|
|
|
54
54
|
*/
|
|
55
55
|
applyPendingMaintenanceAction(callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
|
|
56
56
|
/**
|
|
57
|
-
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the
|
|
57
|
+
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
|
|
58
58
|
*/
|
|
59
59
|
authorizeDBSecurityGroupIngress(params: RDS.Types.AuthorizeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
|
|
60
60
|
/**
|
|
61
|
-
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the
|
|
61
|
+
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
|
|
62
62
|
*/
|
|
63
63
|
authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
|
|
64
64
|
/**
|
|
@@ -78,19 +78,19 @@ declare class RDS extends Service {
|
|
|
78
78
|
*/
|
|
79
79
|
cancelExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
|
|
80
80
|
/**
|
|
81
|
-
* Copies the specified DB cluster parameter group.
|
|
81
|
+
* Copies the specified DB cluster parameter group.
|
|
82
82
|
*/
|
|
83
83
|
copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
|
|
84
84
|
/**
|
|
85
|
-
* Copies the specified DB cluster parameter group.
|
|
85
|
+
* Copies the specified DB cluster parameter group.
|
|
86
86
|
*/
|
|
87
87
|
copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
|
|
88
88
|
/**
|
|
89
|
-
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
89
|
+
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
90
90
|
*/
|
|
91
91
|
copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
|
|
92
92
|
/**
|
|
93
|
-
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
93
|
+
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
94
94
|
*/
|
|
95
95
|
copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
|
|
96
96
|
/**
|
|
@@ -102,11 +102,11 @@ declare class RDS extends Service {
|
|
|
102
102
|
*/
|
|
103
103
|
copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
|
|
104
104
|
/**
|
|
105
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
105
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
106
106
|
*/
|
|
107
107
|
copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
108
108
|
/**
|
|
109
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
109
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
110
110
|
*/
|
|
111
111
|
copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
112
112
|
/**
|
|
@@ -126,11 +126,19 @@ declare class RDS extends Service {
|
|
|
126
126
|
*/
|
|
127
127
|
createCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
|
|
128
128
|
/**
|
|
129
|
-
* Creates a
|
|
129
|
+
* Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM). Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files. After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a CEV in the Amazon RDS User Guide.
|
|
130
|
+
*/
|
|
131
|
+
createCustomDBEngineVersion(params: RDS.Types.CreateCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
132
|
+
/**
|
|
133
|
+
* Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM). Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files. After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a CEV in the Amazon RDS User Guide.
|
|
134
|
+
*/
|
|
135
|
+
createCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
136
|
+
/**
|
|
137
|
+
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
130
138
|
*/
|
|
131
139
|
createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
|
|
132
140
|
/**
|
|
133
|
-
* Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create
|
|
141
|
+
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
134
142
|
*/
|
|
135
143
|
createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
|
|
136
144
|
/**
|
|
@@ -142,19 +150,19 @@ declare class RDS extends Service {
|
|
|
142
150
|
*/
|
|
143
151
|
createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
144
152
|
/**
|
|
145
|
-
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster,
|
|
153
|
+
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
146
154
|
*/
|
|
147
155
|
createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
|
|
148
156
|
/**
|
|
149
|
-
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster,
|
|
157
|
+
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
150
158
|
*/
|
|
151
159
|
createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
|
|
152
160
|
/**
|
|
153
|
-
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What
|
|
161
|
+
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
154
162
|
*/
|
|
155
163
|
createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
|
|
156
164
|
/**
|
|
157
|
-
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What
|
|
165
|
+
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
158
166
|
*/
|
|
159
167
|
createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
|
|
160
168
|
/**
|
|
@@ -174,11 +182,11 @@ declare class RDS extends Service {
|
|
|
174
182
|
*/
|
|
175
183
|
createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
|
|
176
184
|
/**
|
|
177
|
-
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
|
|
185
|
+
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
|
|
178
186
|
*/
|
|
179
187
|
createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
|
|
180
188
|
/**
|
|
181
|
-
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
|
|
189
|
+
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
|
|
182
190
|
*/
|
|
183
191
|
createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
|
|
184
192
|
/**
|
|
@@ -238,11 +246,11 @@ declare class RDS extends Service {
|
|
|
238
246
|
*/
|
|
239
247
|
createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
|
|
240
248
|
/**
|
|
241
|
-
* Creates a new option group. You can create up to 20 option groups.
|
|
249
|
+
* Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
|
|
242
250
|
*/
|
|
243
251
|
createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
|
|
244
252
|
/**
|
|
245
|
-
* Creates a new option group. You can create up to 20 option groups.
|
|
253
|
+
* Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
|
|
246
254
|
*/
|
|
247
255
|
createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
|
|
248
256
|
/**
|
|
@@ -254,11 +262,19 @@ declare class RDS extends Service {
|
|
|
254
262
|
*/
|
|
255
263
|
deleteCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
|
|
256
264
|
/**
|
|
257
|
-
*
|
|
265
|
+
* Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.
|
|
266
|
+
*/
|
|
267
|
+
deleteCustomDBEngineVersion(params: RDS.Types.DeleteCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
268
|
+
/**
|
|
269
|
+
* Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.
|
|
270
|
+
*/
|
|
271
|
+
deleteCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
272
|
+
/**
|
|
273
|
+
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
258
274
|
*/
|
|
259
275
|
deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
|
|
260
276
|
/**
|
|
261
|
-
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
|
|
277
|
+
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
262
278
|
*/
|
|
263
279
|
deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
|
|
264
280
|
/**
|
|
@@ -270,19 +286,19 @@ declare class RDS extends Service {
|
|
|
270
286
|
*/
|
|
271
287
|
deleteDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
272
288
|
/**
|
|
273
|
-
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What
|
|
289
|
+
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
274
290
|
*/
|
|
275
291
|
deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
276
292
|
/**
|
|
277
|
-
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What
|
|
293
|
+
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
278
294
|
*/
|
|
279
295
|
deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
280
296
|
/**
|
|
281
|
-
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What
|
|
297
|
+
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
282
298
|
*/
|
|
283
299
|
deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
|
|
284
300
|
/**
|
|
285
|
-
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What
|
|
301
|
+
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
286
302
|
*/
|
|
287
303
|
deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
|
|
288
304
|
/**
|
|
@@ -414,11 +430,11 @@ declare class RDS extends Service {
|
|
|
414
430
|
*/
|
|
415
431
|
describeCustomAvailabilityZones(callback?: (err: AWSError, data: RDS.Types.CustomAvailabilityZoneMessage) => void): Request<RDS.Types.CustomAvailabilityZoneMessage, AWSError>;
|
|
416
432
|
/**
|
|
417
|
-
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What
|
|
433
|
+
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
|
|
418
434
|
*/
|
|
419
435
|
describeDBClusterBacktracks(params: RDS.Types.DescribeDBClusterBacktracksMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
|
|
420
436
|
/**
|
|
421
|
-
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What
|
|
437
|
+
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
|
|
422
438
|
*/
|
|
423
439
|
describeDBClusterBacktracks(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
|
|
424
440
|
/**
|
|
@@ -430,43 +446,43 @@ declare class RDS extends Service {
|
|
|
430
446
|
*/
|
|
431
447
|
describeDBClusterEndpoints(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
|
|
432
448
|
/**
|
|
433
|
-
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What
|
|
449
|
+
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
434
450
|
*/
|
|
435
451
|
describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
|
|
436
452
|
/**
|
|
437
|
-
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What
|
|
453
|
+
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
438
454
|
*/
|
|
439
455
|
describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
|
|
440
456
|
/**
|
|
441
|
-
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What
|
|
457
|
+
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
442
458
|
*/
|
|
443
459
|
describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
|
|
444
460
|
/**
|
|
445
|
-
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What
|
|
461
|
+
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
446
462
|
*/
|
|
447
463
|
describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
|
|
448
464
|
/**
|
|
449
|
-
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
|
|
465
|
+
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
|
|
450
466
|
*/
|
|
451
467
|
describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
|
|
452
468
|
/**
|
|
453
|
-
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
|
|
469
|
+
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
|
|
454
470
|
*/
|
|
455
471
|
describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
|
|
456
472
|
/**
|
|
457
|
-
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What
|
|
473
|
+
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
458
474
|
*/
|
|
459
475
|
describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
|
|
460
476
|
/**
|
|
461
|
-
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What
|
|
477
|
+
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
462
478
|
*/
|
|
463
479
|
describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
|
|
464
480
|
/**
|
|
465
|
-
* Returns information about
|
|
481
|
+
* Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
|
466
482
|
*/
|
|
467
483
|
describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
|
|
468
484
|
/**
|
|
469
|
-
* Returns information about
|
|
485
|
+
* Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
|
470
486
|
*/
|
|
471
487
|
describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
|
|
472
488
|
/**
|
|
@@ -494,11 +510,11 @@ declare class RDS extends Service {
|
|
|
494
510
|
*/
|
|
495
511
|
describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
|
|
496
512
|
/**
|
|
497
|
-
* Returns a list of DB log files for the DB instance.
|
|
513
|
+
* Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom.
|
|
498
514
|
*/
|
|
499
515
|
describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
|
|
500
516
|
/**
|
|
501
|
-
* Returns a list of DB log files for the DB instance.
|
|
517
|
+
* Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom.
|
|
502
518
|
*/
|
|
503
519
|
describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
|
|
504
520
|
/**
|
|
@@ -582,11 +598,11 @@ declare class RDS extends Service {
|
|
|
582
598
|
*/
|
|
583
599
|
describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
|
|
584
600
|
/**
|
|
585
|
-
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What
|
|
601
|
+
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
|
|
586
602
|
*/
|
|
587
603
|
describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
|
|
588
604
|
/**
|
|
589
|
-
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What
|
|
605
|
+
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
|
|
590
606
|
*/
|
|
591
607
|
describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
|
|
592
608
|
/**
|
|
@@ -630,11 +646,11 @@ declare class RDS extends Service {
|
|
|
630
646
|
*/
|
|
631
647
|
describeExportTasks(callback?: (err: AWSError, data: RDS.Types.ExportTasksMessage) => void): Request<RDS.Types.ExportTasksMessage, AWSError>;
|
|
632
648
|
/**
|
|
633
|
-
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What
|
|
649
|
+
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
634
650
|
*/
|
|
635
651
|
describeGlobalClusters(params: RDS.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
|
|
636
652
|
/**
|
|
637
|
-
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What
|
|
653
|
+
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
638
654
|
*/
|
|
639
655
|
describeGlobalClusters(callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
|
|
640
656
|
/**
|
|
@@ -662,11 +678,11 @@ declare class RDS extends Service {
|
|
|
662
678
|
*/
|
|
663
679
|
describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
|
|
664
680
|
/**
|
|
665
|
-
* Returns a list of orderable DB instance options for the specified engine.
|
|
681
|
+
* Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
|
|
666
682
|
*/
|
|
667
683
|
describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
|
|
668
684
|
/**
|
|
669
|
-
* Returns a list of orderable DB instance options for the specified engine.
|
|
685
|
+
* Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
|
|
670
686
|
*/
|
|
671
687
|
describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
|
|
672
688
|
/**
|
|
@@ -702,27 +718,27 @@ declare class RDS extends Service {
|
|
|
702
718
|
*/
|
|
703
719
|
describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
|
|
704
720
|
/**
|
|
705
|
-
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
|
|
721
|
+
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom.
|
|
706
722
|
*/
|
|
707
723
|
describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
|
|
708
724
|
/**
|
|
709
|
-
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
|
|
725
|
+
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom.
|
|
710
726
|
*/
|
|
711
727
|
describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
|
|
712
728
|
/**
|
|
713
|
-
* Downloads all or a portion of the specified log file, up to 1 MB in size.
|
|
729
|
+
* Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom.
|
|
714
730
|
*/
|
|
715
731
|
downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
|
|
716
732
|
/**
|
|
717
|
-
* Downloads all or a portion of the specified log file, up to 1 MB in size.
|
|
733
|
+
* Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom.
|
|
718
734
|
*/
|
|
719
735
|
downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
|
|
720
736
|
/**
|
|
721
|
-
* Forces a failover for a DB cluster.
|
|
737
|
+
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
722
738
|
*/
|
|
723
739
|
failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
|
|
724
740
|
/**
|
|
725
|
-
* Forces a failover for a DB cluster.
|
|
741
|
+
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
726
742
|
*/
|
|
727
743
|
failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
|
|
728
744
|
/**
|
|
@@ -758,19 +774,27 @@ declare class RDS extends Service {
|
|
|
758
774
|
*/
|
|
759
775
|
modifyCertificates(callback?: (err: AWSError, data: RDS.Types.ModifyCertificatesResult) => void): Request<RDS.Types.ModifyCertificatesResult, AWSError>;
|
|
760
776
|
/**
|
|
761
|
-
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
777
|
+
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora Serverless DB clusters.
|
|
762
778
|
*/
|
|
763
779
|
modifyCurrentDBClusterCapacity(params: RDS.Types.ModifyCurrentDBClusterCapacityMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
|
|
764
780
|
/**
|
|
765
|
-
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
781
|
+
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora Serverless DB clusters.
|
|
766
782
|
*/
|
|
767
783
|
modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
|
|
768
784
|
/**
|
|
769
|
-
*
|
|
785
|
+
* Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
|
|
786
|
+
*/
|
|
787
|
+
modifyCustomDBEngineVersion(params: RDS.Types.ModifyCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
788
|
+
/**
|
|
789
|
+
* Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
|
|
790
|
+
*/
|
|
791
|
+
modifyCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
792
|
+
/**
|
|
793
|
+
* Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
770
794
|
*/
|
|
771
795
|
modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
|
|
772
796
|
/**
|
|
773
|
-
* Modify
|
|
797
|
+
* Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
774
798
|
*/
|
|
775
799
|
modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
|
|
776
800
|
/**
|
|
@@ -782,19 +806,19 @@ declare class RDS extends Service {
|
|
|
782
806
|
*/
|
|
783
807
|
modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
784
808
|
/**
|
|
785
|
-
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
|
|
809
|
+
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
786
810
|
*/
|
|
787
811
|
modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
788
812
|
/**
|
|
789
|
-
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
|
|
813
|
+
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
790
814
|
*/
|
|
791
815
|
modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
792
816
|
/**
|
|
793
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
|
|
817
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
|
|
794
818
|
*/
|
|
795
819
|
modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
|
|
796
820
|
/**
|
|
797
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
|
|
821
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
|
|
798
822
|
*/
|
|
799
823
|
modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
|
|
800
824
|
/**
|
|
@@ -838,11 +862,11 @@ declare class RDS extends Service {
|
|
|
838
862
|
*/
|
|
839
863
|
modifyDBProxyTargetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
|
|
840
864
|
/**
|
|
841
|
-
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL,
|
|
865
|
+
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
|
|
842
866
|
*/
|
|
843
867
|
modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
|
|
844
868
|
/**
|
|
845
|
-
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL,
|
|
869
|
+
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
|
|
846
870
|
*/
|
|
847
871
|
modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
|
|
848
872
|
/**
|
|
@@ -870,11 +894,11 @@ declare class RDS extends Service {
|
|
|
870
894
|
*/
|
|
871
895
|
modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
|
|
872
896
|
/**
|
|
873
|
-
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What
|
|
897
|
+
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
874
898
|
*/
|
|
875
899
|
modifyGlobalCluster(params: RDS.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
|
|
876
900
|
/**
|
|
877
|
-
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What
|
|
901
|
+
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
878
902
|
*/
|
|
879
903
|
modifyGlobalCluster(callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
|
|
880
904
|
/**
|
|
@@ -886,19 +910,19 @@ declare class RDS extends Service {
|
|
|
886
910
|
*/
|
|
887
911
|
modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
|
|
888
912
|
/**
|
|
889
|
-
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL
|
|
913
|
+
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
|
|
890
914
|
*/
|
|
891
915
|
promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
|
|
892
916
|
/**
|
|
893
|
-
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL
|
|
917
|
+
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
|
|
894
918
|
*/
|
|
895
919
|
promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
|
|
896
920
|
/**
|
|
897
|
-
* Promotes a read replica DB cluster to a standalone DB cluster.
|
|
921
|
+
* Promotes a read replica DB cluster to a standalone DB cluster.
|
|
898
922
|
*/
|
|
899
923
|
promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
|
|
900
924
|
/**
|
|
901
|
-
* Promotes a read replica DB cluster to a standalone DB cluster.
|
|
925
|
+
* Promotes a read replica DB cluster to a standalone DB cluster.
|
|
902
926
|
*/
|
|
903
927
|
promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
|
|
904
928
|
/**
|
|
@@ -910,11 +934,19 @@ declare class RDS extends Service {
|
|
|
910
934
|
*/
|
|
911
935
|
purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
|
|
912
936
|
/**
|
|
913
|
-
* You might need to reboot your DB
|
|
937
|
+
* You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect. Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting. Use this operation only for a non-Aurora Multi-AZ DB cluster. The Multi-AZ DB clusters feature is in preview and is subject to change. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
938
|
+
*/
|
|
939
|
+
rebootDBCluster(params: RDS.Types.RebootDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBClusterResult) => void): Request<RDS.Types.RebootDBClusterResult, AWSError>;
|
|
940
|
+
/**
|
|
941
|
+
* You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect. Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting. Use this operation only for a non-Aurora Multi-AZ DB cluster. The Multi-AZ DB clusters feature is in preview and is subject to change. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
942
|
+
*/
|
|
943
|
+
rebootDBCluster(callback?: (err: AWSError, data: RDS.Types.RebootDBClusterResult) => void): Request<RDS.Types.RebootDBClusterResult, AWSError>;
|
|
944
|
+
/**
|
|
945
|
+
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
914
946
|
*/
|
|
915
947
|
rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
916
948
|
/**
|
|
917
|
-
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
|
|
949
|
+
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
918
950
|
*/
|
|
919
951
|
rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
920
952
|
/**
|
|
@@ -926,19 +958,19 @@ declare class RDS extends Service {
|
|
|
926
958
|
*/
|
|
927
959
|
registerDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.RegisterDBProxyTargetsResponse) => void): Request<RDS.Types.RegisterDBProxyTargetsResponse, AWSError>;
|
|
928
960
|
/**
|
|
929
|
-
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different
|
|
961
|
+
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region. This action only applies to Aurora DB clusters.
|
|
930
962
|
*/
|
|
931
963
|
removeFromGlobalCluster(params: RDS.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
|
|
932
964
|
/**
|
|
933
|
-
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different
|
|
965
|
+
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region. This action only applies to Aurora DB clusters.
|
|
934
966
|
*/
|
|
935
967
|
removeFromGlobalCluster(callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
|
|
936
968
|
/**
|
|
937
|
-
*
|
|
969
|
+
* Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
938
970
|
*/
|
|
939
971
|
removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
940
972
|
/**
|
|
941
|
-
*
|
|
973
|
+
* Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
942
974
|
*/
|
|
943
975
|
removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
944
976
|
/**
|
|
@@ -966,11 +998,11 @@ declare class RDS extends Service {
|
|
|
966
998
|
*/
|
|
967
999
|
removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
968
1000
|
/**
|
|
969
|
-
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What
|
|
1001
|
+
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
970
1002
|
*/
|
|
971
1003
|
resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
972
1004
|
/**
|
|
973
|
-
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What
|
|
1005
|
+
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
974
1006
|
*/
|
|
975
1007
|
resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
976
1008
|
/**
|
|
@@ -982,27 +1014,27 @@ declare class RDS extends Service {
|
|
|
982
1014
|
*/
|
|
983
1015
|
resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
|
|
984
1016
|
/**
|
|
985
|
-
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What
|
|
1017
|
+
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
|
|
986
1018
|
*/
|
|
987
1019
|
restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
|
|
988
1020
|
/**
|
|
989
|
-
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What
|
|
1021
|
+
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
|
|
990
1022
|
*/
|
|
991
1023
|
restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
|
|
992
1024
|
/**
|
|
993
|
-
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
|
1025
|
+
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
994
1026
|
*/
|
|
995
1027
|
restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
|
|
996
1028
|
/**
|
|
997
|
-
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
|
1029
|
+
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
998
1030
|
*/
|
|
999
1031
|
restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
|
|
1000
1032
|
/**
|
|
1001
|
-
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
|
|
1033
|
+
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
1002
1034
|
*/
|
|
1003
1035
|
restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
|
|
1004
1036
|
/**
|
|
1005
|
-
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
|
|
1037
|
+
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and is subject to change.
|
|
1006
1038
|
*/
|
|
1007
1039
|
restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
|
|
1008
1040
|
/**
|
|
@@ -1014,11 +1046,11 @@ declare class RDS extends Service {
|
|
|
1014
1046
|
*/
|
|
1015
1047
|
restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
|
|
1016
1048
|
/**
|
|
1017
|
-
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
|
|
1049
|
+
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
1018
1050
|
*/
|
|
1019
1051
|
restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
|
|
1020
1052
|
/**
|
|
1021
|
-
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
|
|
1053
|
+
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
1022
1054
|
*/
|
|
1023
1055
|
restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
|
|
1024
1056
|
/**
|
|
@@ -1054,27 +1086,27 @@ declare class RDS extends Service {
|
|
|
1054
1086
|
*/
|
|
1055
1087
|
startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
|
|
1056
1088
|
/**
|
|
1057
|
-
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1089
|
+
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1058
1090
|
*/
|
|
1059
1091
|
startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
|
|
1060
1092
|
/**
|
|
1061
|
-
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1093
|
+
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1062
1094
|
*/
|
|
1063
1095
|
startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
|
|
1064
1096
|
/**
|
|
1065
|
-
* Enables replication of automated backups to a different Amazon Web Services Region. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1097
|
+
* Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1066
1098
|
*/
|
|
1067
1099
|
startDBInstanceAutomatedBackupsReplication(params: RDS.Types.StartDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1068
1100
|
/**
|
|
1069
|
-
* Enables replication of automated backups to a different Amazon Web Services Region. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1101
|
+
* Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1070
1102
|
*/
|
|
1071
1103
|
startDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1072
1104
|
/**
|
|
1073
|
-
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
|
|
1105
|
+
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. This command doesn't apply to RDS Custom.
|
|
1074
1106
|
*/
|
|
1075
1107
|
startExportTask(params: RDS.Types.StartExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
|
|
1076
1108
|
/**
|
|
1077
|
-
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
|
|
1109
|
+
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. This command doesn't apply to RDS Custom.
|
|
1078
1110
|
*/
|
|
1079
1111
|
startExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
|
|
1080
1112
|
/**
|
|
@@ -1094,19 +1126,19 @@ declare class RDS extends Service {
|
|
|
1094
1126
|
*/
|
|
1095
1127
|
stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
|
|
1096
1128
|
/**
|
|
1097
|
-
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1129
|
+
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1098
1130
|
*/
|
|
1099
1131
|
stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1100
1132
|
/**
|
|
1101
|
-
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1133
|
+
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1102
1134
|
*/
|
|
1103
1135
|
stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1104
1136
|
/**
|
|
1105
|
-
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1137
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1106
1138
|
*/
|
|
1107
1139
|
stopDBInstanceAutomatedBackupsReplication(params: RDS.Types.StopDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1108
1140
|
/**
|
|
1109
|
-
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1141
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1110
1142
|
*/
|
|
1111
1143
|
stopDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1112
1144
|
/**
|
|
@@ -1192,11 +1224,11 @@ declare namespace RDS {
|
|
|
1192
1224
|
*/
|
|
1193
1225
|
DBClusterIdentifier: String;
|
|
1194
1226
|
/**
|
|
1195
|
-
* The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example
|
|
1227
|
+
* The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
|
|
1196
1228
|
*/
|
|
1197
1229
|
RoleArn: String;
|
|
1198
1230
|
/**
|
|
1199
|
-
* The name of the feature for the DB cluster that the IAM role is to be associated with. For
|
|
1231
|
+
* The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
|
|
1200
1232
|
*/
|
|
1201
1233
|
FeatureName?: String;
|
|
1202
1234
|
}
|
|
@@ -1210,7 +1242,7 @@ declare namespace RDS {
|
|
|
1210
1242
|
*/
|
|
1211
1243
|
RoleArn: String;
|
|
1212
1244
|
/**
|
|
1213
|
-
* The name of the feature for the DB instance that the IAM role is to be associated with. For
|
|
1245
|
+
* The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
|
|
1214
1246
|
*/
|
|
1215
1247
|
FeatureName: String;
|
|
1216
1248
|
}
|
|
@@ -1282,6 +1314,7 @@ declare namespace RDS {
|
|
|
1282
1314
|
export interface AuthorizeDBSecurityGroupIngressResult {
|
|
1283
1315
|
DBSecurityGroup?: DBSecurityGroup;
|
|
1284
1316
|
}
|
|
1317
|
+
export type AutomationMode = "full"|"all-paused"|string;
|
|
1285
1318
|
export interface AvailabilityZone {
|
|
1286
1319
|
/**
|
|
1287
1320
|
* The name of the Availability Zone.
|
|
@@ -1326,6 +1359,7 @@ declare namespace RDS {
|
|
|
1326
1359
|
}
|
|
1327
1360
|
export type Boolean = boolean;
|
|
1328
1361
|
export type BooleanOptional = boolean;
|
|
1362
|
+
export type BucketName = string;
|
|
1329
1363
|
export interface CancelExportTaskMessage {
|
|
1330
1364
|
/**
|
|
1331
1365
|
* The identifier of the snapshot export task to cancel.
|
|
@@ -1488,11 +1522,11 @@ declare namespace RDS {
|
|
|
1488
1522
|
*/
|
|
1489
1523
|
TargetDBClusterSnapshotIdentifier: String;
|
|
1490
1524
|
/**
|
|
1491
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS
|
|
1525
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key. If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
|
|
1492
1526
|
*/
|
|
1493
1527
|
KmsKeyId?: String;
|
|
1494
1528
|
/**
|
|
1495
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
1529
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1496
1530
|
*/
|
|
1497
1531
|
PreSignedUrl?: String;
|
|
1498
1532
|
/**
|
|
@@ -1536,7 +1570,7 @@ declare namespace RDS {
|
|
|
1536
1570
|
*/
|
|
1537
1571
|
TargetDBSnapshotIdentifier: String;
|
|
1538
1572
|
/**
|
|
1539
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
1573
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
|
|
1540
1574
|
*/
|
|
1541
1575
|
KmsKeyId?: String;
|
|
1542
1576
|
Tags?: TagList;
|
|
@@ -1545,7 +1579,7 @@ declare namespace RDS {
|
|
|
1545
1579
|
*/
|
|
1546
1580
|
CopyTags?: BooleanOptional;
|
|
1547
1581
|
/**
|
|
1548
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
1582
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1549
1583
|
*/
|
|
1550
1584
|
PreSignedUrl?: String;
|
|
1551
1585
|
/**
|
|
@@ -1603,6 +1637,37 @@ declare namespace RDS {
|
|
|
1603
1637
|
export interface CreateCustomAvailabilityZoneResult {
|
|
1604
1638
|
CustomAvailabilityZone?: CustomAvailabilityZone;
|
|
1605
1639
|
}
|
|
1640
|
+
export interface CreateCustomDBEngineVersionMessage {
|
|
1641
|
+
/**
|
|
1642
|
+
* The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.
|
|
1643
|
+
*/
|
|
1644
|
+
Engine: CustomEngineName;
|
|
1645
|
+
/**
|
|
1646
|
+
* The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
|
|
1647
|
+
*/
|
|
1648
|
+
EngineVersion: CustomEngineVersion;
|
|
1649
|
+
/**
|
|
1650
|
+
* The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
|
|
1651
|
+
*/
|
|
1652
|
+
DatabaseInstallationFilesS3BucketName: BucketName;
|
|
1653
|
+
/**
|
|
1654
|
+
* The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
|
|
1655
|
+
*/
|
|
1656
|
+
DatabaseInstallationFilesS3Prefix?: String255;
|
|
1657
|
+
/**
|
|
1658
|
+
* The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric KMS key in your account, follow the instructions in Creating symmetric KMS keys in the Amazon Web Services Key Management Service Developer Guide. You can choose the same symmetric key when you create a CEV and a DB instance, or choose different keys.
|
|
1659
|
+
*/
|
|
1660
|
+
KMSKeyId: KmsKeyIdOrArn;
|
|
1661
|
+
/**
|
|
1662
|
+
* An optional description of your CEV.
|
|
1663
|
+
*/
|
|
1664
|
+
Description?: Description;
|
|
1665
|
+
/**
|
|
1666
|
+
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. The following JSON fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. databaseInstallationFileNames Ordered list of installation files for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
|
|
1667
|
+
*/
|
|
1668
|
+
Manifest: CustomDBEngineVersionManifest;
|
|
1669
|
+
Tags?: TagList;
|
|
1670
|
+
}
|
|
1606
1671
|
export interface CreateDBClusterEndpointMessage {
|
|
1607
1672
|
/**
|
|
1608
1673
|
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
|
|
@@ -1613,7 +1678,7 @@ declare namespace RDS {
|
|
|
1613
1678
|
*/
|
|
1614
1679
|
DBClusterEndpointIdentifier: String;
|
|
1615
1680
|
/**
|
|
1616
|
-
* The type of the endpoint
|
|
1681
|
+
* The type of the endpoint, one of: READER, WRITER, ANY.
|
|
1617
1682
|
*/
|
|
1618
1683
|
EndpointType: String;
|
|
1619
1684
|
/**
|
|
@@ -1621,7 +1686,7 @@ declare namespace RDS {
|
|
|
1621
1686
|
*/
|
|
1622
1687
|
StaticMembers?: StringList;
|
|
1623
1688
|
/**
|
|
1624
|
-
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint.
|
|
1689
|
+
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
|
|
1625
1690
|
*/
|
|
1626
1691
|
ExcludedMembers?: StringList;
|
|
1627
1692
|
/**
|
|
@@ -1631,137 +1696,181 @@ declare namespace RDS {
|
|
|
1631
1696
|
}
|
|
1632
1697
|
export interface CreateDBClusterMessage {
|
|
1633
1698
|
/**
|
|
1634
|
-
* A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
|
1699
|
+
* A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
1635
1700
|
*/
|
|
1636
1701
|
AvailabilityZones?: AvailabilityZones;
|
|
1637
1702
|
/**
|
|
1638
|
-
* The number of days for which automated backups are retained. Default: 1 Constraints: Must be a value from 1 to 35
|
|
1703
|
+
* The number of days for which automated backups are retained. Default: 1 Constraints: Must be a value from 1 to 35 Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1639
1704
|
*/
|
|
1640
1705
|
BackupRetentionPeriod?: IntegerOptional;
|
|
1641
1706
|
/**
|
|
1642
|
-
* A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
|
1707
|
+
* A value that indicates that the DB cluster should be associated with the specified CharacterSet. Valid for: Aurora DB clusters only
|
|
1643
1708
|
*/
|
|
1644
1709
|
CharacterSetName?: String;
|
|
1645
1710
|
/**
|
|
1646
|
-
* The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
|
|
1711
|
+
* The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1647
1712
|
*/
|
|
1648
1713
|
DatabaseName?: String;
|
|
1649
1714
|
/**
|
|
1650
|
-
* The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
|
|
1715
|
+
* The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1651
1716
|
*/
|
|
1652
1717
|
DBClusterIdentifier: String;
|
|
1653
1718
|
/**
|
|
1654
|
-
* The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group.
|
|
1719
|
+
* The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1655
1720
|
*/
|
|
1656
1721
|
DBClusterParameterGroupName?: String;
|
|
1657
1722
|
/**
|
|
1658
|
-
* A list of EC2 VPC security groups to associate with this DB cluster.
|
|
1723
|
+
* A list of EC2 VPC security groups to associate with this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1659
1724
|
*/
|
|
1660
1725
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
1661
1726
|
/**
|
|
1662
|
-
* A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
|
|
1727
|
+
* A DB subnet group to associate with this DB cluster. This setting is required to create a Multi-AZ DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1663
1728
|
*/
|
|
1664
1729
|
DBSubnetGroupName?: String;
|
|
1665
1730
|
/**
|
|
1666
|
-
* The name of the database engine to be used for this DB cluster. Valid Values:
|
|
1731
|
+
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mysql postgres Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1667
1732
|
*/
|
|
1668
1733
|
Engine: String;
|
|
1669
1734
|
/**
|
|
1670
|
-
* The version number of the database engine to use. To list all of the available engine versions for
|
|
1735
|
+
* The version number of the database engine to use. To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Aurora MySQL For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide. Aurora PostgreSQL For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. MySQL For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1671
1736
|
*/
|
|
1672
1737
|
EngineVersion?: String;
|
|
1673
1738
|
/**
|
|
1674
|
-
* The port number on which the instances in the DB cluster accept connections. Default: 3306
|
|
1739
|
+
* The port number on which the instances in the DB cluster accept connections. RDS for MySQL and Aurora MySQL Default: 3306 Valid values: 1150-65535 RDS for PostgreSQL and Aurora PostgreSQL Default: 5432 Valid values: 1150-65535 Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1675
1740
|
*/
|
|
1676
1741
|
Port?: IntegerOptional;
|
|
1677
1742
|
/**
|
|
1678
|
-
* The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
|
|
1743
|
+
* The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1679
1744
|
*/
|
|
1680
1745
|
MasterUsername?: String;
|
|
1681
1746
|
/**
|
|
1682
|
-
* The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
|
|
1747
|
+
* The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1683
1748
|
*/
|
|
1684
1749
|
MasterUserPassword?: String;
|
|
1685
1750
|
/**
|
|
1686
|
-
* A value that indicates that the DB cluster should be associated with the specified option group.
|
|
1751
|
+
* A value that indicates that the DB cluster should be associated with the specified option group. DB clusters are associated with a default option group that can't be modified.
|
|
1687
1752
|
*/
|
|
1688
1753
|
OptionGroupName?: String;
|
|
1689
1754
|
/**
|
|
1690
|
-
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
|
|
1755
|
+
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1691
1756
|
*/
|
|
1692
1757
|
PreferredBackupWindow?: String;
|
|
1693
1758
|
/**
|
|
1694
|
-
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
|
|
1759
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1695
1760
|
*/
|
|
1696
1761
|
PreferredMaintenanceWindow?: String;
|
|
1697
1762
|
/**
|
|
1698
|
-
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
|
1763
|
+
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only
|
|
1699
1764
|
*/
|
|
1700
1765
|
ReplicationSourceIdentifier?: String;
|
|
1701
1766
|
/**
|
|
1702
|
-
* Tags to assign to the DB cluster.
|
|
1767
|
+
* Tags to assign to the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1703
1768
|
*/
|
|
1704
1769
|
Tags?: TagList;
|
|
1705
1770
|
/**
|
|
1706
|
-
* A value that indicates whether the DB cluster is encrypted.
|
|
1771
|
+
* A value that indicates whether the DB cluster is encrypted. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1707
1772
|
*/
|
|
1708
1773
|
StorageEncrypted?: BooleanOptional;
|
|
1709
1774
|
/**
|
|
1710
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
1775
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1711
1776
|
*/
|
|
1712
1777
|
KmsKeyId?: String;
|
|
1713
1778
|
/**
|
|
1714
|
-
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from.
|
|
1779
|
+
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. Valid for: Aurora DB clusters onlyIf you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1715
1780
|
*/
|
|
1716
1781
|
PreSignedUrl?: String;
|
|
1717
1782
|
/**
|
|
1718
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
1783
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
1719
1784
|
*/
|
|
1720
1785
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
1721
1786
|
/**
|
|
1722
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
1787
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only
|
|
1723
1788
|
*/
|
|
1724
1789
|
BacktrackWindow?: LongOptional;
|
|
1725
1790
|
/**
|
|
1726
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Aurora MySQL Possible values are audit, error, general, and slowquery.
|
|
1791
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. Valid for: Aurora DB clusters only
|
|
1727
1792
|
*/
|
|
1728
1793
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1729
1794
|
/**
|
|
1730
|
-
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Limitations of Aurora Global Databases Limitations of Multi-Master Clusters
|
|
1795
|
+
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Limitations of Aurora Global Databases Limitations of Multi-Master Clusters Valid for: Aurora DB clusters only
|
|
1731
1796
|
*/
|
|
1732
1797
|
EngineMode?: String;
|
|
1733
1798
|
/**
|
|
1734
|
-
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
|
|
1799
|
+
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only
|
|
1735
1800
|
*/
|
|
1736
1801
|
ScalingConfiguration?: ScalingConfiguration;
|
|
1737
1802
|
/**
|
|
1738
|
-
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
1803
|
+
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
1739
1804
|
*/
|
|
1740
1805
|
DeletionProtection?: BooleanOptional;
|
|
1741
1806
|
/**
|
|
1742
|
-
* The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
|
1807
|
+
* The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. Valid for: Aurora DB clusters only
|
|
1743
1808
|
*/
|
|
1744
1809
|
GlobalClusterIdentifier?: String;
|
|
1745
1810
|
/**
|
|
1746
|
-
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
|
|
1811
|
+
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
1747
1812
|
*/
|
|
1748
1813
|
EnableHttpEndpoint?: BooleanOptional;
|
|
1749
1814
|
/**
|
|
1750
|
-
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
|
|
1815
|
+
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters only
|
|
1751
1816
|
*/
|
|
1752
1817
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
1753
1818
|
/**
|
|
1754
|
-
* The Active Directory directory ID to create the DB cluster in. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
1819
|
+
* The Active Directory directory ID to create the DB cluster in. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
1755
1820
|
*/
|
|
1756
1821
|
Domain?: String;
|
|
1757
1822
|
/**
|
|
1758
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
1823
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only
|
|
1759
1824
|
*/
|
|
1760
1825
|
DomainIAMRoleName?: String;
|
|
1761
1826
|
/**
|
|
1762
|
-
* A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
|
|
1827
|
+
* A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then. Valid for: Aurora DB clusters only
|
|
1763
1828
|
*/
|
|
1764
1829
|
EnableGlobalWriteForwarding?: BooleanOptional;
|
|
1830
|
+
/**
|
|
1831
|
+
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for: Multi-AZ DB clusters only
|
|
1832
|
+
*/
|
|
1833
|
+
DBClusterInstanceClass?: String;
|
|
1834
|
+
/**
|
|
1835
|
+
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. This setting is required to create a Multi-AZ DB cluster. Valid for: Multi-AZ DB clusters only
|
|
1836
|
+
*/
|
|
1837
|
+
AllocatedStorage?: IntegerOptional;
|
|
1838
|
+
/**
|
|
1839
|
+
* Specifies the storage type to be associated with the DB cluster. This setting is required to create a Multi-AZ DB cluster. Valid values: standard | gp2 | io1 If you specify io1, also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Valid for: Multi-AZ DB clusters only
|
|
1840
|
+
*/
|
|
1841
|
+
StorageType?: String;
|
|
1842
|
+
/**
|
|
1843
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster. Valid for: Multi-AZ DB clusters only
|
|
1844
|
+
*/
|
|
1845
|
+
Iops?: IntegerOptional;
|
|
1846
|
+
/**
|
|
1847
|
+
* A value that indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Multi-AZ DB clusters only
|
|
1848
|
+
*/
|
|
1849
|
+
PubliclyAccessible?: BooleanOptional;
|
|
1850
|
+
/**
|
|
1851
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for: Multi-AZ DB clusters only
|
|
1852
|
+
*/
|
|
1853
|
+
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
1854
|
+
/**
|
|
1855
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Valid for: Multi-AZ DB clusters only
|
|
1856
|
+
*/
|
|
1857
|
+
MonitoringInterval?: IntegerOptional;
|
|
1858
|
+
/**
|
|
1859
|
+
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only
|
|
1860
|
+
*/
|
|
1861
|
+
MonitoringRoleArn?: String;
|
|
1862
|
+
/**
|
|
1863
|
+
* A value that indicates whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
|
|
1864
|
+
*/
|
|
1865
|
+
EnablePerformanceInsights?: BooleanOptional;
|
|
1866
|
+
/**
|
|
1867
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB clusters only
|
|
1868
|
+
*/
|
|
1869
|
+
PerformanceInsightsKMSKeyId?: String;
|
|
1870
|
+
/**
|
|
1871
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). Valid for: Multi-AZ DB clusters only
|
|
1872
|
+
*/
|
|
1873
|
+
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
1765
1874
|
/**
|
|
1766
1875
|
* The ID of the region that contains the source for the read replica.
|
|
1767
1876
|
*/
|
|
@@ -1769,11 +1878,11 @@ declare namespace RDS {
|
|
|
1769
1878
|
}
|
|
1770
1879
|
export interface CreateDBClusterParameterGroupMessage {
|
|
1771
1880
|
/**
|
|
1772
|
-
* The name of the DB cluster parameter group. Constraints: Must match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.
|
|
1881
|
+
* The name of the DB cluster parameter group. Constraints: Must not match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.
|
|
1773
1882
|
*/
|
|
1774
1883
|
DBClusterParameterGroupName: String;
|
|
1775
1884
|
/**
|
|
1776
|
-
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora5.6, aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql
|
|
1885
|
+
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora5.6, aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres12 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mysql postgres
|
|
1777
1886
|
*/
|
|
1778
1887
|
DBParameterGroupFamily: String;
|
|
1779
1888
|
/**
|
|
@@ -1810,7 +1919,7 @@ declare namespace RDS {
|
|
|
1810
1919
|
}
|
|
1811
1920
|
export interface CreateDBInstanceMessage {
|
|
1812
1921
|
/**
|
|
1813
|
-
* The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster. Constraints: It must contain 1 to 64 alphanumeric characters. It can't be a word reserved by the database engine. Amazon Aurora PostgreSQL The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster. Constraints: It must contain 1 to 63 alphanumeric characters. It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9). It can't be a word reserved by the database engine.
|
|
1922
|
+
* The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters Amazon RDS Custom The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL. Default: ORCL Constraints: It must contain 1 to 8 alphanumeric characters. It must contain a letter. It can't be a word reserved by the database engine. SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster. Constraints: It must contain 1 to 64 alphanumeric characters. It can't be a word reserved by the database engine. Amazon Aurora PostgreSQL The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster. Constraints: It must contain 1 to 63 alphanumeric characters. It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9). It can't be a word reserved by the database engine.
|
|
1814
1923
|
*/
|
|
1815
1924
|
DBName?: String;
|
|
1816
1925
|
/**
|
|
@@ -1818,19 +1927,19 @@ declare namespace RDS {
|
|
|
1818
1927
|
*/
|
|
1819
1928
|
DBInstanceIdentifier: String;
|
|
1820
1929
|
/**
|
|
1821
|
-
* The amount of storage in gibibytes (GiB) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
|
1930
|
+
* The amount of storage in gibibytes (GiB) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Amazon RDS Custom Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536. Provisioned IOPS storage (io1): Must be an integer from 40 to 65536. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
|
1822
1931
|
*/
|
|
1823
1932
|
AllocatedStorage?: IntegerOptional;
|
|
1824
1933
|
/**
|
|
1825
|
-
* The compute and memory capacity of the DB instance, for example
|
|
1934
|
+
* The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
|
|
1826
1935
|
*/
|
|
1827
1936
|
DBInstanceClass: String;
|
|
1828
1937
|
/**
|
|
1829
|
-
* The name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
1938
|
+
* The name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql custom-oracle-ee (for RDS Custom instances) mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
1830
1939
|
*/
|
|
1831
1940
|
Engine: String;
|
|
1832
1941
|
/**
|
|
1833
|
-
* The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster.
|
|
1942
|
+
* The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. Amazon RDS Constraints: Required. Must be 1 to 16 letters, numbers, or underscores. First character must be a letter. Can't be a reserved word for the chosen database engine.
|
|
1834
1943
|
*/
|
|
1835
1944
|
MasterUsername?: String;
|
|
1836
1945
|
/**
|
|
@@ -1858,11 +1967,11 @@ declare namespace RDS {
|
|
|
1858
1967
|
*/
|
|
1859
1968
|
PreferredMaintenanceWindow?: String;
|
|
1860
1969
|
/**
|
|
1861
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
1970
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. This setting doesn't apply to RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
1862
1971
|
*/
|
|
1863
1972
|
DBParameterGroupName?: String;
|
|
1864
1973
|
/**
|
|
1865
|
-
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas
|
|
1974
|
+
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas Can't be set to 0 or 35 for an RDS Custom DB instance
|
|
1866
1975
|
*/
|
|
1867
1976
|
BackupRetentionPeriod?: IntegerOptional;
|
|
1868
1977
|
/**
|
|
@@ -1874,39 +1983,39 @@ declare namespace RDS {
|
|
|
1874
1983
|
*/
|
|
1875
1984
|
Port?: IntegerOptional;
|
|
1876
1985
|
/**
|
|
1877
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
1986
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
|
|
1878
1987
|
*/
|
|
1879
1988
|
MultiAZ?: BooleanOptional;
|
|
1880
1989
|
/**
|
|
1881
|
-
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB
|
|
1990
|
+
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Amazon RDS Custom A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV name has the following format: 19.customized_string . An example identifier is 19.my_cev1. For more information, see Creating an RDS Custom DB instance in the Amazon RDS User Guide.. MariaDB For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
|
|
1882
1991
|
*/
|
|
1883
1992
|
EngineVersion?: String;
|
|
1884
1993
|
/**
|
|
1885
|
-
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
1994
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
|
|
1886
1995
|
*/
|
|
1887
1996
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
1888
1997
|
/**
|
|
1889
|
-
* License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
|
|
1998
|
+
* License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license This setting doesn't apply to RDS Custom.
|
|
1890
1999
|
*/
|
|
1891
2000
|
LicenseModel?: String;
|
|
1892
2001
|
/**
|
|
1893
|
-
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS
|
|
2002
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
|
|
1894
2003
|
*/
|
|
1895
2004
|
Iops?: IntegerOptional;
|
|
1896
2005
|
/**
|
|
1897
|
-
* A value that indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance
|
|
2006
|
+
* A value that indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
1898
2007
|
*/
|
|
1899
2008
|
OptionGroupName?: String;
|
|
1900
2009
|
/**
|
|
1901
|
-
* For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
2010
|
+
* For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet. This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
1902
2011
|
*/
|
|
1903
2012
|
CharacterSetName?: String;
|
|
1904
2013
|
/**
|
|
1905
|
-
* The name of the NCHAR character set for the Oracle DB instance.
|
|
2014
|
+
* The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.
|
|
1906
2015
|
*/
|
|
1907
2016
|
NcharCharacterSetName?: String;
|
|
1908
2017
|
/**
|
|
1909
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC
|
|
2018
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private. If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
|
|
1910
2019
|
*/
|
|
1911
2020
|
PubliclyAccessible?: BooleanOptional;
|
|
1912
2021
|
/**
|
|
@@ -1914,7 +2023,7 @@ declare namespace RDS {
|
|
|
1914
2023
|
*/
|
|
1915
2024
|
Tags?: TagList;
|
|
1916
2025
|
/**
|
|
1917
|
-
* The identifier of the DB cluster that the instance will belong to.
|
|
2026
|
+
* The identifier of the DB cluster that the instance will belong to. This setting doesn't apply to RDS Custom.
|
|
1918
2027
|
*/
|
|
1919
2028
|
DBClusterIdentifier?: String;
|
|
1920
2029
|
/**
|
|
@@ -1922,23 +2031,23 @@ declare namespace RDS {
|
|
|
1922
2031
|
*/
|
|
1923
2032
|
StorageType?: String;
|
|
1924
2033
|
/**
|
|
1925
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
2034
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
1926
2035
|
*/
|
|
1927
2036
|
TdeCredentialArn?: String;
|
|
1928
2037
|
/**
|
|
1929
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
2038
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
1930
2039
|
*/
|
|
1931
2040
|
TdeCredentialPassword?: String;
|
|
1932
2041
|
/**
|
|
1933
|
-
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
2042
|
+
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. For RDS Custom Oracle instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
1934
2043
|
*/
|
|
1935
2044
|
StorageEncrypted?: BooleanOptional;
|
|
1936
2045
|
/**
|
|
1937
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2046
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. Amazon Aurora Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Amazon RDS Custom A KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle doesn't use the default key when this parameter is empty. You must explicitly specify a key.
|
|
1938
2047
|
*/
|
|
1939
2048
|
KmsKeyId?: String;
|
|
1940
2049
|
/**
|
|
1941
|
-
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
2050
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
1942
2051
|
*/
|
|
1943
2052
|
Domain?: String;
|
|
1944
2053
|
/**
|
|
@@ -1946,19 +2055,19 @@ declare namespace RDS {
|
|
|
1946
2055
|
*/
|
|
1947
2056
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
1948
2057
|
/**
|
|
1949
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable
|
|
2058
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
1950
2059
|
*/
|
|
1951
2060
|
MonitoringInterval?: IntegerOptional;
|
|
1952
2061
|
/**
|
|
1953
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,
|
|
2062
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
1954
2063
|
*/
|
|
1955
2064
|
MonitoringRoleArn?: String;
|
|
1956
2065
|
/**
|
|
1957
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
2066
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
1958
2067
|
*/
|
|
1959
2068
|
DomainIAMRoleName?: String;
|
|
1960
2069
|
/**
|
|
1961
|
-
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
|
|
2070
|
+
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15
|
|
1962
2071
|
*/
|
|
1963
2072
|
PromotionTier?: IntegerOptional;
|
|
1964
2073
|
/**
|
|
@@ -1966,41 +2075,49 @@ declare namespace RDS {
|
|
|
1966
2075
|
*/
|
|
1967
2076
|
Timezone?: String;
|
|
1968
2077
|
/**
|
|
1969
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
2078
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
1970
2079
|
*/
|
|
1971
2080
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
1972
2081
|
/**
|
|
1973
|
-
* A value that indicates whether to enable Performance Insights for the DB instance.
|
|
2082
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. This setting doesn't apply to RDS Custom.
|
|
1974
2083
|
*/
|
|
1975
2084
|
EnablePerformanceInsights?: BooleanOptional;
|
|
1976
2085
|
/**
|
|
1977
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2086
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
1978
2087
|
*/
|
|
1979
2088
|
PerformanceInsightsKMSKeyId?: String;
|
|
1980
2089
|
/**
|
|
1981
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
2090
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
1982
2091
|
*/
|
|
1983
2092
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
1984
2093
|
/**
|
|
1985
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine
|
|
2094
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. RDS Custom Not applicable. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, trace, and oemagent. PostgreSQL Possible values are postgresql and upgrade.
|
|
1986
2095
|
*/
|
|
1987
2096
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1988
2097
|
/**
|
|
1989
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
2098
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
1990
2099
|
*/
|
|
1991
2100
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
1992
2101
|
/**
|
|
1993
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
2102
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
1994
2103
|
*/
|
|
1995
2104
|
DeletionProtection?: BooleanOptional;
|
|
1996
2105
|
/**
|
|
1997
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
2106
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
1998
2107
|
*/
|
|
1999
2108
|
MaxAllocatedStorage?: IntegerOptional;
|
|
2000
2109
|
/**
|
|
2001
2110
|
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
2002
2111
|
*/
|
|
2003
2112
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
2113
|
+
/**
|
|
2114
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
2115
|
+
*/
|
|
2116
|
+
CustomIamInstanceProfile?: String;
|
|
2117
|
+
/**
|
|
2118
|
+
* Specifies where automated backups and manual snapshots are stored. Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region. For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
|
|
2119
|
+
*/
|
|
2120
|
+
BackupTarget?: String;
|
|
2004
2121
|
}
|
|
2005
2122
|
export interface CreateDBInstanceReadReplicaMessage {
|
|
2006
2123
|
/**
|
|
@@ -2008,11 +2125,11 @@ declare namespace RDS {
|
|
|
2008
2125
|
*/
|
|
2009
2126
|
DBInstanceIdentifier: String;
|
|
2010
2127
|
/**
|
|
2011
|
-
* The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-
|
|
2128
|
+
* The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region replication). The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
|
|
2012
2129
|
*/
|
|
2013
2130
|
SourceDBInstanceIdentifier: String;
|
|
2014
2131
|
/**
|
|
2015
|
-
* The compute and memory capacity of the read replica, for example
|
|
2132
|
+
* The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance.
|
|
2016
2133
|
*/
|
|
2017
2134
|
DBInstanceClass?: String;
|
|
2018
2135
|
/**
|
|
@@ -2024,11 +2141,11 @@ declare namespace RDS {
|
|
|
2024
2141
|
*/
|
|
2025
2142
|
Port?: IntegerOptional;
|
|
2026
2143
|
/**
|
|
2027
|
-
* A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
|
|
2144
|
+
* A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance. This setting doesn't apply to RDS Custom.
|
|
2028
2145
|
*/
|
|
2029
2146
|
MultiAZ?: BooleanOptional;
|
|
2030
2147
|
/**
|
|
2031
|
-
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. Default: Inherits from the source DB instance
|
|
2148
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. This setting doesn't apply to RDS Custom. Default: Inherits from the source DB instance
|
|
2032
2149
|
*/
|
|
2033
2150
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
2034
2151
|
/**
|
|
@@ -2036,15 +2153,15 @@ declare namespace RDS {
|
|
|
2036
2153
|
*/
|
|
2037
2154
|
Iops?: IntegerOptional;
|
|
2038
2155
|
/**
|
|
2039
|
-
* The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance.
|
|
2156
|
+
* The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance. This setting doesn't apply to RDS Custom.
|
|
2040
2157
|
*/
|
|
2041
2158
|
OptionGroupName?: String;
|
|
2042
2159
|
/**
|
|
2043
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same
|
|
2160
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica. Specifying a parameter group for this operation is only supported for Oracle DB instances. It isn't supported for RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
2044
2161
|
*/
|
|
2045
2162
|
DBParameterGroupName?: String;
|
|
2046
2163
|
/**
|
|
2047
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB
|
|
2164
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
|
2048
2165
|
*/
|
|
2049
2166
|
PubliclyAccessible?: BooleanOptional;
|
|
2050
2167
|
Tags?: TagList;
|
|
@@ -2053,7 +2170,7 @@ declare namespace RDS {
|
|
|
2053
2170
|
*/
|
|
2054
2171
|
DBSubnetGroupName?: String;
|
|
2055
2172
|
/**
|
|
2056
|
-
* A list of EC2 VPC security groups to associate with the read replica.
|
|
2173
|
+
* A list of Amazon EC2 VPC security groups to associate with the read replica. This setting doesn't apply to RDS Custom. Default: The default EC2 VPC security group for the DB subnet group's VPC.
|
|
2057
2174
|
*/
|
|
2058
2175
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
2059
2176
|
/**
|
|
@@ -2065,69 +2182,73 @@ declare namespace RDS {
|
|
|
2065
2182
|
*/
|
|
2066
2183
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
2067
2184
|
/**
|
|
2068
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
2185
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
2069
2186
|
*/
|
|
2070
2187
|
MonitoringInterval?: IntegerOptional;
|
|
2071
2188
|
/**
|
|
2072
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
|
|
2189
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
2073
2190
|
*/
|
|
2074
2191
|
MonitoringRoleArn?: String;
|
|
2075
2192
|
/**
|
|
2076
|
-
* The Amazon Web Services KMS key identifier for an encrypted read replica. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2193
|
+
* The Amazon Web Services KMS key identifier for an encrypted read replica. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance. If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. You can't create an encrypted read replica from an unencrypted DB instance. This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
|
|
2077
2194
|
*/
|
|
2078
2195
|
KmsKeyId?: String;
|
|
2079
2196
|
/**
|
|
2080
|
-
* The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-
|
|
2197
|
+
* The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-Region read replicas. This setting doesn't apply to RDS Custom.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
2081
2198
|
*/
|
|
2082
2199
|
PreSignedUrl?: String;
|
|
2083
2200
|
/**
|
|
2084
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
2201
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2085
2202
|
*/
|
|
2086
2203
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
2087
2204
|
/**
|
|
2088
|
-
* A value that indicates whether to enable Performance Insights for the read replica.
|
|
2205
|
+
* A value that indicates whether to enable Performance Insights for the read replica. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2089
2206
|
*/
|
|
2090
2207
|
EnablePerformanceInsights?: BooleanOptional;
|
|
2091
2208
|
/**
|
|
2092
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2209
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
2093
2210
|
*/
|
|
2094
2211
|
PerformanceInsightsKMSKeyId?: String;
|
|
2095
2212
|
/**
|
|
2096
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
2213
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
2097
2214
|
*/
|
|
2098
2215
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2099
2216
|
/**
|
|
2100
|
-
* The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
2217
|
+
* The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2101
2218
|
*/
|
|
2102
2219
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
2103
2220
|
/**
|
|
2104
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
2221
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
2105
2222
|
*/
|
|
2106
2223
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
2107
2224
|
/**
|
|
2108
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
2225
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
2109
2226
|
*/
|
|
2110
2227
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
2111
2228
|
/**
|
|
2112
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
2229
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
|
2113
2230
|
*/
|
|
2114
2231
|
DeletionProtection?: BooleanOptional;
|
|
2115
2232
|
/**
|
|
2116
|
-
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
2233
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2117
2234
|
*/
|
|
2118
2235
|
Domain?: String;
|
|
2119
2236
|
/**
|
|
2120
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
2237
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
2121
2238
|
*/
|
|
2122
2239
|
DomainIAMRoleName?: String;
|
|
2123
2240
|
/**
|
|
2124
|
-
* The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
|
|
2241
|
+
* The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.
|
|
2125
2242
|
*/
|
|
2126
2243
|
ReplicaMode?: ReplicaMode;
|
|
2127
2244
|
/**
|
|
2128
2245
|
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
2129
2246
|
*/
|
|
2130
2247
|
MaxAllocatedStorage?: IntegerOptional;
|
|
2248
|
+
/**
|
|
2249
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
2250
|
+
*/
|
|
2251
|
+
CustomIamInstanceProfile?: String;
|
|
2131
2252
|
/**
|
|
2132
2253
|
* The ID of the region that contains the source for the read replica.
|
|
2133
2254
|
*/
|
|
@@ -2406,6 +2527,10 @@ declare namespace RDS {
|
|
|
2406
2527
|
*/
|
|
2407
2528
|
CustomAvailabilityZones?: CustomAvailabilityZoneList;
|
|
2408
2529
|
}
|
|
2530
|
+
export type CustomDBEngineVersionManifest = string;
|
|
2531
|
+
export type CustomEngineName = string;
|
|
2532
|
+
export type CustomEngineVersion = string;
|
|
2533
|
+
export type CustomEngineVersionStatus = "available"|"inactive"|"inactive-except-restore"|string;
|
|
2409
2534
|
export interface DBCluster {
|
|
2410
2535
|
/**
|
|
2411
2536
|
* For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
|
|
@@ -2528,11 +2653,11 @@ declare namespace RDS {
|
|
|
2528
2653
|
*/
|
|
2529
2654
|
StorageEncrypted?: Boolean;
|
|
2530
2655
|
/**
|
|
2531
|
-
* If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2656
|
+
* If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2532
2657
|
*/
|
|
2533
2658
|
KmsKeyId?: String;
|
|
2534
2659
|
/**
|
|
2535
|
-
* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the
|
|
2660
|
+
* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
|
|
2536
2661
|
*/
|
|
2537
2662
|
DbClusterResourceId?: String;
|
|
2538
2663
|
/**
|
|
@@ -2597,7 +2722,7 @@ declare namespace RDS {
|
|
|
2597
2722
|
*/
|
|
2598
2723
|
ActivityStreamStatus?: ActivityStreamStatus;
|
|
2599
2724
|
/**
|
|
2600
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2725
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2601
2726
|
*/
|
|
2602
2727
|
ActivityStreamKmsKeyId?: String;
|
|
2603
2728
|
/**
|
|
@@ -2629,6 +2754,46 @@ declare namespace RDS {
|
|
|
2629
2754
|
* A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
|
|
2630
2755
|
*/
|
|
2631
2756
|
PendingModifiedValues?: ClusterPendingModifiedValues;
|
|
2757
|
+
/**
|
|
2758
|
+
* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2759
|
+
*/
|
|
2760
|
+
DBClusterInstanceClass?: String;
|
|
2761
|
+
/**
|
|
2762
|
+
* The storage type associated with DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2763
|
+
*/
|
|
2764
|
+
StorageType?: String;
|
|
2765
|
+
/**
|
|
2766
|
+
* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2767
|
+
*/
|
|
2768
|
+
Iops?: IntegerOptional;
|
|
2769
|
+
/**
|
|
2770
|
+
* Specifies the accessibility options for the DB instance. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2771
|
+
*/
|
|
2772
|
+
PubliclyAccessible?: BooleanOptional;
|
|
2773
|
+
/**
|
|
2774
|
+
* A value that indicates that minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2775
|
+
*/
|
|
2776
|
+
AutoMinorVersionUpgrade?: Boolean;
|
|
2777
|
+
/**
|
|
2778
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2779
|
+
*/
|
|
2780
|
+
MonitoringInterval?: IntegerOptional;
|
|
2781
|
+
/**
|
|
2782
|
+
* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2783
|
+
*/
|
|
2784
|
+
MonitoringRoleArn?: String;
|
|
2785
|
+
/**
|
|
2786
|
+
* True if Performance Insights is enabled for the DB cluster, and otherwise false. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2787
|
+
*/
|
|
2788
|
+
PerformanceInsightsEnabled?: BooleanOptional;
|
|
2789
|
+
/**
|
|
2790
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2791
|
+
*/
|
|
2792
|
+
PerformanceInsightsKMSKeyId?: String;
|
|
2793
|
+
/**
|
|
2794
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2795
|
+
*/
|
|
2796
|
+
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2632
2797
|
}
|
|
2633
2798
|
export interface DBClusterBacktrack {
|
|
2634
2799
|
/**
|
|
@@ -2839,7 +3004,7 @@ declare namespace RDS {
|
|
|
2839
3004
|
*/
|
|
2840
3005
|
Status?: String;
|
|
2841
3006
|
/**
|
|
2842
|
-
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For
|
|
3007
|
+
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
|
|
2843
3008
|
*/
|
|
2844
3009
|
FeatureName?: String;
|
|
2845
3010
|
}
|
|
@@ -2914,7 +3079,7 @@ declare namespace RDS {
|
|
|
2914
3079
|
*/
|
|
2915
3080
|
StorageEncrypted?: Boolean;
|
|
2916
3081
|
/**
|
|
2917
|
-
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3082
|
+
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2918
3083
|
*/
|
|
2919
3084
|
KmsKeyId?: String;
|
|
2920
3085
|
/**
|
|
@@ -3021,7 +3186,7 @@ declare namespace RDS {
|
|
|
3021
3186
|
*/
|
|
3022
3187
|
SupportedEngineModes?: EngineModeList;
|
|
3023
3188
|
/**
|
|
3024
|
-
* A list of features supported by the DB engine.
|
|
3189
|
+
* A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version> For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: aws rds describe-db-engine-versions --engine postgres --engine-version 13.3 The supported features are listed under SupportedFeatureNames in the output.
|
|
3025
3190
|
*/
|
|
3026
3191
|
SupportedFeatureNames?: FeatureNameList;
|
|
3027
3192
|
/**
|
|
@@ -3036,6 +3201,31 @@ declare namespace RDS {
|
|
|
3036
3201
|
* A value that indicates whether you can use Aurora global databases with a specific DB engine version.
|
|
3037
3202
|
*/
|
|
3038
3203
|
SupportsGlobalDatabases?: Boolean;
|
|
3204
|
+
/**
|
|
3205
|
+
* The major engine version of the CEV.
|
|
3206
|
+
*/
|
|
3207
|
+
MajorEngineVersion?: String;
|
|
3208
|
+
/**
|
|
3209
|
+
* The name of the Amazon S3 bucket that contains your database installation files.
|
|
3210
|
+
*/
|
|
3211
|
+
DatabaseInstallationFilesS3BucketName?: String;
|
|
3212
|
+
/**
|
|
3213
|
+
* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
|
|
3214
|
+
*/
|
|
3215
|
+
DatabaseInstallationFilesS3Prefix?: String;
|
|
3216
|
+
/**
|
|
3217
|
+
* The ARN of the custom engine version.
|
|
3218
|
+
*/
|
|
3219
|
+
DBEngineVersionArn?: String;
|
|
3220
|
+
/**
|
|
3221
|
+
* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
|
|
3222
|
+
*/
|
|
3223
|
+
KMSKeyId?: String;
|
|
3224
|
+
/**
|
|
3225
|
+
* The creation time of the DB engine version.
|
|
3226
|
+
*/
|
|
3227
|
+
CreateTime?: TStamp;
|
|
3228
|
+
TagList?: TagList;
|
|
3039
3229
|
}
|
|
3040
3230
|
export type DBEngineVersionList = DBEngineVersion[];
|
|
3041
3231
|
export interface DBEngineVersionMessage {
|
|
@@ -3130,7 +3320,7 @@ declare namespace RDS {
|
|
|
3130
3320
|
*/
|
|
3131
3321
|
LatestRestorableTime?: TStamp;
|
|
3132
3322
|
/**
|
|
3133
|
-
* Specifies if the DB instance is a Multi-AZ deployment.
|
|
3323
|
+
* Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
|
|
3134
3324
|
*/
|
|
3135
3325
|
MultiAZ?: Boolean;
|
|
3136
3326
|
/**
|
|
@@ -3150,7 +3340,7 @@ declare namespace RDS {
|
|
|
3150
3340
|
*/
|
|
3151
3341
|
ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
|
|
3152
3342
|
/**
|
|
3153
|
-
* Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output
|
|
3343
|
+
* Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
|
|
3154
3344
|
*/
|
|
3155
3345
|
ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
|
|
3156
3346
|
/**
|
|
@@ -3158,7 +3348,7 @@ declare namespace RDS {
|
|
|
3158
3348
|
*/
|
|
3159
3349
|
ReplicaMode?: ReplicaMode;
|
|
3160
3350
|
/**
|
|
3161
|
-
* License model information for this DB instance.
|
|
3351
|
+
* License model information for this DB instance. This setting doesn't apply to RDS Custom.
|
|
3162
3352
|
*/
|
|
3163
3353
|
LicenseModel?: String;
|
|
3164
3354
|
/**
|
|
@@ -3182,7 +3372,7 @@ declare namespace RDS {
|
|
|
3182
3372
|
*/
|
|
3183
3373
|
SecondaryAvailabilityZone?: String;
|
|
3184
3374
|
/**
|
|
3185
|
-
* Specifies the accessibility options for the DB instance. When the DB
|
|
3375
|
+
* Specifies the accessibility options for the DB instance. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
|
3186
3376
|
*/
|
|
3187
3377
|
PubliclyAccessible?: Boolean;
|
|
3188
3378
|
/**
|
|
@@ -3210,11 +3400,11 @@ declare namespace RDS {
|
|
|
3210
3400
|
*/
|
|
3211
3401
|
StorageEncrypted?: Boolean;
|
|
3212
3402
|
/**
|
|
3213
|
-
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3403
|
+
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3214
3404
|
*/
|
|
3215
3405
|
KmsKeyId?: String;
|
|
3216
3406
|
/**
|
|
3217
|
-
* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS
|
|
3407
|
+
* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
|
|
3218
3408
|
*/
|
|
3219
3409
|
DbiResourceId?: String;
|
|
3220
3410
|
/**
|
|
@@ -3262,7 +3452,7 @@ declare namespace RDS {
|
|
|
3262
3452
|
*/
|
|
3263
3453
|
PerformanceInsightsEnabled?: BooleanOptional;
|
|
3264
3454
|
/**
|
|
3265
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3455
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3266
3456
|
*/
|
|
3267
3457
|
PerformanceInsightsKMSKeyId?: String;
|
|
3268
3458
|
/**
|
|
@@ -3311,7 +3501,7 @@ declare namespace RDS {
|
|
|
3311
3501
|
*/
|
|
3312
3502
|
ActivityStreamStatus?: ActivityStreamStatus;
|
|
3313
3503
|
/**
|
|
3314
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3504
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3315
3505
|
*/
|
|
3316
3506
|
ActivityStreamKmsKeyId?: String;
|
|
3317
3507
|
/**
|
|
@@ -3326,6 +3516,22 @@ declare namespace RDS {
|
|
|
3326
3516
|
* Indicates whether engine-native audit fields are included in the database activity stream.
|
|
3327
3517
|
*/
|
|
3328
3518
|
ActivityStreamEngineNativeAuditFieldsIncluded?: BooleanOptional;
|
|
3519
|
+
/**
|
|
3520
|
+
* The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
|
|
3521
|
+
*/
|
|
3522
|
+
AutomationMode?: AutomationMode;
|
|
3523
|
+
/**
|
|
3524
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
3525
|
+
*/
|
|
3526
|
+
ResumeFullAutomationModeTime?: TStamp;
|
|
3527
|
+
/**
|
|
3528
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide.
|
|
3529
|
+
*/
|
|
3530
|
+
CustomIamInstanceProfile?: String;
|
|
3531
|
+
/**
|
|
3532
|
+
* Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
|
|
3533
|
+
*/
|
|
3534
|
+
BackupTarget?: String;
|
|
3329
3535
|
}
|
|
3330
3536
|
export interface DBInstanceAutomatedBackup {
|
|
3331
3537
|
/**
|
|
@@ -3409,7 +3615,7 @@ declare namespace RDS {
|
|
|
3409
3615
|
*/
|
|
3410
3616
|
StorageType?: String;
|
|
3411
3617
|
/**
|
|
3412
|
-
* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3618
|
+
* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3413
3619
|
*/
|
|
3414
3620
|
KmsKeyId?: String;
|
|
3415
3621
|
/**
|
|
@@ -3432,6 +3638,10 @@ declare namespace RDS {
|
|
|
3432
3638
|
* The list of replications to different Amazon Web Services Regions associated with the automated backup.
|
|
3433
3639
|
*/
|
|
3434
3640
|
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplicationList;
|
|
3641
|
+
/**
|
|
3642
|
+
* Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
|
|
3643
|
+
*/
|
|
3644
|
+
BackupTarget?: String;
|
|
3435
3645
|
}
|
|
3436
3646
|
export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[];
|
|
3437
3647
|
export interface DBInstanceAutomatedBackupMessage {
|
|
@@ -3468,7 +3678,7 @@ declare namespace RDS {
|
|
|
3468
3678
|
*/
|
|
3469
3679
|
RoleArn?: String;
|
|
3470
3680
|
/**
|
|
3471
|
-
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For
|
|
3681
|
+
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
|
|
3472
3682
|
*/
|
|
3473
3683
|
FeatureName?: String;
|
|
3474
3684
|
/**
|
|
@@ -3878,7 +4088,7 @@ declare namespace RDS {
|
|
|
3878
4088
|
*/
|
|
3879
4089
|
Encrypted?: Boolean;
|
|
3880
4090
|
/**
|
|
3881
|
-
* If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
4091
|
+
* If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3882
4092
|
*/
|
|
3883
4093
|
KmsKeyId?: String;
|
|
3884
4094
|
/**
|
|
@@ -3906,6 +4116,10 @@ declare namespace RDS {
|
|
|
3906
4116
|
* Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
|
|
3907
4117
|
*/
|
|
3908
4118
|
OriginalSnapshotCreateTime?: TStamp;
|
|
4119
|
+
/**
|
|
4120
|
+
* Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
|
|
4121
|
+
*/
|
|
4122
|
+
SnapshotTarget?: String;
|
|
3909
4123
|
}
|
|
3910
4124
|
export interface DBSnapshotAttribute {
|
|
3911
4125
|
/**
|
|
@@ -3985,6 +4199,16 @@ declare namespace RDS {
|
|
|
3985
4199
|
export interface DeleteCustomAvailabilityZoneResult {
|
|
3986
4200
|
CustomAvailabilityZone?: CustomAvailabilityZone;
|
|
3987
4201
|
}
|
|
4202
|
+
export interface DeleteCustomDBEngineVersionMessage {
|
|
4203
|
+
/**
|
|
4204
|
+
* The database engine. The only supported engine is custom-oracle-ee.
|
|
4205
|
+
*/
|
|
4206
|
+
Engine: CustomEngineName;
|
|
4207
|
+
/**
|
|
4208
|
+
* The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
|
|
4209
|
+
*/
|
|
4210
|
+
EngineVersion: CustomEngineVersion;
|
|
4211
|
+
}
|
|
3988
4212
|
export interface DeleteDBClusterEndpointMessage {
|
|
3989
4213
|
/**
|
|
3990
4214
|
* The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
|
|
@@ -4029,7 +4253,7 @@ declare namespace RDS {
|
|
|
4029
4253
|
*/
|
|
4030
4254
|
DbiResourceId?: String;
|
|
4031
4255
|
/**
|
|
4032
|
-
* The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
4256
|
+
* The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting doesn't apply to RDS Custom.
|
|
4033
4257
|
*/
|
|
4034
4258
|
DBInstanceAutomatedBackupsArn?: String;
|
|
4035
4259
|
}
|
|
@@ -4042,11 +4266,11 @@ declare namespace RDS {
|
|
|
4042
4266
|
*/
|
|
4043
4267
|
DBInstanceIdentifier: String;
|
|
4044
4268
|
/**
|
|
4045
|
-
* A value that indicates whether to skip the creation of a final DB snapshot before the
|
|
4269
|
+
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter. If you delete a read replica or an RDS Custom instance, you must enable this setting. This setting is required for RDS Custom.
|
|
4046
4270
|
*/
|
|
4047
4271
|
SkipFinalSnapshot?: Boolean;
|
|
4048
4272
|
/**
|
|
4049
|
-
* The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
|
|
4273
|
+
* The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. This setting doesn't apply to RDS Custom. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified when deleting a read replica.
|
|
4050
4274
|
*/
|
|
4051
4275
|
FinalDBSnapshotIdentifier?: String;
|
|
4052
4276
|
/**
|
|
@@ -4375,11 +4599,11 @@ declare namespace RDS {
|
|
|
4375
4599
|
*/
|
|
4376
4600
|
DefaultOnly?: Boolean;
|
|
4377
4601
|
/**
|
|
4378
|
-
* A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
|
|
4602
|
+
* A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.
|
|
4379
4603
|
*/
|
|
4380
4604
|
ListSupportedCharacterSets?: BooleanOptional;
|
|
4381
4605
|
/**
|
|
4382
|
-
* A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
|
|
4606
|
+
* A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version. For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.
|
|
4383
4607
|
*/
|
|
4384
4608
|
ListSupportedTimezones?: BooleanOptional;
|
|
4385
4609
|
/**
|
|
@@ -4409,7 +4633,7 @@ declare namespace RDS {
|
|
|
4409
4633
|
*/
|
|
4410
4634
|
Marker?: String;
|
|
4411
4635
|
/**
|
|
4412
|
-
* The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
4636
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting doesn't apply to RDS Custom.
|
|
4413
4637
|
*/
|
|
4414
4638
|
DBInstanceAutomatedBackupsArn?: String;
|
|
4415
4639
|
}
|
|
@@ -4703,11 +4927,11 @@ declare namespace RDS {
|
|
|
4703
4927
|
*/
|
|
4704
4928
|
Marker?: String;
|
|
4705
4929
|
/**
|
|
4706
|
-
* A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
|
|
4930
|
+
* A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action. This setting doesn't apply to RDS Custom.
|
|
4707
4931
|
*/
|
|
4708
4932
|
IncludeShared?: Boolean;
|
|
4709
4933
|
/**
|
|
4710
|
-
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
|
|
4934
|
+
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom.
|
|
4711
4935
|
*/
|
|
4712
4936
|
IncludePublic?: Boolean;
|
|
4713
4937
|
/**
|
|
@@ -4851,7 +5075,7 @@ declare namespace RDS {
|
|
|
4851
5075
|
*/
|
|
4852
5076
|
SourceArn?: String;
|
|
4853
5077
|
/**
|
|
4854
|
-
* Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase
|
|
5078
|
+
* Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase. Valid statuses are the following: canceled canceling complete failed in_progress starting
|
|
4855
5079
|
*/
|
|
4856
5080
|
Filters?: FilterList;
|
|
4857
5081
|
/**
|
|
@@ -4961,15 +5185,15 @@ declare namespace RDS {
|
|
|
4961
5185
|
*/
|
|
4962
5186
|
DBInstanceClass?: String;
|
|
4963
5187
|
/**
|
|
4964
|
-
* The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
|
|
5188
|
+
* The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. RDS Custom supports only the BYOL licensing model.
|
|
4965
5189
|
*/
|
|
4966
5190
|
LicenseModel?: String;
|
|
4967
5191
|
/**
|
|
4968
|
-
* The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
|
|
5192
|
+
* The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
4969
5193
|
*/
|
|
4970
5194
|
AvailabilityZoneGroup?: String;
|
|
4971
5195
|
/**
|
|
4972
|
-
* A value that indicates whether to show only VPC or non-VPC offerings.
|
|
5196
|
+
* A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
|
|
4973
5197
|
*/
|
|
4974
5198
|
Vpc?: BooleanOptional;
|
|
4975
5199
|
/**
|
|
@@ -5114,6 +5338,7 @@ declare namespace RDS {
|
|
|
5114
5338
|
export interface DescribeValidDBInstanceModificationsResult {
|
|
5115
5339
|
ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage;
|
|
5116
5340
|
}
|
|
5341
|
+
export type Description = string;
|
|
5117
5342
|
export interface DomainMembership {
|
|
5118
5343
|
/**
|
|
5119
5344
|
* The identifier of the Active Directory Domain.
|
|
@@ -5373,7 +5598,7 @@ declare namespace RDS {
|
|
|
5373
5598
|
*/
|
|
5374
5599
|
IamRoleArn?: String;
|
|
5375
5600
|
/**
|
|
5376
|
-
* The key identifier of the Amazon Web Services KMS
|
|
5601
|
+
* The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
|
|
5377
5602
|
*/
|
|
5378
5603
|
KmsKeyId?: String;
|
|
5379
5604
|
/**
|
|
@@ -5414,7 +5639,7 @@ declare namespace RDS {
|
|
|
5414
5639
|
*/
|
|
5415
5640
|
DBClusterIdentifier: String;
|
|
5416
5641
|
/**
|
|
5417
|
-
* The name of the instance to promote to the primary instance.
|
|
5642
|
+
* The name of the DB instance to promote to the primary DB instance. Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1. This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
|
|
5418
5643
|
*/
|
|
5419
5644
|
TargetDBInstanceIdentifier?: String;
|
|
5420
5645
|
}
|
|
@@ -5468,7 +5693,7 @@ declare namespace RDS {
|
|
|
5468
5693
|
*/
|
|
5469
5694
|
GlobalClusterIdentifier?: String;
|
|
5470
5695
|
/**
|
|
5471
|
-
* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS
|
|
5696
|
+
* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
|
|
5472
5697
|
*/
|
|
5473
5698
|
GlobalClusterResourceId?: String;
|
|
5474
5699
|
/**
|
|
@@ -5627,6 +5852,7 @@ declare namespace RDS {
|
|
|
5627
5852
|
export type Integer = number;
|
|
5628
5853
|
export type IntegerOptional = number;
|
|
5629
5854
|
export type KeyList = String[];
|
|
5855
|
+
export type KmsKeyIdOrArn = string;
|
|
5630
5856
|
export interface ListTagsForResourceMessage {
|
|
5631
5857
|
/**
|
|
5632
5858
|
* The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
|
|
@@ -5675,7 +5901,7 @@ declare namespace RDS {
|
|
|
5675
5901
|
*/
|
|
5676
5902
|
Capacity?: IntegerOptional;
|
|
5677
5903
|
/**
|
|
5678
|
-
* The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
|
|
5904
|
+
* The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 10 and 600 seconds.
|
|
5679
5905
|
*/
|
|
5680
5906
|
SecondsBeforeTimeout?: IntegerOptional;
|
|
5681
5907
|
/**
|
|
@@ -5683,6 +5909,24 @@ declare namespace RDS {
|
|
|
5683
5909
|
*/
|
|
5684
5910
|
TimeoutAction?: String;
|
|
5685
5911
|
}
|
|
5912
|
+
export interface ModifyCustomDBEngineVersionMessage {
|
|
5913
|
+
/**
|
|
5914
|
+
* The DB engine. The only supported value is custom-oracle-ee.
|
|
5915
|
+
*/
|
|
5916
|
+
Engine: CustomEngineName;
|
|
5917
|
+
/**
|
|
5918
|
+
* The custom engine version (CEV) that you want to modify. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
|
|
5919
|
+
*/
|
|
5920
|
+
EngineVersion: CustomEngineVersion;
|
|
5921
|
+
/**
|
|
5922
|
+
* An optional description of your CEV.
|
|
5923
|
+
*/
|
|
5924
|
+
Description?: Description;
|
|
5925
|
+
/**
|
|
5926
|
+
* The availability status to be assigned to the CEV. Valid values are as follows: available You can use this CEV to create a new RDS Custom DB instance. inactive You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV. You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
|
|
5927
|
+
*/
|
|
5928
|
+
Status?: CustomEngineVersionStatus;
|
|
5929
|
+
}
|
|
5686
5930
|
export interface ModifyDBClusterEndpointMessage {
|
|
5687
5931
|
/**
|
|
5688
5932
|
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
|
|
@@ -5703,101 +5947,141 @@ declare namespace RDS {
|
|
|
5703
5947
|
}
|
|
5704
5948
|
export interface ModifyDBClusterMessage {
|
|
5705
5949
|
/**
|
|
5706
|
-
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: This identifier must match the identifier of an existing DB cluster.
|
|
5950
|
+
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: This identifier must match the identifier of an existing DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5707
5951
|
*/
|
|
5708
5952
|
DBClusterIdentifier: String;
|
|
5709
5953
|
/**
|
|
5710
|
-
* The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
|
|
5954
|
+
* The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2 Valid for: Aurora DB clusters only
|
|
5711
5955
|
*/
|
|
5712
5956
|
NewDBClusterIdentifier?: String;
|
|
5713
5957
|
/**
|
|
5714
|
-
* A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. By default, this parameter is disabled.
|
|
5958
|
+
* A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. By default, this parameter is disabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5715
5959
|
*/
|
|
5716
5960
|
ApplyImmediately?: Boolean;
|
|
5717
5961
|
/**
|
|
5718
|
-
* The number of days for which automated backups are retained.
|
|
5962
|
+
* The number of days for which automated backups are retained. Specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35 Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5719
5963
|
*/
|
|
5720
5964
|
BackupRetentionPeriod?: IntegerOptional;
|
|
5721
5965
|
/**
|
|
5722
|
-
* The name of the DB cluster parameter group to use for the DB cluster.
|
|
5966
|
+
* The name of the DB cluster parameter group to use for the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5723
5967
|
*/
|
|
5724
5968
|
DBClusterParameterGroupName?: String;
|
|
5725
5969
|
/**
|
|
5726
|
-
* A list of VPC security groups that the DB cluster will belong to.
|
|
5970
|
+
* A list of VPC security groups that the DB cluster will belong to. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5727
5971
|
*/
|
|
5728
5972
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
5729
5973
|
/**
|
|
5730
|
-
* The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
|
|
5974
|
+
* The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster. Valid for: Aurora DB clusters only
|
|
5731
5975
|
*/
|
|
5732
5976
|
Port?: IntegerOptional;
|
|
5733
5977
|
/**
|
|
5734
|
-
* The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
|
|
5978
|
+
* The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5735
5979
|
*/
|
|
5736
5980
|
MasterUserPassword?: String;
|
|
5737
5981
|
/**
|
|
5738
|
-
* A value that indicates that the DB cluster should be associated with the specified option group.
|
|
5982
|
+
* A value that indicates that the DB cluster should be associated with the specified option group. DB clusters are associated with a default option group that can't be modified.
|
|
5739
5983
|
*/
|
|
5740
5984
|
OptionGroupName?: String;
|
|
5741
5985
|
/**
|
|
5742
|
-
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
|
|
5986
|
+
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5743
5987
|
*/
|
|
5744
5988
|
PreferredBackupWindow?: String;
|
|
5745
5989
|
/**
|
|
5746
|
-
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
|
|
5990
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5747
5991
|
*/
|
|
5748
5992
|
PreferredMaintenanceWindow?: String;
|
|
5749
5993
|
/**
|
|
5750
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
5994
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
5751
5995
|
*/
|
|
5752
5996
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
5753
5997
|
/**
|
|
5754
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
5998
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only
|
|
5755
5999
|
*/
|
|
5756
6000
|
BacktrackWindow?: LongOptional;
|
|
5757
6001
|
/**
|
|
5758
|
-
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
|
|
6002
|
+
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. Valid for: Aurora DB clusters only
|
|
5759
6003
|
*/
|
|
5760
6004
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
5761
6005
|
/**
|
|
5762
|
-
* The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled. To list all of the available engine versions for
|
|
6006
|
+
* The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled. To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5763
6007
|
*/
|
|
5764
6008
|
EngineVersion?: String;
|
|
5765
6009
|
/**
|
|
5766
|
-
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
|
|
6010
|
+
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version. Valid for: Aurora DB clusters only
|
|
5767
6011
|
*/
|
|
5768
6012
|
AllowMajorVersionUpgrade?: Boolean;
|
|
5769
6013
|
/**
|
|
5770
|
-
* The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB cluster. The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
|
|
6014
|
+
* The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB cluster. The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter. Valid for: Aurora DB clusters only
|
|
5771
6015
|
*/
|
|
5772
6016
|
DBInstanceParameterGroupName?: String;
|
|
5773
6017
|
/**
|
|
5774
|
-
* The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
|
|
6018
|
+
* The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation. For more information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
5775
6019
|
*/
|
|
5776
6020
|
Domain?: String;
|
|
5777
6021
|
/**
|
|
5778
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
6022
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only
|
|
5779
6023
|
*/
|
|
5780
6024
|
DomainIAMRoleName?: String;
|
|
5781
6025
|
/**
|
|
5782
|
-
* The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
|
|
6026
|
+
* The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode. Valid for: Aurora DB clusters only
|
|
5783
6027
|
*/
|
|
5784
6028
|
ScalingConfiguration?: ScalingConfiguration;
|
|
5785
6029
|
/**
|
|
5786
|
-
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
6030
|
+
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5787
6031
|
*/
|
|
5788
6032
|
DeletionProtection?: BooleanOptional;
|
|
5789
6033
|
/**
|
|
5790
|
-
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
|
|
6034
|
+
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
5791
6035
|
*/
|
|
5792
6036
|
EnableHttpEndpoint?: BooleanOptional;
|
|
5793
6037
|
/**
|
|
5794
|
-
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
|
|
6038
|
+
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters only
|
|
5795
6039
|
*/
|
|
5796
6040
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
5797
6041
|
/**
|
|
5798
|
-
* A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
|
|
6042
|
+
* A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then. Valid for: Aurora DB clusters only
|
|
5799
6043
|
*/
|
|
5800
6044
|
EnableGlobalWriteForwarding?: BooleanOptional;
|
|
6045
|
+
/**
|
|
6046
|
+
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
|
|
6047
|
+
*/
|
|
6048
|
+
DBClusterInstanceClass?: String;
|
|
6049
|
+
/**
|
|
6050
|
+
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Type: Integer Valid for: Multi-AZ DB clusters only
|
|
6051
|
+
*/
|
|
6052
|
+
AllocatedStorage?: IntegerOptional;
|
|
6053
|
+
/**
|
|
6054
|
+
* Specifies the storage type to be associated with the DB cluster. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Valid for: Multi-AZ DB clusters only
|
|
6055
|
+
*/
|
|
6056
|
+
StorageType?: String;
|
|
6057
|
+
/**
|
|
6058
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster. Valid for: Multi-AZ DB clusters only
|
|
6059
|
+
*/
|
|
6060
|
+
Iops?: IntegerOptional;
|
|
6061
|
+
/**
|
|
6062
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for: Multi-AZ DB clusters only
|
|
6063
|
+
*/
|
|
6064
|
+
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
6065
|
+
/**
|
|
6066
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Valid for: Multi-AZ DB clusters only
|
|
6067
|
+
*/
|
|
6068
|
+
MonitoringInterval?: IntegerOptional;
|
|
6069
|
+
/**
|
|
6070
|
+
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only
|
|
6071
|
+
*/
|
|
6072
|
+
MonitoringRoleArn?: String;
|
|
6073
|
+
/**
|
|
6074
|
+
* A value that indicates whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
|
|
6075
|
+
*/
|
|
6076
|
+
EnablePerformanceInsights?: BooleanOptional;
|
|
6077
|
+
/**
|
|
6078
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB clusters only
|
|
6079
|
+
*/
|
|
6080
|
+
PerformanceInsightsKMSKeyId?: String;
|
|
6081
|
+
/**
|
|
6082
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). Valid for: Multi-AZ DB clusters only
|
|
6083
|
+
*/
|
|
6084
|
+
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
5801
6085
|
}
|
|
5802
6086
|
export interface ModifyDBClusterParameterGroupMessage {
|
|
5803
6087
|
/**
|
|
@@ -5843,19 +6127,19 @@ declare namespace RDS {
|
|
|
5843
6127
|
*/
|
|
5844
6128
|
AllocatedStorage?: IntegerOptional;
|
|
5845
6129
|
/**
|
|
5846
|
-
* The new compute and memory capacity of the DB instance, for example
|
|
6130
|
+
* The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request. This setting doesn't apply to RDS Custom. Default: Uses existing setting
|
|
5847
6131
|
*/
|
|
5848
6132
|
DBInstanceClass?: String;
|
|
5849
6133
|
/**
|
|
5850
|
-
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
|
|
6134
|
+
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately. This parameter doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
|
|
5851
6135
|
*/
|
|
5852
6136
|
DBSubnetGroupName?: String;
|
|
5853
6137
|
/**
|
|
5854
|
-
* A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
|
|
6138
|
+
* A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match existing DBSecurityGroups.
|
|
5855
6139
|
*/
|
|
5856
6140
|
DBSecurityGroups?: DBSecurityGroupNameList;
|
|
5857
6141
|
/**
|
|
5858
|
-
* A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
|
|
6142
|
+
* A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
|
|
5859
6143
|
*/
|
|
5860
6144
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
5861
6145
|
/**
|
|
@@ -5863,15 +6147,15 @@ declare namespace RDS {
|
|
|
5863
6147
|
*/
|
|
5864
6148
|
ApplyImmediately?: Boolean;
|
|
5865
6149
|
/**
|
|
5866
|
-
* The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
|
|
6150
|
+
* The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
|
|
5867
6151
|
*/
|
|
5868
6152
|
MasterUserPassword?: String;
|
|
5869
6153
|
/**
|
|
5870
|
-
* The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes
|
|
6154
|
+
* The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot. This setting doesn't apply to RDS Custom. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
|
|
5871
6155
|
*/
|
|
5872
6156
|
DBParameterGroupName?: String;
|
|
5873
6157
|
/**
|
|
5874
|
-
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints:
|
|
6158
|
+
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints: It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance. It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later. It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
|
|
5875
6159
|
*/
|
|
5876
6160
|
BackupRetentionPeriod?: IntegerOptional;
|
|
5877
6161
|
/**
|
|
@@ -5883,23 +6167,23 @@ declare namespace RDS {
|
|
|
5883
6167
|
*/
|
|
5884
6168
|
PreferredMaintenanceWindow?: String;
|
|
5885
6169
|
/**
|
|
5886
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage
|
|
6170
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. This setting doesn't apply to RDS Custom.
|
|
5887
6171
|
*/
|
|
5888
6172
|
MultiAZ?: BooleanOptional;
|
|
5889
6173
|
/**
|
|
5890
|
-
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
|
|
6174
|
+
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. In RDS Custom, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
|
|
5891
6175
|
*/
|
|
5892
6176
|
EngineVersion?: String;
|
|
5893
6177
|
/**
|
|
5894
|
-
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
|
|
6178
|
+
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
|
|
5895
6179
|
*/
|
|
5896
6180
|
AllowMajorVersionUpgrade?: Boolean;
|
|
5897
6181
|
/**
|
|
5898
|
-
*
|
|
6182
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met: The automatic upgrade is enabled for the maintenance window. A newer minor version is available. RDS has enabled automatic patching for the engine version. If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.
|
|
5899
6183
|
*/
|
|
5900
6184
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
5901
6185
|
/**
|
|
5902
|
-
* The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
|
|
6186
|
+
* The license model for the DB instance. This setting doesn't apply to RDS Custom. Valid values: license-included | bring-your-own-license | general-public-license
|
|
5903
6187
|
*/
|
|
5904
6188
|
LicenseModel?: String;
|
|
5905
6189
|
/**
|
|
@@ -5907,11 +6191,11 @@ declare namespace RDS {
|
|
|
5907
6191
|
*/
|
|
5908
6192
|
Iops?: IntegerOptional;
|
|
5909
6193
|
/**
|
|
5910
|
-
*
|
|
6194
|
+
* A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
5911
6195
|
*/
|
|
5912
6196
|
OptionGroupName?: String;
|
|
5913
6197
|
/**
|
|
5914
|
-
*
|
|
6198
|
+
* The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. This setting doesn't apply to RDS Custom. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
|
|
5915
6199
|
*/
|
|
5916
6200
|
NewDBInstanceIdentifier?: String;
|
|
5917
6201
|
/**
|
|
@@ -5919,19 +6203,19 @@ declare namespace RDS {
|
|
|
5919
6203
|
*/
|
|
5920
6204
|
StorageType?: String;
|
|
5921
6205
|
/**
|
|
5922
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
6206
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
5923
6207
|
*/
|
|
5924
6208
|
TdeCredentialArn?: String;
|
|
5925
6209
|
/**
|
|
5926
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
6210
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
5927
6211
|
*/
|
|
5928
6212
|
TdeCredentialPassword?: String;
|
|
5929
6213
|
/**
|
|
5930
|
-
*
|
|
6214
|
+
* Specifies the certificate to associate with the DB instance. This setting doesn't apply to RDS Custom.
|
|
5931
6215
|
*/
|
|
5932
6216
|
CACertificateIdentifier?: String;
|
|
5933
6217
|
/**
|
|
5934
|
-
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain.
|
|
6218
|
+
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5935
6219
|
*/
|
|
5936
6220
|
Domain?: String;
|
|
5937
6221
|
/**
|
|
@@ -5939,71 +6223,71 @@ declare namespace RDS {
|
|
|
5939
6223
|
*/
|
|
5940
6224
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
5941
6225
|
/**
|
|
5942
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0
|
|
6226
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default. If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
5943
6227
|
*/
|
|
5944
6228
|
MonitoringInterval?: IntegerOptional;
|
|
5945
6229
|
/**
|
|
5946
|
-
* The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
|
|
6230
|
+
* The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom. MySQL Default: 3306 Valid values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535
|
|
5947
6231
|
*/
|
|
5948
6232
|
DBPortNumber?: IntegerOptional;
|
|
5949
6233
|
/**
|
|
5950
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB
|
|
6234
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom.
|
|
5951
6235
|
*/
|
|
5952
6236
|
PubliclyAccessible?: BooleanOptional;
|
|
5953
6237
|
/**
|
|
5954
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,
|
|
6238
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
5955
6239
|
*/
|
|
5956
6240
|
MonitoringRoleArn?: String;
|
|
5957
6241
|
/**
|
|
5958
|
-
* The name of the IAM role to use when making API calls to the Directory Service.
|
|
6242
|
+
* The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
5959
6243
|
*/
|
|
5960
6244
|
DomainIAMRoleName?: String;
|
|
5961
6245
|
/**
|
|
5962
|
-
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
|
|
6246
|
+
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15
|
|
5963
6247
|
*/
|
|
5964
6248
|
PromotionTier?: IntegerOptional;
|
|
5965
6249
|
/**
|
|
5966
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
6250
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5967
6251
|
*/
|
|
5968
6252
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
5969
6253
|
/**
|
|
5970
|
-
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
|
|
6254
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. This setting doesn't apply to RDS Custom.
|
|
5971
6255
|
*/
|
|
5972
6256
|
EnablePerformanceInsights?: BooleanOptional;
|
|
5973
6257
|
/**
|
|
5974
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
6258
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
5975
6259
|
*/
|
|
5976
6260
|
PerformanceInsightsKMSKeyId?: String;
|
|
5977
6261
|
/**
|
|
5978
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
6262
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
5979
6263
|
*/
|
|
5980
6264
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
5981
6265
|
/**
|
|
5982
|
-
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
|
|
6266
|
+
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect. This setting doesn't apply to RDS Custom.
|
|
5983
6267
|
*/
|
|
5984
6268
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
5985
6269
|
/**
|
|
5986
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
6270
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
5987
6271
|
*/
|
|
5988
6272
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
5989
6273
|
/**
|
|
5990
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
6274
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
5991
6275
|
*/
|
|
5992
6276
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
5993
6277
|
/**
|
|
5994
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
6278
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
|
5995
6279
|
*/
|
|
5996
6280
|
DeletionProtection?: BooleanOptional;
|
|
5997
6281
|
/**
|
|
5998
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
6282
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5999
6283
|
*/
|
|
6000
6284
|
MaxAllocatedStorage?: IntegerOptional;
|
|
6001
6285
|
/**
|
|
6002
|
-
* A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
|
|
6286
|
+
* A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom.
|
|
6003
6287
|
*/
|
|
6004
6288
|
CertificateRotationRestart?: BooleanOptional;
|
|
6005
6289
|
/**
|
|
6006
|
-
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
|
|
6290
|
+
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
6007
6291
|
*/
|
|
6008
6292
|
ReplicaMode?: ReplicaMode;
|
|
6009
6293
|
/**
|
|
@@ -6011,9 +6295,17 @@ declare namespace RDS {
|
|
|
6011
6295
|
*/
|
|
6012
6296
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
6013
6297
|
/**
|
|
6014
|
-
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
|
6298
|
+
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. This setting doesn't apply to RDS Custom.
|
|
6015
6299
|
*/
|
|
6016
6300
|
AwsBackupRecoveryPointArn?: AwsBackupRecoveryPointArn;
|
|
6301
|
+
/**
|
|
6302
|
+
* The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
|
|
6303
|
+
*/
|
|
6304
|
+
AutomationMode?: AutomationMode;
|
|
6305
|
+
/**
|
|
6306
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
6307
|
+
*/
|
|
6308
|
+
ResumeFullAutomationModeMinutes?: IntegerOptional;
|
|
6017
6309
|
}
|
|
6018
6310
|
export interface ModifyDBInstanceResult {
|
|
6019
6311
|
DBInstance?: DBInstance;
|
|
@@ -6636,6 +6928,10 @@ declare namespace RDS {
|
|
|
6636
6928
|
* A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
|
|
6637
6929
|
*/
|
|
6638
6930
|
SupportsGlobalDatabases?: Boolean;
|
|
6931
|
+
/**
|
|
6932
|
+
* Whether DB instances can be configured as a Multi-AZ DB cluster. The Multi-AZ DB clusters feature is in preview and is subject to change. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
6933
|
+
*/
|
|
6934
|
+
SupportsClusters?: Boolean;
|
|
6639
6935
|
}
|
|
6640
6936
|
export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
|
|
6641
6937
|
export interface OrderableDBInstanceOptionsMessage {
|
|
@@ -6811,6 +7107,14 @@ declare namespace RDS {
|
|
|
6811
7107
|
* Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
|
|
6812
7108
|
*/
|
|
6813
7109
|
IAMDatabaseAuthenticationEnabled?: BooleanOptional;
|
|
7110
|
+
/**
|
|
7111
|
+
* The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
|
|
7112
|
+
*/
|
|
7113
|
+
AutomationMode?: AutomationMode;
|
|
7114
|
+
/**
|
|
7115
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
7116
|
+
*/
|
|
7117
|
+
ResumeFullAutomationModeTime?: TStamp;
|
|
6814
7118
|
}
|
|
6815
7119
|
export interface ProcessorFeature {
|
|
6816
7120
|
/**
|
|
@@ -6886,6 +7190,15 @@ declare namespace RDS {
|
|
|
6886
7190
|
export type ReadReplicaDBInstanceIdentifierList = String[];
|
|
6887
7191
|
export type ReadReplicaIdentifierList = String[];
|
|
6888
7192
|
export type ReadersArnList = String[];
|
|
7193
|
+
export interface RebootDBClusterMessage {
|
|
7194
|
+
/**
|
|
7195
|
+
* The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBCluster.
|
|
7196
|
+
*/
|
|
7197
|
+
DBClusterIdentifier: String;
|
|
7198
|
+
}
|
|
7199
|
+
export interface RebootDBClusterResult {
|
|
7200
|
+
DBCluster?: DBCluster;
|
|
7201
|
+
}
|
|
6889
7202
|
export interface RebootDBInstanceMessage {
|
|
6890
7203
|
/**
|
|
6891
7204
|
* The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
|
|
@@ -6957,7 +7270,7 @@ declare namespace RDS {
|
|
|
6957
7270
|
*/
|
|
6958
7271
|
RoleArn: String;
|
|
6959
7272
|
/**
|
|
6960
|
-
* The name of the feature for the DB cluster that the IAM role is to be disassociated from. For
|
|
7273
|
+
* The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
|
|
6961
7274
|
*/
|
|
6962
7275
|
FeatureName?: String;
|
|
6963
7276
|
}
|
|
@@ -6971,7 +7284,7 @@ declare namespace RDS {
|
|
|
6971
7284
|
*/
|
|
6972
7285
|
RoleArn: String;
|
|
6973
7286
|
/**
|
|
6974
|
-
* The name of the feature for the DB instance that the IAM role is to be disassociated from. For
|
|
7287
|
+
* The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
|
|
6975
7288
|
*/
|
|
6976
7289
|
FeatureName: String;
|
|
6977
7290
|
}
|
|
@@ -7238,11 +7551,11 @@ declare namespace RDS {
|
|
|
7238
7551
|
*/
|
|
7239
7552
|
StorageEncrypted?: BooleanOptional;
|
|
7240
7553
|
/**
|
|
7241
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7554
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7242
7555
|
*/
|
|
7243
7556
|
KmsKeyId?: String;
|
|
7244
7557
|
/**
|
|
7245
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
7558
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
|
|
7246
7559
|
*/
|
|
7247
7560
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7248
7561
|
/**
|
|
@@ -7274,7 +7587,7 @@ declare namespace RDS {
|
|
|
7274
7587
|
*/
|
|
7275
7588
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7276
7589
|
/**
|
|
7277
|
-
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
7590
|
+
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
|
|
7278
7591
|
*/
|
|
7279
7592
|
DeletionProtection?: BooleanOptional;
|
|
7280
7593
|
/**
|
|
@@ -7295,179 +7608,211 @@ declare namespace RDS {
|
|
|
7295
7608
|
}
|
|
7296
7609
|
export interface RestoreDBClusterFromSnapshotMessage {
|
|
7297
7610
|
/**
|
|
7298
|
-
* Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
|
7611
|
+
* Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created. Valid for: Aurora DB clusters only
|
|
7299
7612
|
*/
|
|
7300
7613
|
AvailabilityZones?: AvailabilityZones;
|
|
7301
7614
|
/**
|
|
7302
|
-
* The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
|
|
7615
|
+
* The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7303
7616
|
*/
|
|
7304
7617
|
DBClusterIdentifier: String;
|
|
7305
7618
|
/**
|
|
7306
|
-
* The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot.
|
|
7619
|
+
* The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7307
7620
|
*/
|
|
7308
7621
|
SnapshotIdentifier: String;
|
|
7309
7622
|
/**
|
|
7310
|
-
* The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source
|
|
7623
|
+
* The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7311
7624
|
*/
|
|
7312
7625
|
Engine: String;
|
|
7313
7626
|
/**
|
|
7314
|
-
* The version of the database engine to use for the new DB cluster. To list all of the available engine versions for
|
|
7627
|
+
* The version of the database engine to use for the new DB cluster. To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Aurora MySQL See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide. Aurora PostgreSQL See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7315
7628
|
*/
|
|
7316
7629
|
EngineVersion?: String;
|
|
7317
7630
|
/**
|
|
7318
|
-
* The port number on which the new DB cluster accepts connections. Constraints: This value must be 1150-65535 Default: The same port as the original DB cluster.
|
|
7631
|
+
* The port number on which the new DB cluster accepts connections. Constraints: This value must be 1150-65535 Default: The same port as the original DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7319
7632
|
*/
|
|
7320
7633
|
Port?: IntegerOptional;
|
|
7321
7634
|
/**
|
|
7322
|
-
* The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mySubnetgroup
|
|
7635
|
+
* The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mySubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7323
7636
|
*/
|
|
7324
7637
|
DBSubnetGroupName?: String;
|
|
7325
7638
|
/**
|
|
7326
|
-
* The database name for the restored DB cluster.
|
|
7639
|
+
* The database name for the restored DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7327
7640
|
*/
|
|
7328
7641
|
DatabaseName?: String;
|
|
7329
7642
|
/**
|
|
7330
|
-
* The name of the option group to use for the restored DB cluster.
|
|
7643
|
+
* The name of the option group to use for the restored DB cluster. DB clusters are associated with a default option group that can't be modified.
|
|
7331
7644
|
*/
|
|
7332
7645
|
OptionGroupName?: String;
|
|
7333
7646
|
/**
|
|
7334
|
-
* A list of VPC security groups that the new DB cluster will belong to.
|
|
7647
|
+
* A list of VPC security groups that the new DB cluster will belong to. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7335
7648
|
*/
|
|
7336
7649
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7337
7650
|
/**
|
|
7338
|
-
* The tags to be assigned to the restored DB cluster.
|
|
7651
|
+
* The tags to be assigned to the restored DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7339
7652
|
*/
|
|
7340
7653
|
Tags?: TagList;
|
|
7341
7654
|
/**
|
|
7342
|
-
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7655
|
+
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7343
7656
|
*/
|
|
7344
7657
|
KmsKeyId?: String;
|
|
7345
7658
|
/**
|
|
7346
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
7659
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
7347
7660
|
*/
|
|
7348
7661
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7349
7662
|
/**
|
|
7350
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
7663
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora DB clusters only
|
|
7351
7664
|
*/
|
|
7352
7665
|
BacktrackWindow?: LongOptional;
|
|
7353
7666
|
/**
|
|
7354
|
-
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
|
|
7667
|
+
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
7355
7668
|
*/
|
|
7356
7669
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7357
7670
|
/**
|
|
7358
|
-
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. For more information, see CreateDBCluster.
|
|
7671
|
+
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. For more information, see CreateDBCluster. Valid for: Aurora DB clusters only
|
|
7359
7672
|
*/
|
|
7360
7673
|
EngineMode?: String;
|
|
7361
7674
|
/**
|
|
7362
|
-
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
|
|
7675
|
+
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only
|
|
7363
7676
|
*/
|
|
7364
7677
|
ScalingConfiguration?: ScalingConfiguration;
|
|
7365
7678
|
/**
|
|
7366
|
-
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7679
|
+
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7367
7680
|
*/
|
|
7368
7681
|
DBClusterParameterGroupName?: String;
|
|
7369
7682
|
/**
|
|
7370
|
-
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
7683
|
+
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7371
7684
|
*/
|
|
7372
7685
|
DeletionProtection?: BooleanOptional;
|
|
7373
7686
|
/**
|
|
7374
|
-
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
|
|
7687
|
+
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters only
|
|
7375
7688
|
*/
|
|
7376
7689
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
7377
7690
|
/**
|
|
7378
|
-
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
7691
|
+
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. Valid for: Aurora DB clusters only
|
|
7379
7692
|
*/
|
|
7380
7693
|
Domain?: String;
|
|
7381
7694
|
/**
|
|
7382
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
7695
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only
|
|
7383
7696
|
*/
|
|
7384
7697
|
DomainIAMRoleName?: String;
|
|
7698
|
+
/**
|
|
7699
|
+
* The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7700
|
+
*/
|
|
7701
|
+
DBClusterInstanceClass?: String;
|
|
7702
|
+
/**
|
|
7703
|
+
* Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7704
|
+
*/
|
|
7705
|
+
StorageType?: String;
|
|
7706
|
+
/**
|
|
7707
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7708
|
+
*/
|
|
7709
|
+
Iops?: IntegerOptional;
|
|
7710
|
+
/**
|
|
7711
|
+
* A value that indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7712
|
+
*/
|
|
7713
|
+
PubliclyAccessible?: BooleanOptional;
|
|
7385
7714
|
}
|
|
7386
7715
|
export interface RestoreDBClusterFromSnapshotResult {
|
|
7387
7716
|
DBCluster?: DBCluster;
|
|
7388
7717
|
}
|
|
7389
7718
|
export interface RestoreDBClusterToPointInTimeMessage {
|
|
7390
7719
|
/**
|
|
7391
|
-
* The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
7720
|
+
* The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7392
7721
|
*/
|
|
7393
7722
|
DBClusterIdentifier: String;
|
|
7394
7723
|
/**
|
|
7395
|
-
* The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
|
|
7724
|
+
* The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7396
7725
|
*/
|
|
7397
7726
|
RestoreType?: String;
|
|
7398
7727
|
/**
|
|
7399
|
-
* The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.
|
|
7728
|
+
* The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7400
7729
|
*/
|
|
7401
7730
|
SourceDBClusterIdentifier: String;
|
|
7402
7731
|
/**
|
|
7403
|
-
* The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Must be specified if UseLatestRestorableTime parameter isn't provided Can't be specified if the UseLatestRestorableTime parameter is enabled Can't be specified if the RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z
|
|
7732
|
+
* The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Must be specified if UseLatestRestorableTime parameter isn't provided Can't be specified if the UseLatestRestorableTime parameter is enabled Can't be specified if the RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7404
7733
|
*/
|
|
7405
7734
|
RestoreToTime?: TStamp;
|
|
7406
7735
|
/**
|
|
7407
|
-
* A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. Constraints: Can't be specified if RestoreToTime parameter is provided.
|
|
7736
|
+
* A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. Constraints: Can't be specified if RestoreToTime parameter is provided. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7408
7737
|
*/
|
|
7409
7738
|
UseLatestRestorableTime?: Boolean;
|
|
7410
7739
|
/**
|
|
7411
|
-
* The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine.
|
|
7740
|
+
* The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7412
7741
|
*/
|
|
7413
7742
|
Port?: IntegerOptional;
|
|
7414
7743
|
/**
|
|
7415
|
-
* The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
|
|
7744
|
+
* The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7416
7745
|
*/
|
|
7417
7746
|
DBSubnetGroupName?: String;
|
|
7418
7747
|
/**
|
|
7419
|
-
* The name of the option group for the new DB cluster.
|
|
7748
|
+
* The name of the option group for the new DB cluster. DB clusters are associated with a default option group that can't be modified.
|
|
7420
7749
|
*/
|
|
7421
7750
|
OptionGroupName?: String;
|
|
7422
7751
|
/**
|
|
7423
|
-
* A list of VPC security groups that the new DB cluster belongs to.
|
|
7752
|
+
* A list of VPC security groups that the new DB cluster belongs to. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7424
7753
|
*/
|
|
7425
7754
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7426
7755
|
Tags?: TagList;
|
|
7427
7756
|
/**
|
|
7428
|
-
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7757
|
+
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted. If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7429
7758
|
*/
|
|
7430
7759
|
KmsKeyId?: String;
|
|
7431
7760
|
/**
|
|
7432
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
7761
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
7433
7762
|
*/
|
|
7434
7763
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7435
7764
|
/**
|
|
7436
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
7765
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only
|
|
7437
7766
|
*/
|
|
7438
7767
|
BacktrackWindow?: LongOptional;
|
|
7439
7768
|
/**
|
|
7440
|
-
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
|
|
7769
|
+
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
7441
7770
|
*/
|
|
7442
7771
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7443
7772
|
/**
|
|
7444
|
-
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7773
|
+
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7445
7774
|
*/
|
|
7446
7775
|
DBClusterParameterGroupName?: String;
|
|
7447
7776
|
/**
|
|
7448
|
-
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
7777
|
+
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7449
7778
|
*/
|
|
7450
7779
|
DeletionProtection?: BooleanOptional;
|
|
7451
7780
|
/**
|
|
7452
|
-
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
|
|
7781
|
+
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters only
|
|
7453
7782
|
*/
|
|
7454
7783
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
7455
7784
|
/**
|
|
7456
|
-
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
|
|
7785
|
+
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
7457
7786
|
*/
|
|
7458
7787
|
Domain?: String;
|
|
7459
7788
|
/**
|
|
7460
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
7789
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only
|
|
7461
7790
|
*/
|
|
7462
7791
|
DomainIAMRoleName?: String;
|
|
7463
7792
|
/**
|
|
7464
|
-
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
|
|
7793
|
+
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only
|
|
7465
7794
|
*/
|
|
7466
7795
|
ScalingConfiguration?: ScalingConfiguration;
|
|
7467
7796
|
/**
|
|
7468
|
-
* The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.
|
|
7797
|
+
* The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster. Valid for: Aurora DB clusters only
|
|
7469
7798
|
*/
|
|
7470
7799
|
EngineMode?: String;
|
|
7800
|
+
/**
|
|
7801
|
+
* The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
|
|
7802
|
+
*/
|
|
7803
|
+
DBClusterInstanceClass?: String;
|
|
7804
|
+
/**
|
|
7805
|
+
* Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster. Valid values: standard | gp2 | io1 If you specify io1, also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Valid for: Multi-AZ DB clusters only
|
|
7806
|
+
*/
|
|
7807
|
+
StorageType?: String;
|
|
7808
|
+
/**
|
|
7809
|
+
* A value that indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Multi-AZ DB clusters only
|
|
7810
|
+
*/
|
|
7811
|
+
PubliclyAccessible?: BooleanOptional;
|
|
7812
|
+
/**
|
|
7813
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. Valid for: Multi-AZ DB clusters only
|
|
7814
|
+
*/
|
|
7815
|
+
Iops?: IntegerOptional;
|
|
7471
7816
|
}
|
|
7472
7817
|
export interface RestoreDBClusterToPointInTimeResult {
|
|
7473
7818
|
DBCluster?: DBCluster;
|
|
@@ -7482,7 +7827,7 @@ declare namespace RDS {
|
|
|
7482
7827
|
*/
|
|
7483
7828
|
DBSnapshotIdentifier: String;
|
|
7484
7829
|
/**
|
|
7485
|
-
* The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
7830
|
+
* The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
|
|
7486
7831
|
*/
|
|
7487
7832
|
DBInstanceClass?: String;
|
|
7488
7833
|
/**
|
|
@@ -7498,27 +7843,27 @@ declare namespace RDS {
|
|
|
7498
7843
|
*/
|
|
7499
7844
|
DBSubnetGroupName?: String;
|
|
7500
7845
|
/**
|
|
7501
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7846
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7502
7847
|
*/
|
|
7503
7848
|
MultiAZ?: BooleanOptional;
|
|
7504
7849
|
/**
|
|
7505
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC
|
|
7850
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
|
7506
7851
|
*/
|
|
7507
7852
|
PubliclyAccessible?: BooleanOptional;
|
|
7508
7853
|
/**
|
|
7509
|
-
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
|
7854
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter.
|
|
7510
7855
|
*/
|
|
7511
7856
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
7512
7857
|
/**
|
|
7513
|
-
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7858
|
+
* License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7514
7859
|
*/
|
|
7515
7860
|
LicenseModel?: String;
|
|
7516
7861
|
/**
|
|
7517
|
-
* The database name for the restored DB instance.
|
|
7862
|
+
* The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
|
|
7518
7863
|
*/
|
|
7519
7864
|
DBName?: String;
|
|
7520
7865
|
/**
|
|
7521
|
-
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7866
|
+
* The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7522
7867
|
*/
|
|
7523
7868
|
Engine?: String;
|
|
7524
7869
|
/**
|
|
@@ -7526,7 +7871,7 @@ declare namespace RDS {
|
|
|
7526
7871
|
*/
|
|
7527
7872
|
Iops?: IntegerOptional;
|
|
7528
7873
|
/**
|
|
7529
|
-
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance
|
|
7874
|
+
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
7530
7875
|
*/
|
|
7531
7876
|
OptionGroupName?: String;
|
|
7532
7877
|
Tags?: TagList;
|
|
@@ -7535,11 +7880,11 @@ declare namespace RDS {
|
|
|
7535
7880
|
*/
|
|
7536
7881
|
StorageType?: String;
|
|
7537
7882
|
/**
|
|
7538
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
7883
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
7539
7884
|
*/
|
|
7540
7885
|
TdeCredentialArn?: String;
|
|
7541
7886
|
/**
|
|
7542
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
7887
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
7543
7888
|
*/
|
|
7544
7889
|
TdeCredentialPassword?: String;
|
|
7545
7890
|
/**
|
|
@@ -7547,7 +7892,7 @@ declare namespace RDS {
|
|
|
7547
7892
|
*/
|
|
7548
7893
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7549
7894
|
/**
|
|
7550
|
-
* Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
|
7895
|
+
* Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7551
7896
|
*/
|
|
7552
7897
|
Domain?: String;
|
|
7553
7898
|
/**
|
|
@@ -7555,37 +7900,45 @@ declare namespace RDS {
|
|
|
7555
7900
|
*/
|
|
7556
7901
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
7557
7902
|
/**
|
|
7558
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
7903
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
7559
7904
|
*/
|
|
7560
7905
|
DomainIAMRoleName?: String;
|
|
7561
7906
|
/**
|
|
7562
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
7907
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7563
7908
|
*/
|
|
7564
7909
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7565
7910
|
/**
|
|
7566
|
-
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
7911
|
+
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7567
7912
|
*/
|
|
7568
7913
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7569
7914
|
/**
|
|
7570
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
7915
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
7571
7916
|
*/
|
|
7572
7917
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
7573
7918
|
/**
|
|
7574
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
7919
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
7575
7920
|
*/
|
|
7576
7921
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
7577
7922
|
/**
|
|
7578
|
-
* The name of the DB parameter group to associate with this DB instance. If you
|
|
7923
|
+
* The name of the DB parameter group to associate with this DB instance. If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7579
7924
|
*/
|
|
7580
7925
|
DBParameterGroupName?: String;
|
|
7581
7926
|
/**
|
|
7582
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
7927
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
|
7583
7928
|
*/
|
|
7584
7929
|
DeletionProtection?: BooleanOptional;
|
|
7585
7930
|
/**
|
|
7586
|
-
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7931
|
+
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7587
7932
|
*/
|
|
7588
7933
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
7934
|
+
/**
|
|
7935
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
7936
|
+
*/
|
|
7937
|
+
CustomIamInstanceProfile?: String;
|
|
7938
|
+
/**
|
|
7939
|
+
* Specifies where automated backups and manual snapshots are stored for the restored DB instance. Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region. For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
|
|
7940
|
+
*/
|
|
7941
|
+
BackupTarget?: String;
|
|
7589
7942
|
}
|
|
7590
7943
|
export interface RestoreDBInstanceFromDBSnapshotResult {
|
|
7591
7944
|
DBInstance?: DBInstance;
|
|
@@ -7604,7 +7957,7 @@ declare namespace RDS {
|
|
|
7604
7957
|
*/
|
|
7605
7958
|
AllocatedStorage?: IntegerOptional;
|
|
7606
7959
|
/**
|
|
7607
|
-
* The compute and memory capacity of the DB instance, for example
|
|
7960
|
+
* The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
|
|
7608
7961
|
*/
|
|
7609
7962
|
DBInstanceClass: String;
|
|
7610
7963
|
/**
|
|
@@ -7680,7 +8033,7 @@ declare namespace RDS {
|
|
|
7680
8033
|
*/
|
|
7681
8034
|
OptionGroupName?: String;
|
|
7682
8035
|
/**
|
|
7683
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC
|
|
8036
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
|
7684
8037
|
*/
|
|
7685
8038
|
PubliclyAccessible?: BooleanOptional;
|
|
7686
8039
|
/**
|
|
@@ -7696,7 +8049,7 @@ declare namespace RDS {
|
|
|
7696
8049
|
*/
|
|
7697
8050
|
StorageEncrypted?: BooleanOptional;
|
|
7698
8051
|
/**
|
|
7699
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8052
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7700
8053
|
*/
|
|
7701
8054
|
KmsKeyId?: String;
|
|
7702
8055
|
/**
|
|
@@ -7712,7 +8065,7 @@ declare namespace RDS {
|
|
|
7712
8065
|
*/
|
|
7713
8066
|
MonitoringRoleArn?: String;
|
|
7714
8067
|
/**
|
|
7715
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
8068
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
7716
8069
|
*/
|
|
7717
8070
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7718
8071
|
/**
|
|
@@ -7740,7 +8093,7 @@ declare namespace RDS {
|
|
|
7740
8093
|
*/
|
|
7741
8094
|
EnablePerformanceInsights?: BooleanOptional;
|
|
7742
8095
|
/**
|
|
7743
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8096
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7744
8097
|
*/
|
|
7745
8098
|
PerformanceInsightsKMSKeyId?: String;
|
|
7746
8099
|
/**
|
|
@@ -7760,7 +8113,7 @@ declare namespace RDS {
|
|
|
7760
8113
|
*/
|
|
7761
8114
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
7762
8115
|
/**
|
|
7763
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
8116
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
|
7764
8117
|
*/
|
|
7765
8118
|
DeletionProtection?: BooleanOptional;
|
|
7766
8119
|
/**
|
|
@@ -7789,7 +8142,7 @@ declare namespace RDS {
|
|
|
7789
8142
|
*/
|
|
7790
8143
|
UseLatestRestorableTime?: Boolean;
|
|
7791
8144
|
/**
|
|
7792
|
-
* The compute and memory capacity of the Amazon RDS DB instance, for example
|
|
8145
|
+
* The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
|
|
7793
8146
|
*/
|
|
7794
8147
|
DBInstanceClass?: String;
|
|
7795
8148
|
/**
|
|
@@ -7805,27 +8158,27 @@ declare namespace RDS {
|
|
|
7805
8158
|
*/
|
|
7806
8159
|
DBSubnetGroupName?: String;
|
|
7807
8160
|
/**
|
|
7808
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
8161
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7809
8162
|
*/
|
|
7810
8163
|
MultiAZ?: BooleanOptional;
|
|
7811
8164
|
/**
|
|
7812
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB
|
|
8165
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
|
7813
8166
|
*/
|
|
7814
8167
|
PubliclyAccessible?: BooleanOptional;
|
|
7815
8168
|
/**
|
|
7816
|
-
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
|
8169
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. This setting doesn't apply to RDS Custom.
|
|
7817
8170
|
*/
|
|
7818
8171
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
7819
8172
|
/**
|
|
7820
|
-
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
8173
|
+
* License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7821
8174
|
*/
|
|
7822
8175
|
LicenseModel?: String;
|
|
7823
8176
|
/**
|
|
7824
|
-
* The database name for the restored DB instance. This parameter isn't
|
|
8177
|
+
* The database name for the restored DB instance. This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
|
|
7825
8178
|
*/
|
|
7826
8179
|
DBName?: String;
|
|
7827
8180
|
/**
|
|
7828
|
-
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
8181
|
+
* The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7829
8182
|
*/
|
|
7830
8183
|
Engine?: String;
|
|
7831
8184
|
/**
|
|
@@ -7833,7 +8186,7 @@ declare namespace RDS {
|
|
|
7833
8186
|
*/
|
|
7834
8187
|
Iops?: IntegerOptional;
|
|
7835
8188
|
/**
|
|
7836
|
-
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance
|
|
8189
|
+
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance This setting doesn't apply to RDS Custom.
|
|
7837
8190
|
*/
|
|
7838
8191
|
OptionGroupName?: String;
|
|
7839
8192
|
/**
|
|
@@ -7846,11 +8199,11 @@ declare namespace RDS {
|
|
|
7846
8199
|
*/
|
|
7847
8200
|
StorageType?: String;
|
|
7848
8201
|
/**
|
|
7849
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
8202
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
7850
8203
|
*/
|
|
7851
8204
|
TdeCredentialArn?: String;
|
|
7852
8205
|
/**
|
|
7853
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
8206
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
7854
8207
|
*/
|
|
7855
8208
|
TdeCredentialPassword?: String;
|
|
7856
8209
|
/**
|
|
@@ -7858,35 +8211,35 @@ declare namespace RDS {
|
|
|
7858
8211
|
*/
|
|
7859
8212
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7860
8213
|
/**
|
|
7861
|
-
* Specify the Active Directory directory ID to restore the DB instance in.
|
|
8214
|
+
* Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. This setting doesn't apply to RDS Custom. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
7862
8215
|
*/
|
|
7863
8216
|
Domain?: String;
|
|
7864
8217
|
/**
|
|
7865
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
8218
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
7866
8219
|
*/
|
|
7867
8220
|
DomainIAMRoleName?: String;
|
|
7868
8221
|
/**
|
|
7869
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping
|
|
8222
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. This setting doesn't apply to RDS Custom. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
7870
8223
|
*/
|
|
7871
8224
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7872
8225
|
/**
|
|
7873
|
-
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
8226
|
+
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7874
8227
|
*/
|
|
7875
8228
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7876
8229
|
/**
|
|
7877
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
8230
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
7878
8231
|
*/
|
|
7879
8232
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
7880
8233
|
/**
|
|
7881
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
8234
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
7882
8235
|
*/
|
|
7883
8236
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
7884
8237
|
/**
|
|
7885
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
8238
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7886
8239
|
*/
|
|
7887
8240
|
DBParameterGroupName?: String;
|
|
7888
8241
|
/**
|
|
7889
|
-
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
8242
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
|
7890
8243
|
*/
|
|
7891
8244
|
DeletionProtection?: BooleanOptional;
|
|
7892
8245
|
/**
|
|
@@ -7894,17 +8247,25 @@ declare namespace RDS {
|
|
|
7894
8247
|
*/
|
|
7895
8248
|
SourceDbiResourceId?: String;
|
|
7896
8249
|
/**
|
|
7897
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
8250
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7898
8251
|
*/
|
|
7899
8252
|
MaxAllocatedStorage?: IntegerOptional;
|
|
7900
8253
|
/**
|
|
7901
|
-
* The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
8254
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting doesn't apply to RDS Custom.
|
|
7902
8255
|
*/
|
|
7903
8256
|
SourceDBInstanceAutomatedBackupsArn?: String;
|
|
7904
8257
|
/**
|
|
7905
|
-
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
8258
|
+
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7906
8259
|
*/
|
|
7907
8260
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
8261
|
+
/**
|
|
8262
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
8263
|
+
*/
|
|
8264
|
+
CustomIamInstanceProfile?: String;
|
|
8265
|
+
/**
|
|
8266
|
+
* Specifies where automated backups and manual snapshots are stored for the restored DB instance. Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region. For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
|
|
8267
|
+
*/
|
|
8268
|
+
BackupTarget?: String;
|
|
7908
8269
|
}
|
|
7909
8270
|
export interface RestoreDBInstanceToPointInTimeResult {
|
|
7910
8271
|
DBInstance?: DBInstance;
|
|
@@ -7965,6 +8326,10 @@ declare namespace RDS {
|
|
|
7965
8326
|
* The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
|
|
7966
8327
|
*/
|
|
7967
8328
|
TimeoutAction?: String;
|
|
8329
|
+
/**
|
|
8330
|
+
* The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
|
|
8331
|
+
*/
|
|
8332
|
+
SecondsBeforeTimeout?: IntegerOptional;
|
|
7968
8333
|
}
|
|
7969
8334
|
export interface ScalingConfigurationInfo {
|
|
7970
8335
|
/**
|
|
@@ -7984,9 +8349,13 @@ declare namespace RDS {
|
|
|
7984
8349
|
*/
|
|
7985
8350
|
SecondsUntilAutoPause?: IntegerOptional;
|
|
7986
8351
|
/**
|
|
7987
|
-
* The
|
|
8352
|
+
* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
|
|
7988
8353
|
*/
|
|
7989
8354
|
TimeoutAction?: String;
|
|
8355
|
+
/**
|
|
8356
|
+
* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
|
|
8357
|
+
*/
|
|
8358
|
+
SecondsBeforeTimeout?: IntegerOptional;
|
|
7990
8359
|
}
|
|
7991
8360
|
export type SourceIdsList = String[];
|
|
7992
8361
|
export interface SourceRegion {
|
|
@@ -8018,7 +8387,7 @@ declare namespace RDS {
|
|
|
8018
8387
|
*/
|
|
8019
8388
|
SourceRegions?: SourceRegionList;
|
|
8020
8389
|
}
|
|
8021
|
-
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
|
|
8390
|
+
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|"custom-engine-version"|string;
|
|
8022
8391
|
export interface StartActivityStreamRequest {
|
|
8023
8392
|
/**
|
|
8024
8393
|
* The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
|
|
@@ -8029,7 +8398,7 @@ declare namespace RDS {
|
|
|
8029
8398
|
*/
|
|
8030
8399
|
Mode: ActivityStreamMode;
|
|
8031
8400
|
/**
|
|
8032
|
-
* The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8401
|
+
* The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
8033
8402
|
*/
|
|
8034
8403
|
KmsKeyId: String;
|
|
8035
8404
|
/**
|
|
@@ -8124,7 +8493,7 @@ declare namespace RDS {
|
|
|
8124
8493
|
*/
|
|
8125
8494
|
IamRoleArn: String;
|
|
8126
8495
|
/**
|
|
8127
|
-
* The ID of the Amazon Web Services KMS
|
|
8496
|
+
* The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy: GrantOperation.Encrypt GrantOperation.Decrypt GrantOperation.GenerateDataKey GrantOperation.GenerateDataKeyWithoutPlaintext GrantOperation.ReEncryptFrom GrantOperation.ReEncryptTo GrantOperation.CreateGrant GrantOperation.DescribeKey GrantOperation.RetireGrant
|
|
8128
8497
|
*/
|
|
8129
8498
|
KmsKeyId: String;
|
|
8130
8499
|
/**
|
|
@@ -8148,7 +8517,7 @@ declare namespace RDS {
|
|
|
8148
8517
|
}
|
|
8149
8518
|
export interface StopActivityStreamResponse {
|
|
8150
8519
|
/**
|
|
8151
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8520
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
8152
8521
|
*/
|
|
8153
8522
|
KmsKeyId?: String;
|
|
8154
8523
|
/**
|
|
@@ -8192,6 +8561,7 @@ declare namespace RDS {
|
|
|
8192
8561
|
DBInstance?: DBInstance;
|
|
8193
8562
|
}
|
|
8194
8563
|
export type String = string;
|
|
8564
|
+
export type String255 = string;
|
|
8195
8565
|
export type StringList = String[];
|
|
8196
8566
|
export type StringSensitive = string;
|
|
8197
8567
|
export interface Subnet {
|