1. Packages
  2. AWS
  3. API Docs
  4. elasticbeanstalk
  5. ConfigurationTemplate
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.elasticbeanstalk.ConfigurationTemplate

Explore with Pulumi AI

Provides an Elastic Beanstalk Configuration Template, which are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const tftest = new aws.elasticbeanstalk.Application("tftest", {
    name: "tf-test-name",
    description: "tf-test-desc",
});
const myTemplate = new aws.elasticbeanstalk.ConfigurationTemplate("my_template", {
    name: "tf-test-template-config",
    application: tftest.name,
    solutionStackName: "64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4",
});
Copy
import pulumi
import pulumi_aws as aws

tftest = aws.elasticbeanstalk.Application("tftest",
    name="tf-test-name",
    description="tf-test-desc")
my_template = aws.elasticbeanstalk.ConfigurationTemplate("my_template",
    name="tf-test-template-config",
    application=tftest.name,
    solution_stack_name="64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/elasticbeanstalk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tftest, err := elasticbeanstalk.NewApplication(ctx, "tftest", &elasticbeanstalk.ApplicationArgs{
			Name:        pulumi.String("tf-test-name"),
			Description: pulumi.String("tf-test-desc"),
		})
		if err != nil {
			return err
		}
		_, err = elasticbeanstalk.NewConfigurationTemplate(ctx, "my_template", &elasticbeanstalk.ConfigurationTemplateArgs{
			Name:              pulumi.String("tf-test-template-config"),
			Application:       tftest.Name,
			SolutionStackName: pulumi.String("64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var tftest = new Aws.ElasticBeanstalk.Application("tftest", new()
    {
        Name = "tf-test-name",
        Description = "tf-test-desc",
    });

    var myTemplate = new Aws.ElasticBeanstalk.ConfigurationTemplate("my_template", new()
    {
        Name = "tf-test-template-config",
        Application = tftest.Name,
        SolutionStackName = "64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticbeanstalk.Application;
import com.pulumi.aws.elasticbeanstalk.ApplicationArgs;
import com.pulumi.aws.elasticbeanstalk.ConfigurationTemplate;
import com.pulumi.aws.elasticbeanstalk.ConfigurationTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tftest = new Application("tftest", ApplicationArgs.builder()
            .name("tf-test-name")
            .description("tf-test-desc")
            .build());

        var myTemplate = new ConfigurationTemplate("myTemplate", ConfigurationTemplateArgs.builder()
            .name("tf-test-template-config")
            .application(tftest.name())
            .solutionStackName("64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4")
            .build());

    }
}
Copy
resources:
  tftest:
    type: aws:elasticbeanstalk:Application
    properties:
      name: tf-test-name
      description: tf-test-desc
  myTemplate:
    type: aws:elasticbeanstalk:ConfigurationTemplate
    name: my_template
    properties:
      name: tf-test-template-config
      application: ${tftest.name}
      solutionStackName: 64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4
Copy

Option Settings

The setting field supports the following format:

  • namespace - unique namespace identifying the option’s associated AWS resource
  • name - name of the configuration option
  • value - value for the configuration option
  • resource - (Optional) resource name for scheduled action

Create ConfigurationTemplate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ConfigurationTemplate(name: string, args: ConfigurationTemplateArgs, opts?: CustomResourceOptions);
@overload
def ConfigurationTemplate(resource_name: str,
                          args: ConfigurationTemplateArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ConfigurationTemplate(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          application: Optional[str] = None,
                          description: Optional[str] = None,
                          environment_id: Optional[str] = None,
                          name: Optional[str] = None,
                          settings: Optional[Sequence[ConfigurationTemplateSettingArgs]] = None,
                          solution_stack_name: Optional[str] = None)
func NewConfigurationTemplate(ctx *Context, name string, args ConfigurationTemplateArgs, opts ...ResourceOption) (*ConfigurationTemplate, error)
public ConfigurationTemplate(string name, ConfigurationTemplateArgs args, CustomResourceOptions? opts = null)
public ConfigurationTemplate(String name, ConfigurationTemplateArgs args)
public ConfigurationTemplate(String name, ConfigurationTemplateArgs args, CustomResourceOptions options)
type: aws:elasticbeanstalk:ConfigurationTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConfigurationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ConfigurationTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ConfigurationTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConfigurationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConfigurationTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var configurationTemplateResource = new Aws.ElasticBeanstalk.ConfigurationTemplate("configurationTemplateResource", new()
{
    Application = "string",
    Description = "string",
    EnvironmentId = "string",
    Name = "string",
    Settings = new[]
    {
        new Aws.ElasticBeanstalk.Inputs.ConfigurationTemplateSettingArgs
        {
            Name = "string",
            Namespace = "string",
            Value = "string",
            Resource = "string",
        },
    },
    SolutionStackName = "string",
});
Copy
example, err := elasticbeanstalk.NewConfigurationTemplate(ctx, "configurationTemplateResource", &elasticbeanstalk.ConfigurationTemplateArgs{
	Application:   pulumi.String("string"),
	Description:   pulumi.String("string"),
	EnvironmentId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	Settings: elasticbeanstalk.ConfigurationTemplateSettingArray{
		&elasticbeanstalk.ConfigurationTemplateSettingArgs{
			Name:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			Value:     pulumi.String("string"),
			Resource:  pulumi.String("string"),
		},
	},
	SolutionStackName: pulumi.String("string"),
})
Copy
var configurationTemplateResource = new ConfigurationTemplate("configurationTemplateResource", ConfigurationTemplateArgs.builder()
    .application("string")
    .description("string")
    .environmentId("string")
    .name("string")
    .settings(ConfigurationTemplateSettingArgs.builder()
        .name("string")
        .namespace("string")
        .value("string")
        .resource("string")
        .build())
    .solutionStackName("string")
    .build());
Copy
configuration_template_resource = aws.elasticbeanstalk.ConfigurationTemplate("configurationTemplateResource",
    application="string",
    description="string",
    environment_id="string",
    name="string",
    settings=[{
        "name": "string",
        "namespace": "string",
        "value": "string",
        "resource": "string",
    }],
    solution_stack_name="string")
Copy
const configurationTemplateResource = new aws.elasticbeanstalk.ConfigurationTemplate("configurationTemplateResource", {
    application: "string",
    description: "string",
    environmentId: "string",
    name: "string",
    settings: [{
        name: "string",
        namespace: "string",
        value: "string",
        resource: "string",
    }],
    solutionStackName: "string",
});
Copy
type: aws:elasticbeanstalk:ConfigurationTemplate
properties:
    application: string
    description: string
    environmentId: string
    name: string
    settings:
        - name: string
          namespace: string
          resource: string
          value: string
    solutionStackName: string
Copy

ConfigurationTemplate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConfigurationTemplate resource accepts the following input properties:

Application
This property is required.
Changes to this property will trigger replacement.
string
name of the application to associate with this configuration template
Description string
Short description of the Template
EnvironmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
Name Changes to this property will trigger replacement. string
A unique name for this Template.
Settings List<ConfigurationTemplateSetting>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
SolutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
Application
This property is required.
Changes to this property will trigger replacement.
string
name of the application to associate with this configuration template
Description string
Short description of the Template
EnvironmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
Name Changes to this property will trigger replacement. string
A unique name for this Template.
Settings []ConfigurationTemplateSettingArgs
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
SolutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application
This property is required.
Changes to this property will trigger replacement.
String
name of the application to associate with this configuration template
description String
Short description of the Template
environmentId Changes to this property will trigger replacement. String
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. String
A unique name for this Template.
settings List<ConfigurationTemplateSetting>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. String
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application
This property is required.
Changes to this property will trigger replacement.
string
name of the application to associate with this configuration template
description string
Short description of the Template
environmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. string
A unique name for this Template.
settings ConfigurationTemplateSetting[]
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application
This property is required.
Changes to this property will trigger replacement.
str
name of the application to associate with this configuration template
description str
Short description of the Template
environment_id Changes to this property will trigger replacement. str
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. str
A unique name for this Template.
settings Sequence[ConfigurationTemplateSettingArgs]
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solution_stack_name Changes to this property will trigger replacement. str
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application
This property is required.
Changes to this property will trigger replacement.
String
name of the application to associate with this configuration template
description String
Short description of the Template
environmentId Changes to this property will trigger replacement. String
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. String
A unique name for this Template.
settings List<Property Map>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. String
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]

Outputs

All input properties are implicitly available as output properties. Additionally, the ConfigurationTemplate resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ConfigurationTemplate Resource

Get an existing ConfigurationTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConfigurationTemplateState, opts?: CustomResourceOptions): ConfigurationTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application: Optional[str] = None,
        description: Optional[str] = None,
        environment_id: Optional[str] = None,
        name: Optional[str] = None,
        settings: Optional[Sequence[ConfigurationTemplateSettingArgs]] = None,
        solution_stack_name: Optional[str] = None) -> ConfigurationTemplate
