Class: Aws::Finspace::Types::CreateKxDataviewRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_update ⇒ Boolean

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

Returns:

  • (Boolean) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

The identifier of the availability zones.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#az_mode ⇒ String

The number of availability zones you want to assign per volume. Currently, FinSpace only supports ‘SINGLE` for volumes. This places dataview in a single AZ.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#changeset_id ⇒ String

A unique identifier of the changeset that you want to use to ingest data.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that ensures idempotency. This token expires in 10 minutes.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The name of the database where you want to create a dataview.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dataview_name ⇒ String

A unique identifier for the dataview.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the dataview.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

A unique identifier for the kdb environment, where you want to create the dataview.

Returns:

  • (String) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#read_write ⇒ Boolean

The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.



  • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.

  • You cannot perform updates on a writeable dataview. Hence, ‘autoUpdate` must be set as False if `readWrite` is True for a dataview.

  • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.

  • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the ‘readWrite` parameter later.

Returns:

  • (Boolean) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#segment_configurations ⇒ Array<Types::KxDataviewSegmentConfiguration>

The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

Returns:



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

Returns:

  • (Hash<String,String>) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-finspace/types.rb', line 962

class CreateKxDataviewRequest < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :auto_update,
  :read_write,
  :description,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end