software.amazon.awscdk.services.elasticbeanstalk

Class CfnEnvironment.Builder

java.lang.Object

software.amazon.awscdk.services.elasticbeanstalk.CfnEnvironment.Builder

Enclosing class:

CfnEnvironment

public static final class CfnEnvironment.Builder
extends java.lang.Object

A fluent builder for CfnEnvironment.

Method Summary

Modifier and Type	Method and Description
CfnEnvironment.Builder	applicationName(java.lang.String applicationName) The name of the application that is associated with this environment.
CfnEnvironment	build()
CfnEnvironment.Builder	cnamePrefix(java.lang.String cnamePrefix) If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
static CfnEnvironment.Builder	create(Construct scope, java.lang.String id)
CfnEnvironment.Builder	description(java.lang.String description) Your description for this environment.
CfnEnvironment.Builder	environmentName(java.lang.String environmentName) A unique name for the environment.
CfnEnvironment.Builder	operationsRole(java.lang.String operationsRole) > The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.
CfnEnvironment.Builder	optionSettings(IResolvable optionSettings) Key-value pairs defining configuration options for this environment, such as the instance type.
CfnEnvironment.Builder	optionSettings(java.util.List<? extends java.lang.Object> optionSettings) Key-value pairs defining configuration options for this environment, such as the instance type.
CfnEnvironment.Builder	platformArn(java.lang.String platformArn) The Amazon Resource Name (ARN) of the custom platform to use with the environment.
CfnEnvironment.Builder	solutionStackName(java.lang.String solutionStackName) The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
CfnEnvironment.Builder	tags(java.util.List<? extends CfnTag> tags) Specifies the tags applied to resources in the environment.
CfnEnvironment.Builder	templateName(java.lang.String templateName) The name of the Elastic Beanstalk configuration template to use with the environment.
CfnEnvironment.Builder	tier(CfnEnvironment.TierProperty tier) Specifies the tier to use in creating this environment.
CfnEnvironment.Builder	tier(IResolvable tier) Specifies the tier to use in creating this environment.
CfnEnvironment.Builder	versionLabel(java.lang.String versionLabel) The name of the application version to deploy.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnEnvironment.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnEnvironment.OptionSettingProperty.Builder.

applicationName

public CfnEnvironment.Builder applicationName(java.lang.String applicationName)

The name of the application that is associated with this environment.

Parameters:

applicationName - The name of the application that is associated with this environment. This parameter is required.

Returns:

this

cnamePrefix

public CfnEnvironment.Builder cnamePrefix(java.lang.String cnamePrefix)

If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.

If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Parameters:

cnamePrefix - If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. This parameter is required.

Returns:

this

description

public CfnEnvironment.Builder description(java.lang.String description)

Your description for this environment.

Parameters:

description - Your description for this environment. This parameter is required.

Returns:

this

environmentName

public CfnEnvironment.Builder environmentName(java.lang.String environmentName)

A unique name for the environment.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account.

If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

If you don't specify an environment name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

environmentName - A unique name for the environment. This parameter is required.

Returns:

this

operationsRole

public CfnEnvironment.Builder operationsRole(java.lang.String operationsRole)

> The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change.

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role.

Parameters:

operationsRole - > The operations role feature of AWS Elastic Beanstalk is in beta release and is subject to change. This parameter is required.

Returns:

this

optionSettings

public CfnEnvironment.Builder optionSettings(IResolvable optionSettings)

Key-value pairs defining configuration options for this environment, such as the instance type.

These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.

Parameters:

optionSettings - Key-value pairs defining configuration options for this environment, such as the instance type. This parameter is required.

Returns:

this

optionSettings

public CfnEnvironment.Builder optionSettings(java.util.List<? extends java.lang.Object> optionSettings)

Key-value pairs defining configuration options for this environment, such as the instance type.

These options override the values that are defined in the solution stack or the configuration template . If you remove any options during a stack update, the removed options retain their current values.

Parameters:

optionSettings - Key-value pairs defining configuration options for this environment, such as the instance type. This parameter is required.

Returns:

this

platformArn

public CfnEnvironment.Builder platformArn(java.lang.String platformArn)

The Amazon Resource Name (ARN) of the custom platform to use with the environment.

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

If you specify PlatformArn , don't specify SolutionStackName .

Parameters:

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

Returns:

this

solutionStackName

public CfnEnvironment.Builder solutionStackName(java.lang.String solutionStackName)

The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.

If you specify SolutionStackName , don't specify PlatformArn or TemplateName .

Parameters:

solutionStackName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. This parameter is required.

Returns:

this

tags

public CfnEnvironment.Builder tags(java.util.List<? extends CfnTag> tags)

Specifies the tags applied to resources in the environment.

Parameters:

tags - Specifies the tags applied to resources in the environment. This parameter is required.

Returns:

this

templateName

public CfnEnvironment.Builder templateName(java.lang.String templateName)

The name of the Elastic Beanstalk configuration template to use with the environment.

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

Parameters:

templateName - The name of the Elastic Beanstalk configuration template to use with the environment. This parameter is required.

Returns:

this

tier

public CfnEnvironment.Builder tier(IResolvable tier)

Specifies the tier to use in creating this environment.

The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

Parameters:

tier - Specifies the tier to use in creating this environment. This parameter is required.

Returns:

this

tier

public CfnEnvironment.Builder tier(CfnEnvironment.TierProperty tier)

Specifies the tier to use in creating this environment.

The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

Parameters:

tier - Specifies the tier to use in creating this environment. This parameter is required.

Returns:

this

versionLabel

public CfnEnvironment.Builder versionLabel(java.lang.String versionLabel)

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Parameters:

versionLabel - The name of the application version to deploy. This parameter is required.

Returns:

this

build

public CfnEnvironment build()