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

Class: Aws::ElasticBeanstalk::Types::CreateConfigurationTemplateMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateConfigurationTemplateMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  application_name: "ApplicationName", # required
  template_name: "ConfigurationTemplateName", # required
  solution_stack_name: "SolutionStackName",
  platform_arn: "PlatformArn",
  source_configuration: {
    application_name: "ApplicationName",
    template_name: "ConfigurationTemplateName",
  },
  environment_id: "EnvironmentId",
  description: "Description",
  option_settings: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
      value: "ConfigurationOptionValue",
    },
  ],
}

Request to create a configuration template.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

  • (String)

    The name of the application to associate with this configuration template.

#descriptionString

Describes this configuration.

Returns:

  • (String)

    Describes this configuration.

#environment_idString

The ID of the environment used with this configuration template.

Returns:

  • (String)

    The ID of the environment used with this configuration template.

#option_settingsArray<Types::ConfigurationOptionSetting>

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Returns:

#platform_arnString

The ARN of the custom platform.

Returns:

  • (String)

    The ARN of the custom platform.

#solution_stack_nameString

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

Returns:

  • (String)

    The name of the solution stack used by this configuration.

#source_configurationTypes::SourceConfiguration

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

Returns:

  • (Types::SourceConfiguration)

    If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

#template_nameString

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

  • (String)

    The name of the configuration template.