Menu
AWS Elastic Beanstalk
API Reference (API Version 2010-12-01)

CreateConfigurationTemplate

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ApplicationName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Description

Describes this configuration.

Type: String

Length Constraints: Maximum length of 200.

Required: No

EnvironmentId

The ID of the environment used with this configuration template.

Type: String

Required: No

OptionSettings.member.N

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.

Type: Array of ConfigurationOptionSetting objects

Required: No

PlatformArn

The ARN of the custome platform.

Type: String

Required: No

SolutionStackName

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.

Type: String

Required: No

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.

Type: SourceConfiguration object

Required: No

TemplateName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Response Elements

The following elements are returned by the service.

ApplicationName

The name of the application associated with this configuration set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

DateCreated

The date (in UTC time) when this configuration set was created.

Type: Timestamp

DateUpdated

The date (in UTC time) when this configuration set was last modified.

Type: Timestamp

DeploymentStatus

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

  • null: This configuration is not associated with a running environment.

  • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

  • deployed: This is the configuration that is currently deployed to the associated running environment.

  • failed: This is a draft configuration that failed to successfully deploy.

Type: String

Valid Values: deployed | pending | failed

Description

Describes this configuration set.

Type: String

Length Constraints: Maximum length of 200.

EnvironmentName

If not null, the name of the environment for this configuration set.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

OptionSettings.member.N

A list of the configuration options and their values in this configuration set.

Type: Array of ConfigurationOptionSetting objects

PlatformArn

The ARN of the platform.

Type: String

SolutionStackName

The name of the solution stack this configuration set uses.

Type: String

TemplateName

If not null, the name of the configuration template for this configuration set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Errors

For information about the errors that are common to all actions, see Common Errors.

InsufficientPrivileges

The specified account does not have sufficient privileges for one of more AWS services.

HTTP Status Code: 403

TooManyBuckets

The specified account has reached its limit of Amazon S3 buckets.

HTTP Status Code: 400

TooManyConfigurationTemplates

The specified account has reached its limit of configuration templates.

HTTP Status Code: 400

Example

Sample Request

Copy
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp &TemplateName=AppTemplate &SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207 &Description=ConfigTemplateDescription &Operation=CreateConfigurationTemplate &AuthParams

Sample Response

