AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateConfigurationTemplate operation. 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.

Related Topics

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateConfigurationTemplateRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The UpdateConfigurationTemplateRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateConfigurationTemplateRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method UpdateConfigurationTemplateRequest(string, string)

Instantiates UpdateConfigurationTemplateRequest with the parameterized properties

Properties

NameTypeDescription
Public Property ApplicationName System.String

Gets and sets the property ApplicationName.

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.

Public Property Description System.String

Gets and sets the property Description.

A new description for the configuration.

Public Property OptionSettings System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting>

Gets and sets the property OptionSettings.

A list of configuration option settings to update with the new specified option value.

Public Property OptionsToRemove System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.OptionSpecification>

Gets and sets the property OptionsToRemove.

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

Public Property TemplateName System.String

Gets and sets the property TemplateName.

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Examples

The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:

To update a configuration template


var response = client.UpdateConfigurationTemplate(new UpdateConfigurationTemplateRequest 
{
    ApplicationName = "my-app",
    OptionsToRemove = new List {
        new OptionSpecification {
            Namespace = "aws:elasticbeanstalk:healthreporting:system",
            OptionName = "ConfigDocument"
        }
    },
    TemplateName = "my-template"
});

string applicationName = response.ApplicationName;
DateTime dateCreated = response.DateCreated;
DateTime dateUpdated = response.DateUpdated;
string solutionStackName = response.SolutionStackName;
string templateName = response.TemplateName;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms