Interface UpdateEnvironmentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateEnvironmentRequest.Builder,
,UpdateEnvironmentRequest> FinspaceRequest.Builder
,SdkBuilder<UpdateEnvironmentRequest.Builder,
,UpdateEnvironmentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateEnvironmentRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) The description of the environment.environmentId
(String environmentId) The identifier of the FinSpace environment.federationMode
(String federationMode) Authentication mode for the environment.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.federationParameters
(FederationParameters federationParameters) Sets the value of the FederationParameters property for this object.The name of the environment.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFields
-
Method Details
-
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
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
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
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
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:
-
-
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 theFederationParameters.Builder
avoiding the need to create one manually viaFederationParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofederationParameters(FederationParameters)
.- Parameters:
federationParameters
- a consumer that will call methods onFederationParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-