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

Interface CreateEnvironmentRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateEnvironmentRequest

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

Method Summary

Modifier and Type	Method	Description
CreateEnvironmentRequest.Builder	dataBundles(String... dataBundles)	The list of Amazon Resource Names (ARN) of the data bundles to install.
CreateEnvironmentRequest.Builder	dataBundles(Collection<String> dataBundles)	The list of Amazon Resource Names (ARN) of the data bundles to install.
CreateEnvironmentRequest.Builder	description(String description)	The description of the FinSpace environment to be created.
CreateEnvironmentRequest.Builder	federationMode(String federationMode)	Authentication mode for the environment.
CreateEnvironmentRequest.Builder	federationMode(FederationMode federationMode)	Authentication mode for the environment.
default CreateEnvironmentRequest.Builder	federationParameters(Consumer<FederationParameters.Builder> federationParameters)	Configuration information when authentication mode is FEDERATED.
CreateEnvironmentRequest.Builder	federationParameters(FederationParameters federationParameters)	Configuration information when authentication mode is FEDERATED.
CreateEnvironmentRequest.Builder	kmsKeyId(String kmsKeyId)	The KMS key id to encrypt your data in the FinSpace environment.
CreateEnvironmentRequest.Builder	name(String name)	The name of the FinSpace environment to be created.
CreateEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateEnvironmentRequest.Builder	superuserParameters(Consumer<SuperuserParameters.Builder> superuserParameters)	Configuration information for the superuser.
CreateEnvironmentRequest.Builder	superuserParameters(SuperuserParameters superuserParameters)	Configuration information for the superuser.
CreateEnvironmentRequest.Builder	tags(Map<String,String> tags)	Add tags to your FinSpace environment.

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

name

CreateEnvironmentRequest.Builder name(String name)

The name of the FinSpace environment to be created.

Parameters:

name - The name of the FinSpace environment to be created.

Returns:

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

description

CreateEnvironmentRequest.Builder description(String description)

The description of the FinSpace environment to be created.

Parameters:

description - The description of the FinSpace environment to be created.

Returns:

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

kmsKeyId

CreateEnvironmentRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key id to encrypt your data in the FinSpace environment.

Parameters:

kmsKeyId - The KMS key id to encrypt your data in the FinSpace environment.

Returns:

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

tags

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

Add tags to your FinSpace environment.

Parameters:

tags - Add tags to your FinSpace environment.

Returns:

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

federationMode

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

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

CreateEnvironmentRequest.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 CreateEnvironmentRequest.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)

superuserParameters

CreateEnvironmentRequest.Builder superuserParameters(SuperuserParameters superuserParameters)

Configuration information for the superuser.

Parameters:

superuserParameters - Configuration information for the superuser.

Returns:

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

superuserParameters

default CreateEnvironmentRequest.Builder superuserParameters(Consumer<SuperuserParameters.Builder> superuserParameters)

Configuration information for the superuser.

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

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

Parameters:

superuserParameters - a consumer that will call methods on SuperuserParameters.Builder

Returns:

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

See Also:

superuserParameters(SuperuserParameters)

dataBundles

CreateEnvironmentRequest.Builder dataBundles(Collection<String> dataBundles)

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Parameters:

dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Returns:

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

dataBundles

CreateEnvironmentRequest.Builder dataBundles(String... dataBundles)

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Parameters:

dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

• arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

• arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

Returns:

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

overrideConfiguration

CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder