software.amazon.awssdk.services.elasticbeanstalk.model

Interface CreateEnvironmentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, ElasticBeanstalkRequest.Builder, SdkBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateEnvironmentRequest

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

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentRequest.Builder	applicationName(String applicationName) The name of the application that is associated with this environment.
CreateEnvironmentRequest.Builder	cnamePrefix(String cnamePrefix) If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.
CreateEnvironmentRequest.Builder	description(String description) Your description for this environment.
CreateEnvironmentRequest.Builder	environmentName(String environmentName) A unique name for the environment.
CreateEnvironmentRequest.Builder	groupName(String groupName) The name of the group to which the target environment belongs.
CreateEnvironmentRequest.Builder	operationsRole(String operationsRole) The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
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	optionSettings(Consumer<ConfigurationOptionSetting.Builder>... 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(Consumer<OptionSpecification.Builder>... 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentRequest.Builder	platformArn(String platformArn) The Amazon Resource Name (ARN) of the custom platform to use with the environment.
CreateEnvironmentRequest.Builder	solutionStackName(String solutionStackName) The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
CreateEnvironmentRequest.Builder	tags(Collection<Tag> tags) Specifies the tags applied to resources in the environment.
CreateEnvironmentRequest.Builder	tags(Consumer<Tag.Builder>... tags) Specifies the tags applied to resources in the environment.
CreateEnvironmentRequest.Builder	tags(Tag... tags) Specifies the tags applied to resources in the environment.
CreateEnvironmentRequest.Builder	templateName(String templateName) The name of the Elastic Beanstalk configuration template to use with the environment.
default CreateEnvironmentRequest.Builder	tier(Consumer<EnvironmentTier.Builder> tier) Specifies the tier to use in creating this environment.
CreateEnvironmentRequest.Builder	tier(EnvironmentTier tier) Specifies the tier to use in creating this environment.
CreateEnvironmentRequest.Builder	versionLabel(String versionLabel) The name of the application version to deploy.

Methods inherited from interface software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

applicationName

CreateEnvironmentRequest.Builder applicationName(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.

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 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 the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.

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.

Parameters:

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 the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.

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.

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)

Your description for this environment.

Parameters:

description - Your description for 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 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. 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)

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. 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.

Returns:

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

tier

default CreateEnvironmentRequest.Builder tier(Consumer<EnvironmentTier.Builder> 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.

This is a convenience that creates an instance of the EnvironmentTier.Builder avoiding the need to create one manually via EnvironmentTier.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tier(EnvironmentTier).

Parameters:

tier - a consumer that will call methods on EnvironmentTier.Builder

Returns:

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

See Also:

tier(EnvironmentTier)

tags

CreateEnvironmentRequest.Builder tags(Collection<Tag> tags)

Specifies the tags applied to resources in the environment.

Parameters:

tags - 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)

Specifies the tags applied to resources in the environment.

Parameters:

tags - 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(Consumer<Tag.Builder>... tags)

Specifies the tags applied to resources in the environment.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

versionLabel

CreateEnvironmentRequest.Builder versionLabel(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.

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

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 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.

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

Returns:

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

solutionStackName

CreateEnvironmentRequest.Builder solutionStackName(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. 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.

Returns:

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

platformArn

CreateEnvironmentRequest.Builder platformArn(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. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

If you specify PlatformArn, don't specify SolutionStackName.

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.

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(Consumer<ConfigurationOptionSetting.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #optionSettings(List).

Parameters:

optionSettings - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#optionSettings(List)

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.

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(Consumer<OptionSpecification.Builder>... optionsToRemove)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #optionsToRemove(List).

Parameters:

optionsToRemove - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#optionsToRemove(List)

operationsRole

CreateEnvironmentRequest.Builder operationsRole(String operationsRole)

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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Parameters:

operationsRole - 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. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Returns:

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

overrideConfiguration

CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder