Interface CreateEnvironmentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEnvironmentRequest.Builder,
,CreateEnvironmentRequest> FinspaceRequest.Builder
,SdkBuilder<CreateEnvironmentRequest.Builder,
,CreateEnvironmentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEnvironmentRequest
-
Method Summary
Modifier and TypeMethodDescriptiondataBundles
(String... dataBundles) The list of Amazon Resource Names (ARN) of the data bundles to install.dataBundles
(Collection<String> dataBundles) The list of Amazon Resource Names (ARN) of the data bundles to install.description
(String description) The description of the FinSpace environment to be created.federationMode
(String federationMode) Authentication mode for the environment.federationMode
(FederationMode federationMode) Authentication mode for the environment.default CreateEnvironmentRequest.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 to encrypt your data in the FinSpace environment.The name of the FinSpace environment to be created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateEnvironmentRequest.Builder
superuserParameters
(Consumer<SuperuserParameters.Builder> superuserParameters) Configuration information for the superuser.superuserParameters
(SuperuserParameters superuserParameters) Configuration information for the superuser.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, sdkFields
-
Method Details
-
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
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
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
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
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
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 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:
-
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 theSuperuserParameters.Builder
avoiding the need to create one manually viaSuperuserParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosuperuserParameters(SuperuserParameters)
.- Parameters:
superuserParameters
- a consumer that will call methods onSuperuserParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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) 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
CreateEnvironmentRequest.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.
-