Copy
<CreateConfigurationTemplateResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/"> <CreateConfigurationTemplateResult> <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName> <OptionSettings> <member> <OptionName>ImageId</OptionName> <Value>ami-f2f0069b</Value> <Namespace>aws:autoscaling:launchconfiguration</Namespace> </member> <member> <OptionName>Notification Endpoint</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:sns:topics</Namespace> </member> <member> <OptionName>PARAM4</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>JDBC_CONNECTION_STRING</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>SecurityGroups</OptionName> <Value>elasticbeanstalk-default</Value> <Namespace>aws:autoscaling:launchconfiguration</Namespace> </member> <member> <OptionName>UnhealthyThreshold</OptionName> <Value>5</Value> <Namespace>aws:elb:healthcheck</Namespace> </member> <member> <OptionName>InstanceType</OptionName> <Value>t1.micro</Value> <Namespace>aws:autoscaling:launchconfiguration</Namespace> </member> <member> <OptionName>Statistic</OptionName> <Value>Average</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>LoadBalancerHTTPSPort</OptionName> <Value>OFF</Value> <Namespace>aws:elb:loadbalancer</Namespace> </member> <member> <OptionName>Stickiness Cookie Expiration</OptionName> <Value>0</Value> <Namespace>aws:elb:policies</Namespace> </member> <member> <OptionName>PARAM5</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>MeasureName</OptionName> <Value>NetworkOut</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>Interval</OptionName> <Value>30</Value> <Namespace>aws:elb:healthcheck</Namespace> </member> <member> <OptionName>Application Healthcheck URL</OptionName> <Value>/</Value> <Namespace>aws:elasticbeanstalk:application</Namespace> </member> <member> <OptionName>Notification Topic ARN</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:sns:topics</Namespace> </member> <member> <OptionName>LowerBreachScaleIncrement</OptionName> <Value>-1</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>XX:MaxPermSize</OptionName> <Value>64m</Value> <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace> </member> <member> <OptionName>UpperBreachScaleIncrement</OptionName> <Value>1</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>MinSize</OptionName> <Value>1</Value> <Namespace>aws:autoscaling:asg</Namespace> </member> <member> <OptionName>Custom Availability Zones</OptionName> <Value>us-east-1a</Value> <Namespace>aws:autoscaling:asg</Namespace> </member> <member> <OptionName>Availability Zones</OptionName> <Value>Any 1</Value> <Namespace>aws:autoscaling:asg</Namespace> </member> <member> <OptionName>LogPublicationControl</OptionName> <Value>false</Value> <Namespace>aws:elasticbeanstalk:hostmanager</Namespace> </member> <member> <OptionName>JVM Options</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace> </member> <member> <OptionName>Notification Topic Name</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:sns:topics</Namespace> </member> <member> <OptionName>PARAM2</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>LoadBalancerHTTPPort</OptionName> <Value>80</Value> <Namespace>aws:elb:loadbalancer</Namespace> </member> <member> <OptionName>Timeout</OptionName> <Value>5</Value> <Namespace>aws:elb:healthcheck</Namespace> </member> <member> <OptionName>BreachDuration</OptionName> <Value>2</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>MonitoringInterval</OptionName> <Value>5 minute</Value> <Namespace>aws:autoscaling:launchconfiguration</Namespace> </member> <member> <OptionName>PARAM1</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>MaxSize</OptionName> <Value>4</Value> <Namespace>aws:autoscaling:asg</Namespace> </member> <member> <OptionName>LowerThreshold</OptionName> <Value>2000000</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>AWS_SECRET_KEY</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>AWS_ACCESS_KEY_ID</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>UpperThreshold</OptionName> <Value>6000000</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>Notification Protocol</OptionName> <Value>email</Value> <Namespace>aws:elasticbeanstalk:sns:topics</Namespace> </member> <member> <OptionName>Unit</OptionName> <Value>Bytes</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>Xmx</OptionName> <Value>256m</Value> <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace> </member> <member> <OptionName>Cooldown</OptionName> <Value>360</Value> <Namespace>aws:autoscaling:asg</Namespace> </member> <member> <OptionName>Period</OptionName> <Value>1</Value> <Namespace>aws:autoscaling:trigger</Namespace> </member> <member> <OptionName>Xms</OptionName> <Value>256m</Value> <Namespace>aws:elasticbeanstalk:container:tomcat:jvmoptions</Namespace> </member> <member> <OptionName>EC2KeyName</OptionName> <Value/> <Namespace>aws:autoscaling:launchconfiguration</Namespace> </member> <member> <OptionName>Stickiness Policy</OptionName> <Value>false</Value> <Namespace>aws:elb:policies</Namespace> </member> <member> <OptionName>PARAM3</OptionName> <Value/> <Namespace>aws:elasticbeanstalk:application:environment</Namespace> </member> <member> <OptionName>HealthyThreshold</OptionName> <Value>3</Value> <Namespace>aws:elb:healthcheck</Namespace> </member> <member> <OptionName>SSLCertificateId</OptionName> <Value/> <Namespace>aws:elb:loadbalancer</Namespace> </member> </OptionSettings> <Description>ConfigTemplateDescription</Description> <ApplicationName>SampleApp</ApplicationName> <DateCreated>2010-11-17T03:48:19.640Z</DateCreated> <TemplateName>AppTemplate</TemplateName> <DateUpdated>2010-11-17T03:48:19.640Z</DateUpdated> </CreateConfigurationTemplateResult> <ResponseMetadata> <RequestId>846cd905-f1fd-11df-8a78-9f77047e0d0c</RequestId> </ResponseMetadata> </CreateConfigurationTemplateResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: