Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateConfigurationTemplateCommand

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElasticBeanstalkClient, UpdateConfigurationTemplateCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import
// const { ElasticBeanstalkClient, UpdateConfigurationTemplateCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import
const client = new ElasticBeanstalkClient(config);
const input = { // UpdateConfigurationTemplateMessage
  ApplicationName: "STRING_VALUE", // required
  TemplateName: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  OptionSettings: [ // ConfigurationOptionSettingsList
    { // ConfigurationOptionSetting
      ResourceName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      OptionName: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  OptionsToRemove: [ // OptionsSpecifierList
    { // OptionSpecification
      ResourceName: "STRING_VALUE",
      Namespace: "STRING_VALUE",
      OptionName: "STRING_VALUE",
    },
  ],
};
const command = new UpdateConfigurationTemplateCommand(input);
const response = await client.send(command);
// { // ConfigurationSettingsDescription
//   SolutionStackName: "STRING_VALUE",
//   PlatformArn: "STRING_VALUE",
//   ApplicationName: "STRING_VALUE",
//   TemplateName: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   EnvironmentName: "STRING_VALUE",
//   DeploymentStatus: "deployed" || "pending" || "failed",
//   DateCreated: new Date("TIMESTAMP"),
//   DateUpdated: new Date("TIMESTAMP"),
//   OptionSettings: [ // ConfigurationOptionSettingsList
//     { // ConfigurationOptionSetting
//       ResourceName: "STRING_VALUE",
//       Namespace: "STRING_VALUE",
//       OptionName: "STRING_VALUE",
//       Value: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editor

UpdateConfigurationTemplateCommand Input

See UpdateConfigurationTemplateCommandInput for more details

Parameter	Type	Description
`ApplicationName` Required	`string \| undefined`	The name of the application associated with the configuration template to update. If no application is found with this name, `UpdateConfigurationTemplate` returns an `InvalidParameterValue` error.
`TemplateName` Required	`string \| undefined`	The name of the configuration template to update. If no configuration template is found with this name, `UpdateConfigurationTemplate` returns an `InvalidParameterValue` error.
`Description`	`string \| undefined`	A new description for the configuration.
`OptionSettings`	`ConfigurationOptionSetting[] \| undefined`	A list of configuration option settings to update with the new specified option value.
`OptionsToRemove`	`OptionSpecification[] \| undefined`	A list of configuration options to remove from the configuration set. Constraint: You can remove only `UserDefined` configuration options.

UpdateConfigurationTemplateCommand Output

See UpdateConfigurationTemplateCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ApplicationName`	`string \| undefined`	The name of the application associated with this configuration set.
`DateCreated`	`Date \| undefined`	The date (in UTC time) when this configuration set was created.
`DateUpdated`	`Date \| undefined`	The date (in UTC time) when this configuration set was last modified.
`DeploymentStatus`	`ConfigurationDeploymentStatus \| undefined`	If this configuration set is associated with an environment, the `DeploymentStatus` parameter indicates the deployment status of this configuration set: `null`: This configuration is not associated with a running environment. `pending`: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. `deployed`: This is the configuration that is currently deployed to the associated running environment. `failed`: This is a draft configuration that failed to successfully deploy.
`Description`	`string \| undefined`	Describes this configuration set.
`EnvironmentName`	`string \| undefined`	If not `null`, the name of the environment for this configuration set.
`OptionSettings`	`ConfigurationOptionSetting[] \| undefined`	A list of the configuration options and their values in this configuration set.
`PlatformArn`	`string \| undefined`	The ARN of the platform version.
`SolutionStackName`	`string \| undefined`	The name of the solution stack this configuration set uses.
`TemplateName`	`string \| undefined`	If not `null`, the name of the configuration template for this configuration set.

Throws

Name	Fault	Details
InsufficientPrivilegesException	client	The specified account does not have sufficient privileges for one or more AWS services.
TooManyBucketsException	client	The specified account has reached its limit of Amazon S3 buckets.
ElasticBeanstalkServiceException		Base exception class for all service exceptions from ElasticBeanstalk service.

Getting Started

References