Class: Aws::Finspace::Types::CreateEnvironmentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_bundles ⇒ Array<String>

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:

  • (Array<String>) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the FinSpace environment to be created.

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#federation_mode ⇒ String

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:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#federation_parameters ⇒ Types::FederationParameters

Configuration information when authentication mode is FEDERATED.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the FinSpace environment to be created.

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#superuser_parameters ⇒ Types::SuperuserParameters

Configuration information for the superuser.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Add tags to your FinSpace environment.

Returns:

  • (Hash<String,String>) 


248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 248

class CreateEnvironmentRequest < Struct.new(
  :name,
  :description,
  :kms_key_id,
  :tags,
  :federation_mode,
  :federation_parameters,
  :superuser_parameters,
  :data_bundles)
  SENSITIVE = []
  include Aws::Structure
end