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.

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",
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Request to create a configuration template.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)

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

#descriptionString

An optional description for this configuration.

Returns:

  • (String)

    An optional description for this configuration.

#environment_idString

The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don\'t specify PlatformArn, SolutionStackName, or SourceConfiguration.

Returns:

  • (String)

    The ID of an environment whose settings you want to use to create the configuration template.

#option_settingsArray<Types::ConfigurationOptionSetting>

Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.

Returns:

#platform_arnString

The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

If you specify PlatformArn, then don\'t specify SolutionStackName.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the custom platform.

#solution_stack_nameString

The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.

You must specify SolutionStackName if you don\'t specify PlatformArn, EnvironmentId, or SourceConfiguration.

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

Returns:

  • (String)

    The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.

#source_configurationTypes::SourceConfiguration

An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in OptionSettings override any values obtained from the SourceConfiguration.

You must specify SourceConfiguration if you don\'t specify PlatformArn, EnvironmentId, or SolutionStackName.

Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

Returns:

#tagsArray<Types::Tag>

Specifies the tags applied to the configuration template.

Returns:

  • (Array<Types::Tag>)

    Specifies the tags applied to the configuration template.

#template_nameString

The name of the configuration template.

Constraint: This name must be unique per application.

Returns:

  • (String)

    The name of the configuration template.