1. Packages
  2. AWS Native
  3. API Docs
  4. elasticbeanstalk
  5. ConfigurationTemplate

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.elasticbeanstalk.ConfigurationTemplate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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:

    ApplicationName string
    The name of the Elastic Beanstalk application to associate with this configuration template.
    Description string
    An optional description for this configuration.
    EnvironmentId 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.
    OptionSettings List<Pulumi.AwsNative.ElasticBeanstalk.Inputs.ConfigurationTemplateConfigurationOptionSetting>
    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.
    PlatformArn string
    The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
    SolutionStackName string

    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.

    SourceConfiguration Pulumi.AwsNative.ElasticBeanstalk.Inputs.ConfigurationTemplateSourceConfiguration

    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.

    ApplicationName string
    The name of the Elastic Beanstalk application to associate with this configuration template.
    Description string
    An optional description for this configuration.
    EnvironmentId 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.
    OptionSettings []ConfigurationTemplateConfigurationOptionSettingArgs
    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.
    PlatformArn string
    The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
    SolutionStackName string

    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.

    SourceConfiguration ConfigurationTemplateSourceConfigurationArgs

    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.

    applicationName String
    The name of the Elastic Beanstalk application to associate with this configuration template.
    description String
    An optional description for this configuration.
    environmentId 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.
    optionSettings List<ConfigurationTemplateConfigurationOptionSetting>
    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.
    platformArn String
    The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
    solutionStackName String

    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.

    sourceConfiguration ConfigurationTemplateSourceConfiguration

    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.

    applicationName string
    The name of the Elastic Beanstalk application to associate with this configuration template.
    description string
    An optional description for this configuration.
    environmentId 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.
    optionSettings ConfigurationTemplateConfigurationOptionSetting[]
    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.
    platformArn string
    The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
    solutionStackName string

    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.

    sourceConfiguration ConfigurationTemplateSourceConfiguration

    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[ConfigurationTemplateConfigurationOptionSettingArgs]
    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_name str

    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 ConfigurationTemplateSourceConfigurationArgs

    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.

    applicationName String
    The name of the Elastic Beanstalk application to associate with this configuration template.
    description String
    An optional description for this configuration.
    environmentId 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.
    optionSettings 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.
    platformArn String
    The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
    solutionStackName String

    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.

    sourceConfiguration 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.
    TemplateName string
    The name of the configuration template
    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateName string
    The name of the configuration template
    id String
    The provider-assigned unique ID for this managed resource.
    templateName String
    The name of the configuration template
    id string
    The provider-assigned unique ID for this managed resource.
    templateName 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.
    templateName String
    The name of the configuration template

    Supporting Types

    ConfigurationTemplateConfigurationOptionSetting, ConfigurationTemplateConfigurationOptionSettingArgs

    Namespace string
    A unique namespace that identifies the option's associated AWS resource.
    OptionName string
    The name of the configuration option.
    ResourceName 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.
    OptionName string
    The name of the configuration option.
    ResourceName 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.
    optionName String
    The name of the configuration option.
    resourceName 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.
    optionName string
    The name of the configuration option.
    resourceName 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.
    optionName String
    The name of the configuration option.
    resourceName 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

    ApplicationName string
    The name of the application associated with the configuration.
    TemplateName string
    The name of the configuration template.
    ApplicationName string
    The name of the application associated with the configuration.
    TemplateName string
    The name of the configuration template.
    applicationName String
    The name of the application associated with the configuration.
    templateName String
    The name of the configuration template.
    applicationName string
    The name of the application associated with the configuration.
    templateName 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.
    applicationName String
    The name of the application associated with the configuration.
    templateName String
    The name of the configuration template.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi