import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { UpdateRelationalDatabaseParametersRequest, UpdateRelationalDatabaseParametersResult } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateRelationalDatabaseParametersCommand}. */ export interface UpdateRelationalDatabaseParametersCommandInput extends UpdateRelationalDatabaseParametersRequest { } /** * @public * * The output of {@link UpdateRelationalDatabaseParametersCommand}. */ export interface UpdateRelationalDatabaseParametersCommandOutput extends UpdateRelationalDatabaseParametersResult, __MetadataBearer { } declare const UpdateRelationalDatabaseParametersCommand_base: { new (input: UpdateRelationalDatabaseParametersCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateRelationalDatabaseParametersCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Allows the update of one or more parameters of a database in Amazon Lightsail.

*

Parameter updates don't cause outages; therefore, their application is not subject to the * preferred maintenance window. However, there are two ways in which parameter updates are * applied: dynamic or pending-reboot. Parameters marked with a * dynamic apply type are applied immediately. Parameters marked with a * pending-reboot apply type are applied only after the database is rebooted using * the reboot relational database operation.

*

The update relational database parameters operation supports tag-based access * control via resource tags applied to the resource identified by relationalDatabaseName. For * more information, see the Amazon Lightsail Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, UpdateRelationalDatabaseParametersCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, UpdateRelationalDatabaseParametersCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // UpdateRelationalDatabaseParametersRequest * relationalDatabaseName: "STRING_VALUE", // required * parameters: [ // RelationalDatabaseParameterList // required * { // RelationalDatabaseParameter * allowedValues: "STRING_VALUE", * applyMethod: "STRING_VALUE", * applyType: "STRING_VALUE", * dataType: "STRING_VALUE", * description: "STRING_VALUE", * isModifiable: true || false, * parameterName: "STRING_VALUE", * parameterValue: "STRING_VALUE", * }, * ], * }; * const command = new UpdateRelationalDatabaseParametersCommand(input); * const response = await client.send(command); * // { // UpdateRelationalDatabaseParametersResult * // operations: [ // OperationList * // { // Operation * // id: "STRING_VALUE", * // resourceName: "STRING_VALUE", * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // createdAt: new Date("TIMESTAMP"), * // location: { // ResourceLocation * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // isTerminal: true || false, * // operationDetails: "STRING_VALUE", * // operationType: "DeleteKnownHostKeys" || "DeleteInstance" || "CreateInstance" || "StopInstance" || "StartInstance" || "RebootInstance" || "OpenInstancePublicPorts" || "PutInstancePublicPorts" || "CloseInstancePublicPorts" || "AllocateStaticIp" || "ReleaseStaticIp" || "AttachStaticIp" || "DetachStaticIp" || "UpdateDomainEntry" || "DeleteDomainEntry" || "CreateDomain" || "DeleteDomain" || "CreateInstanceSnapshot" || "DeleteInstanceSnapshot" || "CreateInstancesFromSnapshot" || "CreateLoadBalancer" || "DeleteLoadBalancer" || "AttachInstancesToLoadBalancer" || "DetachInstancesFromLoadBalancer" || "UpdateLoadBalancerAttribute" || "CreateLoadBalancerTlsCertificate" || "DeleteLoadBalancerTlsCertificate" || "AttachLoadBalancerTlsCertificate" || "CreateDisk" || "DeleteDisk" || "AttachDisk" || "DetachDisk" || "CreateDiskSnapshot" || "DeleteDiskSnapshot" || "CreateDiskFromSnapshot" || "CreateRelationalDatabase" || "UpdateRelationalDatabase" || "DeleteRelationalDatabase" || "CreateRelationalDatabaseFromSnapshot" || "CreateRelationalDatabaseSnapshot" || "DeleteRelationalDatabaseSnapshot" || "UpdateRelationalDatabaseParameters" || "StartRelationalDatabase" || "RebootRelationalDatabase" || "StopRelationalDatabase" || "EnableAddOn" || "DisableAddOn" || "PutAlarm" || "GetAlarms" || "DeleteAlarm" || "TestAlarm" || "CreateContactMethod" || "GetContactMethods" || "SendContactMethodVerification" || "DeleteContactMethod" || "CreateDistribution" || "UpdateDistribution" || "DeleteDistribution" || "ResetDistributionCache" || "AttachCertificateToDistribution" || "DetachCertificateFromDistribution" || "UpdateDistributionBundle" || "SetIpAddressType" || "CreateCertificate" || "DeleteCertificate" || "CreateContainerService" || "UpdateContainerService" || "DeleteContainerService" || "CreateContainerServiceDeployment" || "CreateContainerServiceRegistryLogin" || "RegisterContainerImage" || "DeleteContainerImage" || "CreateBucket" || "DeleteBucket" || "CreateBucketAccessKey" || "DeleteBucketAccessKey" || "UpdateBucketBundle" || "UpdateBucket" || "SetResourceAccessForBucket" || "UpdateInstanceMetadataOptions" || "StartGUISession" || "StopGUISession" || "SetupInstanceHttps", * // status: "NotStarted" || "Started" || "Failed" || "Completed" || "Succeeded", * // statusChangedAt: new Date("TIMESTAMP"), * // errorCode: "STRING_VALUE", * // errorDetails: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param UpdateRelationalDatabaseParametersCommandInput - {@link UpdateRelationalDatabaseParametersCommandInput} * @returns {@link UpdateRelationalDatabaseParametersCommandOutput} * @see {@link UpdateRelationalDatabaseParametersCommandInput} for command's `input` shape. * @see {@link UpdateRelationalDatabaseParametersCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

* * @throws {@link AccountSetupInProgressException} (client fault) *

Lightsail throws this exception when an account is still in the setup in progress * state.

* * @throws {@link InvalidInputException} (client fault) *

Lightsail throws this exception when user input does not conform to the validation rules * of an input field.

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

*
* * @throws {@link NotFoundException} (client fault) *

Lightsail throws this exception when it cannot find a resource.

* * @throws {@link OperationFailureException} (client fault) *

Lightsail throws this exception when an operation fails to execute.

* * @throws {@link RegionSetupInProgressException} (client fault) *

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

* * @throws {@link ServiceException} (server fault) *

A general service exception.

* * @throws {@link UnauthenticatedException} (client fault) *

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class UpdateRelationalDatabaseParametersCommand extends UpdateRelationalDatabaseParametersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateRelationalDatabaseParametersRequest; output: UpdateRelationalDatabaseParametersResult; }; sdk: { input: UpdateRelationalDatabaseParametersCommandInput; output: UpdateRelationalDatabaseParametersCommandOutput; }; }; }