AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

ConfigurationTemplate

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.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

    var tfTemplate = new Aws.ElasticBeanstalk.ConfigurationTemplate("tfTemplate", new()
    {
        Application = tftest.Name,
        SolutionStackName = "64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Description: pulumi.String("tf-test-desc"),
		})
		if err != nil {
			return err
		}
		_, err = elasticbeanstalk.NewConfigurationTemplate(ctx, "tfTemplate", &elasticbeanstalk.ConfigurationTemplateArgs{
			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
	})
}
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()        
            .description("tf-test-desc")
            .build());

        var tfTemplate = new ConfigurationTemplate("tfTemplate", ConfigurationTemplateArgs.builder()        
            .application(tftest.name())
            .solutionStackName("64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

tftest = aws.elasticbeanstalk.Application("tftest", description="tf-test-desc")
tf_template = aws.elasticbeanstalk.ConfigurationTemplate("tfTemplate",
    application=tftest.name,
    solution_stack_name="64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const tftest = new aws.elasticbeanstalk.Application("tftest", {description: "tf-test-desc"});
const tfTemplate = new aws.elasticbeanstalk.ConfigurationTemplate("tfTemplate", {
    application: tftest.name,
    solutionStackName: "64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4",
});
resources:
  tftest:
    type: aws:elasticbeanstalk:Application
    properties:
      description: tf-test-desc
  tfTemplate:
    type: aws:elasticbeanstalk:ConfigurationTemplate
    properties:
      application: ${tftest.name}
      solutionStackName: 64bit Amazon Linux 2015.09 v2.0.8 running Go 1.4

Create a ConfigurationTemplate Resource

new ConfigurationTemplate(name: string, args: ConfigurationTemplateArgs, opts?: CustomResourceOptions);
@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)
@overload
def ConfigurationTemplate(resource_name: str,
                          args: ConfigurationTemplateArgs,
                          opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args ConfigurationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args ConfigurationTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConfigurationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConfigurationTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The ConfigurationTemplate resource accepts the following input properties:

Application string

name of the application to associate with this configuration template

Description string

Short description of the Template

EnvironmentId string

The ID of the environment used with this configuration template

Name string

A unique name for this Template.

Settings List<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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

Application string

name of the application to associate with this configuration template

Description string

Short description of the Template

EnvironmentId string

The ID of the environment used with this configuration template

Name 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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application String

name of the application to associate with this configuration template

description String

Short description of the Template

environmentId String

The ID of the environment used with this configuration template

name String

A unique name for this Template.

settings List<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 String

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application string

name of the application to associate with this configuration template

description string

Short description of the Template

environmentId string

The ID of the environment used with this configuration template

name 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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application str

name of the application to associate with this configuration template

description str

Short description of the Template

environment_id str

The ID of the environment used with this configuration template

name 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 str

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application String

name of the application to associate with this configuration template

description String

Short description of the Template

environmentId String

The ID of the environment used with this configuration template

name 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 String

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

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 an 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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 string

name of the application to associate with this configuration template

Description string

Short description of the Template

EnvironmentId string

The ID of the environment used with this configuration template

Name string

A unique name for this Template.

Settings List<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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

Application string

name of the application to associate with this configuration template

Description string

Short description of the Template

EnvironmentId string

The ID of the environment used with this configuration template

Name 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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application String

name of the application to associate with this configuration template

description String

Short description of the Template

environmentId String

The ID of the environment used with this configuration template

name String

A unique name for this Template.

settings List<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 String

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application string

name of the application to associate with this configuration template

description string

Short description of the Template

environmentId string

The ID of the environment used with this configuration template

name 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 string

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application str

name of the application to associate with this configuration template

description str

Short description of the Template

environment_id str

The ID of the environment used with this configuration template

name 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 str

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

application String

name of the application to associate with this configuration template

description String

Short description of the Template

environmentId String

The ID of the environment used with this configuration template

name 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 String

A solution stack to base your Template off of. Example stacks can be found in the Amazon API documentation

Supporting Types

ConfigurationTemplateSetting

Name string

A unique name for this Template.

Namespace string
Value string
Resource string
Name string

A unique name for this Template.

Namespace string
Value string
Resource string
name String

A unique name for this Template.

namespace String
value String
resource String
name string

A unique name for this Template.

namespace string
value string
resource string
name str

A unique name for this Template.

namespace str
value str
resource str
name String

A unique name for this Template.

namespace String
value String
resource String

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.