software.amazon.awssdk.services.m2.model

Interface GetEnvironmentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetEnvironmentResponse.Builder,GetEnvironmentResponse>, M2Response.Builder, SdkBuilder<GetEnvironmentResponse.Builder,GetEnvironmentResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetEnvironmentResponse

public static interface GetEnvironmentResponse.Builder
extends M2Response.Builder, SdkPojo, CopyableBuilder<GetEnvironmentResponse.Builder,GetEnvironmentResponse>

Method Summary

Modifier and Type	Method and Description
GetEnvironmentResponse.Builder	actualCapacity(Integer actualCapacity) The number of instances included in the runtime environment.
GetEnvironmentResponse.Builder	creationTime(Instant creationTime) The timestamp when the runtime environment was created.
GetEnvironmentResponse.Builder	description(String description) The description of the runtime environment.
GetEnvironmentResponse.Builder	engineType(EngineType engineType) The target platform for the runtime environment.
GetEnvironmentResponse.Builder	engineType(String engineType) The target platform for the runtime environment.
GetEnvironmentResponse.Builder	engineVersion(String engineVersion) The version of the runtime engine.
GetEnvironmentResponse.Builder	environmentArn(String environmentArn) The Amazon Resource Name (ARN) of the runtime environment.
GetEnvironmentResponse.Builder	environmentId(String environmentId) The unique identifier of the runtime environment.
default GetEnvironmentResponse.Builder	highAvailabilityConfig(Consumer<HighAvailabilityConfig.Builder> highAvailabilityConfig) The desired capacity of the high availability configuration for the runtime environment.
GetEnvironmentResponse.Builder	highAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig) The desired capacity of the high availability configuration for the runtime environment.
GetEnvironmentResponse.Builder	instanceType(String instanceType) The type of instance underlying the runtime environment.
GetEnvironmentResponse.Builder	kmsKeyId(String kmsKeyId) The identifier of a customer managed key.
GetEnvironmentResponse.Builder	loadBalancerArn(String loadBalancerArn) The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
GetEnvironmentResponse.Builder	name(String name) The name of the runtime environment.
default GetEnvironmentResponse.Builder	pendingMaintenance(Consumer<PendingMaintenance.Builder> pendingMaintenance) Indicates the pending maintenance scheduled on this environment.
GetEnvironmentResponse.Builder	pendingMaintenance(PendingMaintenance pendingMaintenance) Indicates the pending maintenance scheduled on this environment.
GetEnvironmentResponse.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Configures the maintenance window you want for the runtime environment.
GetEnvironmentResponse.Builder	publiclyAccessible(Boolean publiclyAccessible) Whether applications running in this runtime environment are publicly accessible.
GetEnvironmentResponse.Builder	securityGroupIds(Collection<String> securityGroupIds) The unique identifiers of the security groups assigned to this runtime environment.
GetEnvironmentResponse.Builder	securityGroupIds(String... securityGroupIds) The unique identifiers of the security groups assigned to this runtime environment.
GetEnvironmentResponse.Builder	status(EnvironmentLifecycle status) The status of the runtime environment.
GetEnvironmentResponse.Builder	status(String status) The status of the runtime environment.
GetEnvironmentResponse.Builder	statusReason(String statusReason) The reason for the reported status.
GetEnvironmentResponse.Builder	storageConfigurations(Collection<StorageConfiguration> storageConfigurations) The storage configurations defined for the runtime environment.
GetEnvironmentResponse.Builder	storageConfigurations(Consumer<StorageConfiguration.Builder>... storageConfigurations) The storage configurations defined for the runtime environment.
GetEnvironmentResponse.Builder	storageConfigurations(StorageConfiguration... storageConfigurations) The storage configurations defined for the runtime environment.
GetEnvironmentResponse.Builder	subnetIds(Collection<String> subnetIds) The unique identifiers of the subnets assigned to this runtime environment.
GetEnvironmentResponse.Builder	subnetIds(String... subnetIds) The unique identifiers of the subnets assigned to this runtime environment.
GetEnvironmentResponse.Builder	tags(Map<String,String> tags) The tags defined for this runtime environment.
GetEnvironmentResponse.Builder	vpcId(String vpcId) The unique identifier for the VPC used with this runtime environment.

Methods inherited from interface software.amazon.awssdk.services.m2.model.M2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

actualCapacity

GetEnvironmentResponse.Builder actualCapacity(Integer actualCapacity)

The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

Parameters:

actualCapacity - The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

Returns:

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

creationTime

GetEnvironmentResponse.Builder creationTime(Instant creationTime)

The timestamp when the runtime environment was created.

Parameters:

creationTime - The timestamp when the runtime environment was created.

Returns:

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

description

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

GetEnvironmentResponse.Builder engineType(String engineType)

The target platform for the runtime environment.

Parameters:

engineType - The target platform for the runtime environment.

Returns:

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

See Also:

EngineType, EngineType

engineType

GetEnvironmentResponse.Builder engineType(EngineType engineType)

The target platform for the runtime environment.

Parameters:

engineType - The target platform for the runtime environment.

Returns:

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

See Also:

EngineType, EngineType

