Package software.amazon.awscdk.services.elasticbeanstalk

Class CfnConfigurationTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.elasticbeanstalk.CfnConfigurationTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConfigurationTemplate>

Enclosing class:

CfnConfigurationTemplate

@Stability(Stable)
public static final class CfnConfigurationTemplate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnConfigurationTemplate>

A fluent builder for CfnConfigurationTemplate.

Method Summary

Modifier and Type	Method	Description
CfnConfigurationTemplate.Builder	applicationName(String applicationName)	The name of the Elastic Beanstalk application to associate with this configuration template.
CfnConfigurationTemplate	build()
static CfnConfigurationTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnConfigurationTemplate.Builder	description(String description)	An optional description for this configuration.
CfnConfigurationTemplate.Builder	environmentId(String environmentId)	The ID of an environment whose settings you want to use to create the configuration template.
CfnConfigurationTemplate.Builder	optionSettings(List<? extends Object> optionSettings)	Option values for the Elastic Beanstalk configuration, such as the instance type.
CfnConfigurationTemplate.Builder	optionSettings(IResolvable optionSettings)	Option values for the Elastic Beanstalk configuration, such as the instance type.
CfnConfigurationTemplate.Builder	platformArn(String platformArn)	The Amazon Resource Name (ARN) of the custom platform.
CfnConfigurationTemplate.Builder	solutionStackName(String solutionStackName)	The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.
CfnConfigurationTemplate.Builder	sourceConfiguration(IResolvable sourceConfiguration)	An Elastic Beanstalk configuration template to base this one on.
CfnConfigurationTemplate.Builder	sourceConfiguration(CfnConfigurationTemplate.SourceConfigurationProperty sourceConfiguration)	An Elastic Beanstalk configuration template to base this one on.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnConfigurationTemplate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnConfigurationTemplate.Builder.

applicationName

@Stability(Stable)
public CfnConfigurationTemplate.Builder applicationName(String applicationName)

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

Parameters:

applicationName - The name of the Elastic Beanstalk application to associate with this configuration template. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnConfigurationTemplate.Builder description(String description)

An optional description for this configuration.

Parameters:

description - An optional description for this configuration. This parameter is required.

Returns:

this

See Also:

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

environmentId

@Stability(Stable)
public CfnConfigurationTemplate.Builder environmentId(String environmentId)

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 .

Parameters:

environmentId - The ID of an environment whose settings you want to use to create the configuration template. This parameter is required.

Returns:

this

See Also:

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

optionSettings

@Stability(Stable)
public CfnConfigurationTemplate.Builder optionSettings(IResolvable optionSettings)

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 .

Parameters:

optionSettings - Option values for the Elastic Beanstalk configuration, such as the instance type. This parameter is required.

Returns:

this

See Also:

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

optionSettings

@Stability(Stable)
public CfnConfigurationTemplate.Builder optionSettings(List<? extends Object> optionSettings)

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 .

Parameters:

optionSettings - Option values for the Elastic Beanstalk configuration, such as the instance type. This parameter is required.

Returns:

this

See Also:

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

platformArn

@Stability(Stable)
public CfnConfigurationTemplate.Builder platformArn(String platformArn)

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

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

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

Parameters:

platformArn - The Amazon Resource Name (ARN) of the custom platform. This parameter is required.

Returns:

this

See Also:

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

solutionStackName

@Stability(Stable)
public CfnConfigurationTemplate.Builder solutionStackName(String solutionStackName)

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.

Parameters:

solutionStackName - The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. This parameter is required.

Returns:

this

See Also:

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

sourceConfiguration

@Stability(Stable)
public CfnConfigurationTemplate.Builder sourceConfiguration(IResolvable sourceConfiguration)

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.

Parameters:

sourceConfiguration - An Elastic Beanstalk configuration template to base this one on. This parameter is required.

Returns:

this

See Also:

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

sourceConfiguration

@Stability(Stable)
public CfnConfigurationTemplate.Builder sourceConfiguration(CfnConfigurationTemplate.SourceConfigurationProperty sourceConfiguration)

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.

Parameters:

sourceConfiguration - An Elastic Beanstalk configuration template to base this one on. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnConfigurationTemplate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnConfigurationTemplate>

Returns:

a newly built instance of CfnConfigurationTemplate.