Package software.amazon.awssdk.services.finspace.model

Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, FinspaceRequest.Builder, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateEnvironmentRequest

public static interface UpdateEnvironmentRequest.Builder
extends FinspaceRequest.Builder, SdkPojo, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Method Summary

Modifier and Type	Method	Description
UpdateEnvironmentRequest.Builder	description(String description)	The description of the environment.
UpdateEnvironmentRequest.Builder	environmentId(String environmentId)	The identifier of the FinSpace environment.
UpdateEnvironmentRequest.Builder	federationMode(String federationMode)	Authentication mode for the environment.
UpdateEnvironmentRequest.Builder	federationMode(FederationMode federationMode)	Authentication mode for the environment.
default UpdateEnvironmentRequest.Builder	federationParameters(Consumer<FederationParameters.Builder> federationParameters)	Sets the value of the FederationParameters property for this object.
UpdateEnvironmentRequest.Builder	federationParameters(FederationParameters federationParameters)	Sets the value of the FederationParameters property for this object.
UpdateEnvironmentRequest.Builder	name(String name)	The name of the environment.
UpdateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

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.finspace.model.FinspaceRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

environmentId

UpdateEnvironmentRequest.Builder environmentId(String environmentId)

The identifier of the FinSpace environment.

Parameters:

environmentId - The identifier of the FinSpace environment.

Returns:

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

name

UpdateEnvironmentRequest.Builder name(String name)

The name of the environment.

Parameters:

name - The name of the environment.

Returns:

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

description

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

federationMode

UpdateEnvironmentRequest.Builder federationMode(String federationMode)

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Parameters:

federationMode - Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Returns:

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

See Also:

FederationMode, FederationMode

federationMode

UpdateEnvironmentRequest.Builder federationMode(FederationMode federationMode)

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Parameters:

federationMode - Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Returns:

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

See Also:

FederationMode, FederationMode

federationParameters

UpdateEnvironmentRequest.Builder federationParameters(FederationParameters federationParameters)

Sets the value of the FederationParameters property for this object.

Parameters:

federationParameters - The new value for the FederationParameters property for this object.

Returns:

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

federationParameters

default UpdateEnvironmentRequest.Builder federationParameters(Consumer<FederationParameters.Builder> federationParameters)

Sets the value of the FederationParameters property for this object. This is a convenience method that creates an instance of the FederationParameters.Builder avoiding the need to create one manually via FederationParameters.builder().

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

Parameters:

federationParameters - a consumer that will call methods on FederationParameters.Builder

Returns:

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

See Also:

federationParameters(FederationParameters)

overrideConfiguration

UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder