Create Configuration Template
elasticbeanstalk_create_configuration_template | R Documentation |
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application¶
Description¶
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName
response element is always null
.
Related Topics
-
describe_configuration_options
-
describe_configuration_settings
-
list_available_solution_stacks
Usage¶
elasticbeanstalk_create_configuration_template(ApplicationName,
TemplateName, SolutionStackName, PlatformArn, SourceConfiguration,
EnvironmentId, Description, OptionSettings, Tags)
Arguments¶
ApplicationName
[required] The name of the Elastic Beanstalk application to associate with this configuration template.
TemplateName
[required] The name of the configuration template.
Constraint: This name must be unique per application.
SolutionStackName
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 specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
list_available_solution_stacks
API to obtain a list of available solution stacks.PlatformArn
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 specifySolutionStackName
.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 theSourceConfiguration
.You must specify
SourceConfiguration
if you don't specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.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.
EnvironmentId
The ID of an environment whose settings you want to use to create the configuration template. You must specify
EnvironmentId
if you don't specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.Description
An optional description for this configuration.
OptionSettings
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.
Tags
Specifies the tags applied to the configuration template.
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"
)
)
)
Request syntax¶
svc$create_configuration_template(
ApplicationName = "string",
TemplateName = "string",
SolutionStackName = "string",
PlatformArn = "string",
SourceConfiguration = list(
ApplicationName = "string",
TemplateName = "string"
),
EnvironmentId = "string",
Description = "string",
OptionSettings = list(
list(
ResourceName = "string",
Namespace = "string",
OptionName = "string",
Value = "string"
)
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)