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

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

Overview

Request to create a configuration template.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

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

Returns:

  • (String) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description for this configuration.

Returns:

  • (String) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

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) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#option_settings ⇒ Array<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*.

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html

Returns:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#platform_arn ⇒ String

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

<note markdown=“1”> If you specify ‘PlatformArn`, then don’t specify ‘SolutionStackName`.

</note>

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html

Returns:

  • (String) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#solution_stack_name ⇒ String

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` ][2] API to obtain a list of available solution stacks.

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html [2]: docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html

Returns:

  • (String) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ Types::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:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Specifies the tags applied to the configuration template.

Returns:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the configuration template.

Constraint: This name must be unique per application.

Returns:

  • (String) 


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1141

class CreateConfigurationTemplateMessage < Struct.new(
  :application_name,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :source_configuration,
  :environment_id,
  :description,
  :option_settings,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end