func GetConfigurationTemplate(ctx *Context, name string, id IDInput, state *ConfigurationTemplateState, opts ...ResourceOption) (*ConfigurationTemplate, error)
public static ConfigurationTemplate Get(string name, Input<string> id, ConfigurationTemplateState? state, CustomResourceOptions? opts = null)
public static ConfigurationTemplate get(String name, Output<String> id, ConfigurationTemplateState state, CustomResourceOptions options)
resources:  _:    type: aws:elasticbeanstalk:ConfigurationTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Application Changes to this property will trigger replacement. string
name of the application to associate with this configuration template
Description string
Short description of the Template
EnvironmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
Name Changes to this property will trigger replacement. string
A unique name for this Template.
Settings List<ConfigurationTemplateSetting>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
SolutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
Application Changes to this property will trigger replacement. string
name of the application to associate with this configuration template
Description string
Short description of the Template
EnvironmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
Name Changes to this property will trigger replacement. string
A unique name for this Template.
Settings []ConfigurationTemplateSettingArgs
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
SolutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application Changes to this property will trigger replacement. String
name of the application to associate with this configuration template
description String
Short description of the Template
environmentId Changes to this property will trigger replacement. String
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. String
A unique name for this Template.
settings List<ConfigurationTemplateSetting>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. String
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application Changes to this property will trigger replacement. string
name of the application to associate with this configuration template
description string
Short description of the Template
environmentId Changes to this property will trigger replacement. string
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. string
A unique name for this Template.
settings ConfigurationTemplateSetting[]
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. string
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application Changes to this property will trigger replacement. str
name of the application to associate with this configuration template
description str
Short description of the Template
environment_id Changes to this property will trigger replacement. str
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. str
A unique name for this Template.
settings Sequence[ConfigurationTemplateSettingArgs]
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solution_stack_name Changes to this property will trigger replacement. str
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]
application Changes to this property will trigger replacement. String
name of the application to associate with this configuration template
description String
Short description of the Template
environmentId Changes to this property will trigger replacement. String
The ID of the environment used with this configuration template
name Changes to this property will trigger replacement. String
A unique name for this Template.
settings List<Property Map>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
solutionStackName Changes to this property will trigger replacement. String
A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1]

Supporting Types

ConfigurationTemplateSetting
, ConfigurationTemplateSettingArgs

Name This property is required. string
A unique name for this Template.
Namespace This property is required. string
Value This property is required. string
Resource string
Name This property is required. string
A unique name for this Template.
Namespace This property is required. string
Value This property is required. string
Resource string
name This property is required. String
A unique name for this Template.
namespace This property is required. String
value This property is required. String
resource String
name This property is required. string
A unique name for this Template.
namespace This property is required. string
value This property is required. string
resource string
name This property is required. str
A unique name for this Template.
namespace This property is required. str
value This property is required. str
resource str
name This property is required. String
A unique name for this Template.
namespace This property is required. String
value This property is required. String
resource String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.