Package 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 Details

    • 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

      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:

    • 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 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:

    • 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:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat: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 format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat: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 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<StorageConfiguration>).

      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:

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.