Package software.amazon.awssdk.services.elasticbeanstalk.model

Interface CreateEnvironmentRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, SdkBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Enclosing class:

CreateEnvironmentRequest

public static interface CreateEnvironmentRequest.Builder
extends CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Method Summary

Modifier and Type	Method	Description
CreateEnvironmentRequest.Builder	applicationName(String applicationName)	The name of the application that contains the version to be deployed.
CreateEnvironmentRequest.Builder	cnamePrefix(String cnamePrefix)	If specified, the environment attempts to use this value as the prefix for the CNAME.
CreateEnvironmentRequest.Builder	description(String description)	Describes this environment.
CreateEnvironmentRequest.Builder	environmentName(String environmentName)	A unique name for the deployment environment.
CreateEnvironmentRequest.Builder	groupName(String groupName)	The name of the group to which the target environment belongs.
CreateEnvironmentRequest.Builder	optionSettings(Collection<ConfigurationOptionSetting> optionSettings)	If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
CreateEnvironmentRequest.Builder	optionSettings(ConfigurationOptionSetting... optionSettings)	If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
CreateEnvironmentRequest.Builder	optionsToRemove(Collection<OptionSpecification> optionsToRemove)	A list of custom user-defined configuration options to remove from the configuration set for this new environment.
CreateEnvironmentRequest.Builder	optionsToRemove(OptionSpecification... optionsToRemove)	A list of custom user-defined configuration options to remove from the configuration set for this new environment.
CreateEnvironmentRequest.Builder	platformArn(String platformArn)	The ARN of the custom platform.
CreateEnvironmentRequest.Builder	solutionStackName(String solutionStackName)	This is an alternative to specifying a template name.
CreateEnvironmentRequest.Builder	tags(Collection<Tag> tags)	This specifies the tags applied to resources in the environment.
CreateEnvironmentRequest.Builder	tags(Tag... tags)	This specifies the tags applied to resources in the environment.
CreateEnvironmentRequest.Builder	templateName(String templateName)	The name of the configuration template to use in deployment.
CreateEnvironmentRequest.Builder	tier(EnvironmentTier tier)	This specifies the tier to use for creating this environment.
CreateEnvironmentRequest.Builder	versionLabel(String versionLabel)	The name of the application version to deploy.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

applicationName

CreateEnvironmentRequest.Builder applicationName(String applicationName)

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Parameters:

applicationName - The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentName

CreateEnvironmentRequest.Builder environmentName(String environmentName)

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Parameters:

environmentName - A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupName

CreateEnvironmentRequest.Builder groupName(String groupName)

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

Parameters:

groupName - The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateEnvironmentRequest.Builder description(String description)

Describes this environment.

Parameters:

description - Describes this environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

cnamePrefix

CreateEnvironmentRequest.Builder cnamePrefix(String cnamePrefix)

If specified, the environment attempts to use this value as the prefix for the CNAME. 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. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Returns:

Returns a reference to this object so that method calls can be chained together.

tier

CreateEnvironmentRequest.Builder tier(EnvironmentTier tier)

This specifies the tier to use for creating this environment.

Parameters:

tier - This specifies the tier to use for creating this environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateEnvironmentRequest.Builder tags(Collection<Tag> tags)

This specifies the tags applied to resources in the environment.

Parameters:

tags - This specifies the tags applied to resources in the environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateEnvironmentRequest.Builder tags(Tag... tags)

This specifies the tags applied to resources in the environment.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - This specifies the tags applied to resources in the environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionLabel

CreateEnvironmentRequest.Builder versionLabel(String versionLabel)

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Parameters:

versionLabel - The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateName

CreateEnvironmentRequest.Builder templateName(String templateName)

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Parameters:

templateName - The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

Returns a reference to this object so that method calls can be chained together.

solutionStackName

CreateEnvironmentRequest.Builder solutionStackName(String solutionStackName)

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Parameters:

solutionStackName - This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Returns:

Returns a reference to this object so that method calls can be chained together.

platformArn

CreateEnvironmentRequest.Builder platformArn(String platformArn)

The ARN of the custom platform.

Parameters:

platformArn - The ARN of the custom platform.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionSettings

CreateEnvironmentRequest.Builder optionSettings(Collection<ConfigurationOptionSetting> optionSettings)

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Parameters:

optionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionSettings

CreateEnvironmentRequest.Builder optionSettings(ConfigurationOptionSetting... optionSettings)

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

NOTE: This method appends the values to the existing list (if any). Use #setOptionSettings(java.util.Collection) or #withOptionSettings(java.util.Collection) if you want to override the existing values.

Parameters:

optionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionsToRemove

CreateEnvironmentRequest.Builder optionsToRemove(Collection<OptionSpecification> optionsToRemove)

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Parameters:

optionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionsToRemove

CreateEnvironmentRequest.Builder optionsToRemove(OptionSpecification... optionsToRemove)

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

NOTE: This method appends the values to the existing list (if any). Use #setOptionsToRemove(java.util.Collection) or #withOptionsToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

optionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Returns:

Returns a reference to this object so that method calls can be chained together.