Interface Environment.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Environment.Builder,
,Environment> SdkBuilder<Environment.Builder,
,Environment> SdkPojo
- Enclosing class:
Environment
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) The ID of the AWS account in which the FinSpace environment is created.dedicatedServiceAccountId
(String dedicatedServiceAccountId) The AWS account ID of the dedicated service account associated with your FinSpace environment.description
(String description) The description of the FinSpace environment.environmentArn
(String environmentArn) The Amazon Resource Name (ARN) of your FinSpace environment.environmentId
(String environmentId) The identifier of the FinSpace environment.environmentUrl
(String environmentUrl) The sign-in URL for the web application of your FinSpace environment.federationMode
(String federationMode) The authentication mode for the environment.federationMode
(FederationMode federationMode) The authentication mode for the environment.default Environment.Builder
federationParameters
(Consumer<FederationParameters.Builder> federationParameters) Configuration information when authentication mode is FEDERATED.federationParameters
(FederationParameters federationParameters) Configuration information when authentication mode is FEDERATED.The KMS key id used to encrypt in the FinSpace environment.The name of the FinSpace environment.sageMakerStudioDomainUrl
(String sageMakerStudioDomainUrl) The URL of the integrated FinSpace notebook environment in your web application.The current status of creation of the FinSpace environment.status
(EnvironmentStatus status) The current status of creation of the FinSpace environment.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
name
The name of the FinSpace environment.
- Parameters:
name
- The name of the FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
awsAccountId
The ID of the AWS account in which the FinSpace environment is created.
- Parameters:
awsAccountId
- The ID of the AWS account in which the FinSpace environment is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The current status of creation of the FinSpace environment.
- Parameters:
status
- The current status of creation of the FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of creation of the FinSpace environment.
- Parameters:
status
- The current status of creation of the FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentUrl
The sign-in URL for the web application of your FinSpace environment.
- Parameters:
environmentUrl
- The sign-in URL for the web application of your FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the FinSpace environment.
- Parameters:
description
- The description of the FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentArn
The Amazon Resource Name (ARN) of your FinSpace environment.
- Parameters:
environmentArn
- The Amazon Resource Name (ARN) of your FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sageMakerStudioDomainUrl
The URL of the integrated FinSpace notebook environment in your web application.
- Parameters:
sageMakerStudioDomainUrl
- The URL of the integrated FinSpace notebook environment in your web application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The KMS key id used to encrypt in the FinSpace environment.
- Parameters:
kmsKeyId
- The KMS key id used to encrypt in the FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dedicatedServiceAccountId
The AWS account ID of the dedicated service account associated with your FinSpace environment.
- Parameters:
dedicatedServiceAccountId
- The AWS account ID of the dedicated service account associated with your FinSpace environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
federationMode
The authentication mode for the environment.
- Parameters:
federationMode
- The authentication mode for the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
federationMode
The authentication mode for the environment.
- Parameters:
federationMode
- The authentication mode for the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
federationParameters
Configuration information when authentication mode is FEDERATED.
- Parameters:
federationParameters
- Configuration information when authentication mode is FEDERATED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
federationParameters
default Environment.Builder federationParameters(Consumer<FederationParameters.Builder> federationParameters) Configuration information when authentication mode is FEDERATED.
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:
-