paws.compute (version 0.1.12)

elasticbeanstalk_update_configuration_template: Updates the specified configuration template to have the specified properties or configuration option values

Description

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

• describe_configuration_options

Usage

elasticbeanstalk_update_configuration_template(ApplicationName,
  TemplateName, Description, OptionSettings, OptionsToRemove)

Value

A list with the following syntax:

list(
  SolutionStackName = "string",
  PlatformArn = "string",
  ApplicationName = "string",
  TemplateName = "string",
  Description = "string",
  EnvironmentName = "string",
  DeploymentStatus = "deployed"|"pending"|"failed",
  DateCreated = as.POSIXct(
    "2015-01-01"
  ),
  DateUpdated = as.POSIXct(
    "2015-01-01"
  ),
  OptionSettings = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string",
      Value = "string"
    )
  )
)

Arguments

ApplicationName

[required] The name of the application associated with the configuration template to update.

If no application is found with this name, update_configuration_template returns an InvalidParameterValue error.

TemplateName

[required] The name of the configuration template to update.

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

Description

A new description for the configuration.

OptionSettings

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

OptionsToRemove

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

Constraint: You can remove only UserDefined configuration options.

Request syntax

svc$update_configuration_template(
  ApplicationName = "string",
  TemplateName = "string",
  Description = "string",
  OptionSettings = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string",
      Value = "string"
    )
  ),
  OptionsToRemove = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string"
    )
  )
)

Examples

if (FALSE) {
# The following operation removes the configured CloudWatch custom health
# metrics configuration ConfigDocument from a saved configuration template
# named my-template:
svc$update_configuration_template(
  ApplicationName = "my-app",
  OptionsToRemove = list(
    list(
      Namespace = "aws:elasticbeanstalk:healthreporting:system",
      OptionName = "ConfigDocument"
    )
  ),
  TemplateName = "my-template"
)
}