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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateEnvironmentRequest.BuilderclientToken(String clientToken)Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.CreateEnvironmentRequest.Builderdescription(String description)The description of the runtime environment.CreateEnvironmentRequest.BuilderengineType(String engineType)The engine type for the runtime environment.CreateEnvironmentRequest.BuilderengineType(EngineType engineType)The engine type for the runtime environment.CreateEnvironmentRequest.BuilderengineVersion(String engineVersion)The version of the engine type for the runtime environment.default CreateEnvironmentRequest.BuilderhighAvailabilityConfig(Consumer<HighAvailabilityConfig.Builder> highAvailabilityConfig)The details of a high availability configuration for this runtime environment.CreateEnvironmentRequest.BuilderhighAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig)The details of a high availability configuration for this runtime environment.CreateEnvironmentRequest.BuilderinstanceType(String instanceType)The type of instance for the runtime environment.CreateEnvironmentRequest.BuilderkmsKeyId(String kmsKeyId)The identifier of a customer managed key.CreateEnvironmentRequest.Buildername(String name)The name of the runtime environment.CreateEnvironmentRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateEnvironmentRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateEnvironmentRequest.BuilderpreferredMaintenanceWindow(String preferredMaintenanceWindow)Configures the maintenance window that you want for the runtime environment.CreateEnvironmentRequest.BuilderpubliclyAccessible(Boolean publiclyAccessible)Specifies whether the runtime environment is publicly accessible.CreateEnvironmentRequest.BuildersecurityGroupIds(String... securityGroupIds)The list of security groups for the VPC associated with this runtime environment.CreateEnvironmentRequest.BuildersecurityGroupIds(Collection<String> securityGroupIds)The list of security groups for the VPC associated with this runtime environment.CreateEnvironmentRequest.BuilderstorageConfigurations(Collection<StorageConfiguration> storageConfigurations)Optional.CreateEnvironmentRequest.BuilderstorageConfigurations(Consumer<StorageConfiguration.Builder>... storageConfigurations)Optional.CreateEnvironmentRequest.BuilderstorageConfigurations(StorageConfiguration... storageConfigurations)Optional.CreateEnvironmentRequest.BuildersubnetIds(String... subnetIds)The list of subnets associated with the VPC for this runtime environment.CreateEnvironmentRequest.BuildersubnetIds(Collection<String> subnetIds)The list of subnets associated with the VPC for this runtime environment.CreateEnvironmentRequest.Buildertags(Map<String,String> tags)The tags for the runtime environment.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.m2.model.M2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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 runtime environment.
- Parameters:
description- The description of the runtime 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 runtime environment.
- Parameters:
engineType- The engine type for the runtime 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 runtime environment.
- Parameters:
engineType- The engine type for the runtime 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 runtime environment.
- Parameters:
engineVersion- The version of the engine type for the runtime 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 theHighAvailabilityConfig.Builderavoiding the need to create one manually viaHighAvailabilityConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohighAvailabilityConfig(HighAvailabilityConfig).- Parameters:
highAvailabilityConfig- a consumer that will call methods onHighAvailabilityConfig.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 runtime environment.
- Parameters:
instanceType- The type of instance for the runtime environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
CreateEnvironmentRequest.Builder kmsKeyId(String kmsKeyId)
The identifier of a customer managed key.
- Parameters:
kmsKeyId- The identifier of a customer managed key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
CreateEnvironmentRequest.Builder name(String name)
The name of the runtime environment. Must be unique within the account.
- Parameters:
name- The name of the runtime environment. Must be unique within the account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
CreateEnvironmentRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format
ddd:hh24:mi-ddd:hh24:miand must be less than 24 hours. The following two examples are valid maintenance windows:sun:23:45-mon:00:15orsat:01:00-sat:03:00.If you do not provide a value, a random system-generated value will be assigned.
- Parameters:
preferredMaintenanceWindow- Configures the maintenance window that you want for the runtime environment. The maintenance window must have the formatddd:hh24:mi-ddd:hh24:miand must be less than 24 hours. The following two examples are valid maintenance windows:sun:23:45-mon:00:15orsat:01:00-sat:03:00.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 runtime environment is publicly accessible.
- Parameters:
publiclyAccessible- Specifies whether the runtime 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 runtime environment.
- Parameters:
securityGroupIds- The list of security groups for the VPC associated with this runtime 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 runtime environment.
- Parameters:
securityGroupIds- The list of security groups for the VPC associated with this runtime 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 runtime environment.
- Parameters:
storageConfigurations- Optional. The storage configurations for this runtime 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 runtime environment.
- Parameters:
storageConfigurations- Optional. The storage configurations for this runtime 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 runtime environment.
This is a convenience method that creates an instance of theStorageConfiguration.Builderavoiding the need to create one manually viaStorageConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#storageConfigurations(List.) - Parameters:
storageConfigurations- a consumer that will call methods onStorageConfiguration.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 runtime environment.
- Parameters:
subnetIds- The list of subnets associated with the VPC for this runtime 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 runtime environment.
- Parameters:
subnetIds- The list of subnets associated with the VPC for this runtime 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 runtime environment.
- Parameters:
tags- The tags for the runtime environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-