CfnConfigurationTemplateProps

class aws_cdk.aws_elasticbeanstalk.CfnConfigurationTemplateProps(*, application_name, description=None, environment_id=None, option_settings=None, platform_arn=None, solution_stack_name=None, source_configuration=None)

Bases: object

Properties for defining a CfnConfigurationTemplate.

Parameters
  • application_name (str) – The name of the Elastic Beanstalk application to associate with this configuration template.

  • description (Optional[str]) – An optional description for this configuration.

  • environment_id (Optional[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 (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationOptionSettingProperty, Dict[str, Any]]], None]) – 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 (Optional[str]) – The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide . .. epigraph:: If you specify PlatformArn , then don’t specify SolutionStackName .

  • solution_stack_name (Optional[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 <https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html>`_ API to obtain a list of available solution stacks.

  • source_configuration (Union[IResolvable, SourceConfigurationProperty, Dict[str, Any], None]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticbeanstalk as elasticbeanstalk

cfn_configuration_template_props = elasticbeanstalk.CfnConfigurationTemplateProps(
    application_name="applicationName",

    # the properties below are optional
    description="description",
    environment_id="environmentId",
    option_settings=[elasticbeanstalk.CfnConfigurationTemplate.ConfigurationOptionSettingProperty(
        namespace="namespace",
        option_name="optionName",

        # the properties below are optional
        resource_name="resourceName",
        value="value"
    )],
    platform_arn="platformArn",
    solution_stack_name="solutionStackName",
    source_configuration=elasticbeanstalk.CfnConfigurationTemplate.SourceConfigurationProperty(
        application_name="applicationName",
        template_name="templateName"
    )
)

Attributes

application_name

The name of the Elastic Beanstalk application to associate with this configuration template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-applicationname

Return type

str

description

An optional description for this configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-description

Return type

Optional[str]

environment_id

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-environmentid

Return type

Optional[str]

option_settings

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-optionsettings

Return type

Union[IResolvable, List[Union[IResolvable, ConfigurationOptionSettingProperty]], None]

platform_arn

The Amazon Resource Name (ARN) of the custom platform.

For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide . .. epigraph:

If you specify ``PlatformArn`` , then don't specify ``SolutionStackName`` .
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-platformarn

Return type

Optional[str]

solution_stack_name

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 <https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html>`_ API to obtain a list of available solution stacks.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-solutionstackname

Return type

Optional[str]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration

Return type

Union[IResolvable, SourceConfigurationProperty, None]