engineVersion

GetEnvironmentResponse.Builder engineVersion(String engineVersion)

The version of the runtime engine.

Parameters:

engineVersion - The version of the runtime engine.

Returns:

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

environmentArn

GetEnvironmentResponse.Builder environmentArn(String environmentArn)

The Amazon Resource Name (ARN) of the runtime environment.

Parameters:

environmentArn - The Amazon Resource Name (ARN) of the runtime environment.

Returns:

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

environmentId

GetEnvironmentResponse.Builder environmentId(String environmentId)

The unique identifier of the runtime environment.

Parameters:

environmentId - The unique identifier of the runtime environment.

Returns:

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

highAvailabilityConfig

GetEnvironmentResponse.Builder highAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig)

The desired capacity of the high availability configuration for the runtime environment.

Parameters:

highAvailabilityConfig - The desired capacity of the high availability configuration for the runtime environment.

Returns:

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

highAvailabilityConfig

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

The desired capacity of the high availability configuration for the 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

GetEnvironmentResponse.Builder instanceType(String instanceType)

The type of instance underlying the runtime environment.

Parameters:

instanceType - The type of instance underlying the runtime environment.

Returns:

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

kmsKeyId

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

loadBalancerArn

GetEnvironmentResponse.Builder loadBalancerArn(String loadBalancerArn)

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

Parameters:

loadBalancerArn - The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

Returns:

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

name

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

pendingMaintenance

GetEnvironmentResponse.Builder pendingMaintenance(PendingMaintenance pendingMaintenance)

Indicates the pending maintenance scheduled on this environment.

Parameters:

pendingMaintenance - Indicates the pending maintenance scheduled on this environment.

Returns:

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

pendingMaintenance

default GetEnvironmentResponse.Builder pendingMaintenance(Consumer<PendingMaintenance.Builder> pendingMaintenance)

Indicates the pending maintenance scheduled on this environment.

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

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

Parameters:

pendingMaintenance - a consumer that will call methods on PendingMaintenance.Builder

Returns:

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

See Also:

pendingMaintenance(PendingMaintenance)

preferredMaintenanceWindow

GetEnvironmentResponse.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - Configures the maintenance window you want for the runtime 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

GetEnvironmentResponse.Builder publiclyAccessible(Boolean publiclyAccessible)

Whether applications running in this runtime environment are publicly accessible.

Parameters:

publiclyAccessible - Whether applications running in this runtime environment are publicly accessible.

Returns:

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

securityGroupIds

GetEnvironmentResponse.Builder securityGroupIds(Collection<String> securityGroupIds)

The unique identifiers of the security groups assigned to this runtime environment.

Parameters:

securityGroupIds - The unique identifiers of the security groups assigned to this runtime environment.

Returns:

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

securityGroupIds

GetEnvironmentResponse.Builder securityGroupIds(String... securityGroupIds)

The unique identifiers of the security groups assigned to this runtime environment.

Parameters:

securityGroupIds - The unique identifiers of the security groups assigned to this runtime environment.

Returns:

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

status

GetEnvironmentResponse.Builder status(String status)

The status of the runtime environment.

Parameters:

status - The status of the runtime environment.

Returns:

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

See Also:

EnvironmentLifecycle, EnvironmentLifecycle

status

GetEnvironmentResponse.Builder status(EnvironmentLifecycle status)

The status of the runtime environment.

Parameters:

status - The status of the runtime environment.

Returns:

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

See Also:

EnvironmentLifecycle, EnvironmentLifecycle

statusReason

GetEnvironmentResponse.Builder statusReason(String statusReason)

The reason for the reported status.

Parameters:

statusReason - The reason for the reported status.

Returns:

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

storageConfigurations

GetEnvironmentResponse.Builder storageConfigurations(Collection<StorageConfiguration> storageConfigurations)

The storage configurations defined for the runtime environment.

Parameters:

storageConfigurations - The storage configurations defined for the runtime environment.

Returns:

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

storageConfigurations

GetEnvironmentResponse.Builder storageConfigurations(StorageConfiguration... storageConfigurations)

The storage configurations defined for the runtime environment.

Parameters:

storageConfigurations - The storage configurations defined for the runtime environment.

Returns:

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

storageConfigurations

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

The storage configurations defined for the 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).

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

GetEnvironmentResponse.Builder subnetIds(Collection<String> subnetIds)

The unique identifiers of the subnets assigned to this runtime environment.

Parameters:

subnetIds - The unique identifiers of the subnets assigned to this runtime environment.

Returns:

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

subnetIds

GetEnvironmentResponse.Builder subnetIds(String... subnetIds)

The unique identifiers of the subnets assigned to this runtime environment.

Parameters:

subnetIds - The unique identifiers of the subnets assigned to this runtime environment.

Returns:

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

tags

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

The tags defined for this runtime environment.

Parameters:

tags - The tags defined for this runtime environment.

Returns:

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

vpcId

GetEnvironmentResponse.Builder vpcId(String vpcId)

The unique identifier for the VPC used with this runtime environment.

Parameters:

vpcId - The unique identifier for the VPC used with this runtime environment.

Returns:

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