software.amazon.awssdk.services.m2.model

Interface CreateEnvironmentRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateEnvironmentRequest

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

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.
CreateEnvironmentRequest.Builder	description(String description) The description of the environment.
CreateEnvironmentRequest.Builder	engineType(EngineType engineType) The engine type for the environment.
CreateEnvironmentRequest.Builder	engineType(String engineType) The engine type for the environment.
CreateEnvironmentRequest.Builder	engineVersion(String engineVersion) The version of the engine type for the environment.
default CreateEnvironmentRequest.Builder	highAvailabilityConfig(Consumer<HighAvailabilityConfig.Builder> highAvailabilityConfig) The details of a high availability configuration for this runtime environment.
CreateEnvironmentRequest.Builder	highAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig) The details of a high availability configuration for this runtime environment.
CreateEnvironmentRequest.Builder	instanceType(String instanceType) The type of instance for the environment.
CreateEnvironmentRequest.Builder	name(String name) The unique identifier of the environment.
CreateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Configures a desired maintenance window for the environment.
CreateEnvironmentRequest.Builder	publiclyAccessible(Boolean publiclyAccessible) Specifies whether the environment is publicly accessible.
CreateEnvironmentRequest.Builder	securityGroupIds(Collection<String> securityGroupIds) The list of security groups for the VPC associated with this environment.
CreateEnvironmentRequest.Builder	securityGroupIds(String... securityGroupIds) The list of security groups for the VPC associated with this environment.
CreateEnvironmentRequest.Builder	storageConfigurations(Collection<StorageConfiguration> storageConfigurations) Optional.
CreateEnvironmentRequest.Builder	storageConfigurations(Consumer<StorageConfiguration.Builder>... storageConfigurations) Optional.
CreateEnvironmentRequest.Builder	storageConfigurations(StorageConfiguration... storageConfigurations) Optional.
CreateEnvironmentRequest.Builder	subnetIds(Collection<String> subnetIds) The list of subnets associated with the VPC for this environment.
CreateEnvironmentRequest.Builder	subnetIds(String... subnetIds) The list of subnets associated with the VPC for this environment.
CreateEnvironmentRequest.Builder	tags(Map<String,String> tags) The tags for the environment.

Methods inherited from interface software.amazon.awssdk.services.m2.model.M2Request.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

clientToken

CreateEnvironmentRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Returns:

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

description

CreateEnvironmentRequest.Builder description(String description)

The description of the environment.

Parameters:

description - The description of the environment.

Returns:

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

engineType

CreateEnvironmentRequest.Builder engineType(String engineType)

The engine type for the environment.

Parameters:

engineType - The engine type for the environment.

Returns:

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

See Also:

EngineType, EngineType

engineType

CreateEnvironmentRequest.Builder engineType(EngineType engineType)

The engine type for the environment.

Parameters:

engineType - The engine type for the environment.

Returns:

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

See Also:

EngineType, EngineType

engineVersion

CreateEnvironmentRequest.Builder engineVersion(String engineVersion)

The version of the engine type for the environment.

Parameters:

engineVersion - The version of the engine type for the environment.

Returns:

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

highAvailabilityConfig

CreateEnvironmentRequest.Builder highAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig)

The details of a high availability configuration for this runtime environment.

Parameters:

highAvailabilityConfig - The details of a high availability configuration for this runtime environment.

Returns:

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

highAvailabilityConfig

default CreateEnvironmentRequest.Builder highAvailabilityConfig(Consumer<HighAvailabilityConfig.Builder> highAvailabilityConfig)

The details of a high availability configuration for this runtime environment.

This is a convenience method that creates an instance of the HighAvailabilityConfig.Builder avoiding the need to create one manually via HighAvailabilityConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to highAvailabilityConfig(HighAvailabilityConfig).

Parameters:

highAvailabilityConfig - a consumer that will call methods on HighAvailabilityConfig.Builder

Returns:

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

See Also:

highAvailabilityConfig(HighAvailabilityConfig)

instanceType

CreateEnvironmentRequest.Builder instanceType(String instanceType)

The type of instance for the environment.

Parameters:

instanceType - The type of instance for the environment.

Returns:

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

name

CreateEnvironmentRequest.Builder name(String name)

The unique identifier of the environment.

Parameters:

name - The unique identifier of the environment.

Returns:

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

preferredMaintenanceWindow

CreateEnvironmentRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

Parameters:

preferredMaintenanceWindow - Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

Returns:

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

publiclyAccessible

CreateEnvironmentRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

Specifies whether the environment is publicly accessible.

Parameters:

publiclyAccessible - Specifies whether the environment is publicly accessible.

Returns:

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

securityGroupIds

CreateEnvironmentRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

The list of security groups for the VPC associated with this environment.

Parameters:

securityGroupIds - The list of security groups for the VPC associated with this environment.

Returns:

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

securityGroupIds

CreateEnvironmentRequest.Builder securityGroupIds(String... securityGroupIds)

The list of security groups for the VPC associated with this environment.

Parameters:

securityGroupIds - The list of security groups for the VPC associated with this environment.

Returns:

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

storageConfigurations

CreateEnvironmentRequest.Builder storageConfigurations(Collection<StorageConfiguration> storageConfigurations)

Optional. The storage configurations for this environment.

Parameters:

storageConfigurations - Optional. The storage configurations for this environment.

Returns:

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

storageConfigurations

CreateEnvironmentRequest.Builder storageConfigurations(StorageConfiguration... storageConfigurations)

Optional. The storage configurations for this environment.

Parameters:

storageConfigurations - Optional. The storage configurations for this environment.

Returns:

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

storageConfigurations

CreateEnvironmentRequest.Builder storageConfigurations(Consumer<StorageConfiguration.Builder>... storageConfigurations)

Optional. The storage configurations for this environment.

This is a convenience method that creates an instance of the StorageConfiguration.Builder avoiding the need to create one manually via StorageConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #storageConfigurations(List).

Parameters:

storageConfigurations - a consumer that will call methods on StorageConfiguration.Builder

Returns:

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

See Also:

#storageConfigurations(java.util.Collection)

subnetIds

CreateEnvironmentRequest.Builder subnetIds(Collection<String> subnetIds)

The list of subnets associated with the VPC for this environment.

Parameters:

subnetIds - The list of subnets associated with the VPC for this environment.

Returns:

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

subnetIds

CreateEnvironmentRequest.Builder subnetIds(String... subnetIds)

The list of subnets associated with the VPC for this environment.

Parameters:

subnetIds - The list of subnets associated with the VPC for this environment.

Returns:

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

tags

CreateEnvironmentRequest.Builder tags(Map<String,String> tags)

The tags for the environment.

Parameters:

tags - The tags for the environment.

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