Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.elasticbeanstalk.ConfigurationTemplate
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
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_name: Optional[str] = None,
description: Optional[str] = None,
environment_id: Optional[str] = None,
option_settings: Optional[Sequence[ConfigurationTemplateConfigurationOptionSettingArgs]] = None,
platform_arn: Optional[str] = None,
solution_stack_name: Optional[str] = None,
source_configuration: Optional[ConfigurationTemplateSourceConfigurationArgs] = 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-native:elasticbeanstalk:ConfigurationTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const configurationTemplateResource = new aws_native.elasticbeanstalk.ConfigurationTemplate("configurationTemplateResource", {
applicationName: "string",
description: "string",
environmentId: "string",
optionSettings: [{
namespace: "string",
optionName: "string",
resourceName: "string",
value: "string",
}],
platformArn: "string",
solutionStackName: "string",
sourceConfiguration: {
applicationName: "string",
templateName: "string",
},
});
Coming soon!
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
Name string - The name of the Elastic Beanstalk application to associate with this configuration template.
- Description string
- An optional description for this configuration.
- 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.
- Option
Settings List<Pulumi.Aws Native. Elastic Beanstalk. Inputs. Configuration Template Configuration Option Setting> - 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.
- 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.
- Solution
Stack stringName 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 API to obtain a list of available solution stacks.
- Source
Configuration Pulumi.Aws Native. Elastic Beanstalk. Inputs. Configuration Template Source Configuration 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.
- Application
Name string - The name of the Elastic Beanstalk application to associate with this configuration template.
- Description string
- An optional description for this configuration.
- 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.
- Option
Settings []ConfigurationTemplate Configuration Option Setting Args - 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.
- 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.
- Solution
Stack stringName 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 API to obtain a list of available solution stacks.
- Source
Configuration ConfigurationTemplate Source Configuration Args 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.
- application
Name String - The name of the Elastic Beanstalk application to associate with this configuration template.
- description String
- An optional description for this configuration.
- 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.
- option
Settings List<ConfigurationTemplate Configuration Option Setting> - 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.
- 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.
- solution
Stack StringName 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 API to obtain a list of available solution stacks.
- source
Configuration ConfigurationTemplate Source Configuration 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.
- application
Name string - The name of the Elastic Beanstalk application to associate with this configuration template.
- description string
- An optional description for this configuration.
- 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.
- option
Settings ConfigurationTemplate Configuration Option Setting[] - 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.
- 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.
- solution
Stack stringName 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 API to obtain a list of available solution stacks.
- source
Configuration ConfigurationTemplate Source Configuration 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.
- application_
name str - The name of the Elastic Beanstalk application to associate with this configuration template.
- description str
- An optional description for this configuration.
- environment_
id str - 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.
- option_
settings Sequence[ConfigurationTemplate Configuration Option Setting Args] - 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.
- platform_
arn str - The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
- solution_
stack_ strname 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 API to obtain a list of available solution stacks.
- source_
configuration ConfigurationTemplate Source Configuration Args 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.
- application
Name String - The name of the Elastic Beanstalk application to associate with this configuration template.
- description String
- An optional description for this configuration.
- 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.
- option
Settings List<Property Map> - 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.
- 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.
- solution
Stack StringName 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 API to obtain a list of available solution stacks.
- source
Configuration Property Map 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.
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.
- Template
Name string - The name of the configuration template
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Name string - The name of the configuration template
- id String
- The provider-assigned unique ID for this managed resource.
- template
Name String - The name of the configuration template
- id string
- The provider-assigned unique ID for this managed resource.
- template
Name string - The name of the configuration template
- id str
- The provider-assigned unique ID for this managed resource.
- template_
name str - The name of the configuration template
- id String
- The provider-assigned unique ID for this managed resource.
- template
Name String - The name of the configuration template
Supporting Types
ConfigurationTemplateConfigurationOptionSetting, ConfigurationTemplateConfigurationOptionSettingArgs
- Namespace string
- A unique namespace that identifies the option's associated AWS resource.
- Option
Name string - The name of the configuration option.
- Resource
Name string - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- Value string
- The current value for the configuration option.
- Namespace string
- A unique namespace that identifies the option's associated AWS resource.
- Option
Name string - The name of the configuration option.
- Resource
Name string - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- Value string
- The current value for the configuration option.
- namespace String
- A unique namespace that identifies the option's associated AWS resource.
- option
Name String - The name of the configuration option.
- resource
Name String - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- value String
- The current value for the configuration option.
- namespace string
- A unique namespace that identifies the option's associated AWS resource.
- option
Name string - The name of the configuration option.
- resource
Name string - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- value string
- The current value for the configuration option.
- namespace str
- A unique namespace that identifies the option's associated AWS resource.
- option_
name str - The name of the configuration option.
- resource_
name str - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- value str
- The current value for the configuration option.
- namespace String
- A unique namespace that identifies the option's associated AWS resource.
- option
Name String - The name of the configuration option.
- resource
Name String - A unique resource name for the option setting. Use it for a time–based scaling configuration option.
- value String
- The current value for the configuration option.
ConfigurationTemplateSourceConfiguration, ConfigurationTemplateSourceConfigurationArgs
- Application
Name string - The name of the application associated with the configuration.
- Template
Name string - The name of the configuration template.
- Application
Name string - The name of the application associated with the configuration.
- Template
Name string - The name of the configuration template.
- application
Name String - The name of the application associated with the configuration.
- template
Name String - The name of the configuration template.
- application
Name string - The name of the application associated with the configuration.
- template
Name string - The name of the configuration template.
- application_
name str - The name of the application associated with the configuration.
- template_
name str - The name of the configuration template.
- application
Name String - The name of the application associated with the configuration.
- template
Name String - The name of the configuration template.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.