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

Interface Environment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Environment.Builder,Environment>, SdkBuilder<Environment.Builder,Environment>, SdkPojo

Enclosing class:

Environment

public static interface Environment.Builder
extends SdkPojo, CopyableBuilder<Environment.Builder,Environment>

Method Summary

Modifier and Type	Method	Description
Environment.Builder	awsAccountId(String awsAccountId)	The ID of the AWS account in which the FinSpace environment is created.
Environment.Builder	dedicatedServiceAccountId(String dedicatedServiceAccountId)	The AWS account ID of the dedicated service account associated with your FinSpace environment.
Environment.Builder	description(String description)	The description of the FinSpace environment.
Environment.Builder	environmentArn(String environmentArn)	The Amazon Resource Name (ARN) of your FinSpace environment.
Environment.Builder	environmentId(String environmentId)	The identifier of the FinSpace environment.
Environment.Builder	environmentUrl(String environmentUrl)	The sign-in URL for the web application of your FinSpace environment.
Environment.Builder	federationMode(String federationMode)	The authentication mode for the environment.
Environment.Builder	federationMode(FederationMode federationMode)	The authentication mode for the environment.
default Environment.Builder	federationParameters(Consumer<FederationParameters.Builder> federationParameters)	Configuration information when authentication mode is FEDERATED.
Environment.Builder	federationParameters(FederationParameters federationParameters)	Configuration information when authentication mode is FEDERATED.
Environment.Builder	kmsKeyId(String kmsKeyId)	The KMS key id used to encrypt in the FinSpace environment.
Environment.Builder	name(String name)	The name of the FinSpace environment.
Environment.Builder	sageMakerStudioDomainUrl(String sageMakerStudioDomainUrl)	The URL of the integrated FinSpace notebook environment in your web application.
Environment.Builder	status(String status)	The current status of creation of the FinSpace environment.
Environment.Builder	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, sdkFieldNameToField, sdkFields

Method Detail

name

Environment.Builder name(String 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

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

awsAccountId

Environment.Builder awsAccountId(String 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

Environment.Builder status(String 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:

EnvironmentStatus, EnvironmentStatus

status

Environment.Builder status(EnvironmentStatus 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:

EnvironmentStatus, EnvironmentStatus

environmentUrl

Environment.Builder environmentUrl(String 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

Environment.Builder description(String 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

Environment.Builder environmentArn(String 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

Environment.Builder sageMakerStudioDomainUrl(String 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

Environment.Builder kmsKeyId(String 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

Environment.Builder dedicatedServiceAccountId(String 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

Environment.Builder federationMode(String 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, FederationMode

federationMode

Environment.Builder federationMode(FederationMode 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, FederationMode

federationParameters

Environment.Builder federationParameters(FederationParameters 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 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)