You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::UpdateConfigurationTemplateMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass UpdateConfigurationTemplateMessage data as a hash:

{
  application_name: "ApplicationName", # required
  template_name: "ConfigurationTemplateName", # required
  description: "Description",
  option_settings: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
      value: "ConfigurationOptionValue",
    },
  ],
  options_to_remove: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
    },
  ],
}

The result message containing the options for the specified solution stack.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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.

Returns:

  • (String)


4149
4150
4151
4152
4153
4154
4155
4156
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4149

class UpdateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :description,
  :option_settings,
  :options_to_remove)
  include Aws::Structure
end

#descriptionString

A new description for the configuration.

Returns:

  • (String)


4149
4150
4151
4152
4153
4154
4155
4156
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4149

class UpdateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :description,
  :option_settings,
  :options_to_remove)
  include Aws::Structure
end

#option_settingsArray<Types::ConfigurationOptionSetting>

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



4149
4150
4151
4152
4153
4154
4155
4156
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4149

class UpdateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :description,
  :option_settings,
  :options_to_remove)
  include Aws::Structure
end

#options_to_removeArray<Types::OptionSpecification>

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

Constraint: You can remove only UserDefined configuration options.

Returns:



4149
4150
4151
4152
4153
4154
4155
4156
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4149

class UpdateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :description,
  :option_settings,
  :options_to_remove)
  include Aws::Structure
end

#template_nameString

The name of the configuration template to update.

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

Returns:

  • (String)


4149
4150
4151
4152
4153
4154
4155
4156
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4149

class UpdateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :description,
  :option_settings,
  :options_to_remove)
  include Aws::Structure
end