software.amazon.awssdk.services.elasticbeanstalk.model

Class CreateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.CreateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEnvironmentRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationName() The name of the application that contains the version to be deployed.
static CreateEnvironmentRequest.Builder	builder()
String	cnamePrefix() If specified, the environment attempts to use this value as the prefix for the CNAME.
String	description() Describes this environment.
String	environmentName() A unique name for the deployment environment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
String	groupName() The name of the group to which the target environment belongs.
int	hashCode()
List<ConfigurationOptionSetting>	optionSettings() If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
List<OptionSpecification>	optionsToRemove() A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String	platformArn() The ARN of the platform.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEnvironmentRequest.Builder>	serializableBuilderClass()
String	solutionStackName() This is an alternative to specifying a template name.
List<Tag>	tags() This specifies the tags applied to resources in the environment.
String	templateName() The name of the configuration template to use in deployment.
EnvironmentTier	tier() This specifies the tier to use for creating this environment.
CreateEnvironmentRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionLabel() The name of the application version to deploy.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationName

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

Returns:

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.

environmentName

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

Returns:

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.

groupName

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

Returns:

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.

description

public String description()

Describes this environment.

Returns:

Describes this environment.

cnamePrefix

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

Returns:

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.

tier

public EnvironmentTier tier()

This specifies the tier to use for creating this environment.

Returns:

This specifies the tier to use for creating this environment.

tags

public List<Tag> tags()

This specifies the tags applied to resources in the environment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

This specifies the tags applied to resources in the environment.

versionLabel

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

Returns:

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.

templateName

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

Returns:

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.

solutionStackName

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

For a list of current solution stacks, see Elastic Beanstalk Supported Platforms.

Returns:

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.

For a list of current solution stacks, see Elastic Beanstalk Supported Platforms.

platformArn

public String platformArn()

The ARN of the platform.

Returns:

The ARN of the platform.

optionSettings

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

optionsToRemove

public List<OptionSpecification> optionsToRemove()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public CreateEnvironmentRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

Returns:

a builder for type T

builder

public static CreateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.