public static interface CreateEnvironmentRequest.Builder extends ElasticBeanstalkRequest.Builder, CopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
Modifier and Type | Method and 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 |
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)
Add an optional request override configuration.
|
CreateEnvironmentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateEnvironmentRequest.Builder |
platformArn(String platformArn)
The ARN of the 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(Consumer<Tag.Builder>... 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.
|
default CreateEnvironmentRequest.Builder |
tier(Consumer<EnvironmentTier.Builder> tier)
This specifies the tier to use for creating this environment.
|
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.
|
build
overrideConfiguration
copy
applyMutation, build
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.
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.
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 within a region in your account. If
the specified name already exists in the region, 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.
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 within a region in your
account. If the specified name already exists in the region, 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.
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.
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.CreateEnvironmentRequest.Builder description(String description)
Describes this environment.
description
- Describes this environment.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.
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.CreateEnvironmentRequest.Builder tier(EnvironmentTier tier)
This specifies the tier to use for creating this environment.
tier
- This specifies the tier to use for creating this environment.default CreateEnvironmentRequest.Builder tier(Consumer<EnvironmentTier.Builder> tier)
This specifies the tier to use for creating this environment.
This is a convenience that creates an instance of theEnvironmentTier.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)
.tier
- a consumer that will call methods on EnvironmentTier.Builder
tier(EnvironmentTier)
CreateEnvironmentRequest.Builder tags(Collection<Tag> tags)
This specifies the tags applied to resources in the environment.
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.
tags
- This specifies the tags applied to resources in the environment.CreateEnvironmentRequest.Builder tags(Consumer<Tag.Builder>... tags)
This specifies the tags applied to resources in the environment.
This is a convenience that creates an instance of theList.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)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
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.
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.
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.
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.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.
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.CreateEnvironmentRequest.Builder platformArn(String platformArn)
The ARN of the platform.
platformArn
- The ARN of the platform.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.
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.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.
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.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 theList.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)
.optionSettings
- a consumer that will call methods on List.Builder
#optionSettings(List)
CreateEnvironmentRequest.Builder optionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
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.
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.
This is a convenience that creates an instance of theList.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)
.optionsToRemove
- a consumer that will call methods on List.Builder
#optionsToRemove(List)
CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.