Class: Aws::NeptuneGraph::Types::CreateGraphUsingImportTaskInput

Inherits:

Struct

Object
Struct
Aws::NeptuneGraph::Types::CreateGraphUsingImportTaskInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-neptunegraph/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#blank_node_handling ⇒ String

The method to handle blank nodes in the dataset.
#deletion_protection ⇒ Boolean

Indicates whether or not to enable deletion protection on the graph.
#fail_on_error ⇒ Boolean

If set to ‘true`, the task halts when an import error is encountered.
#format ⇒ String

Specifies the format of S3 data to be imported.
#graph_name ⇒ String

A name for the new Neptune Analytics graph to be created.
#import_options ⇒ Types::ImportOptions

Contains options for controlling the import process.
#kms_key_identifier ⇒ String

Specifies a KMS key to use to encrypt data imported into the new graph.
#max_provisioned_memory ⇒ Integer

The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
#min_provisioned_memory ⇒ Integer

The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
#parquet_type ⇒ String

The parquet type of the import task.
#public_connectivity ⇒ Boolean

Specifies whether or not the graph can be reachable over the internet.
#replica_count ⇒ Integer

The number of replicas in other AZs to provision on the new graph after import.
#role_arn ⇒ String

The ARN of the IAM role that will allow access to the data that is to be imported.
#source ⇒ String

A URL identifying to the location of the data to be imported.
#tags ⇒ Hash<String,String>

Adds metadata tags to the new graph.
#vector_search_configuration ⇒ Types::VectorSearchConfiguration

Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

Instance Attribute Details

#blank_node_handling ⇒ `String`

The method to handle blank nodes in the dataset. Currently, only ‘convertToIri` is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is `ntriples`. For more information, see [Handling RDF values].

[1]: docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (‘true` or `false`).

Returns:

(Boolean)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#fail_on_error ⇒ `Boolean`

If set to ‘true`, the task halts when an import error is encountered. If set to `false`, the task skips the data that caused the error and continues if possible.

Returns:

(Boolean)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ `String`

Specifies the format of S3 data to be imported. Valid values are ‘CSV`, which identifies the [Gremlin CSV format], `OPEN_CYPHER`, which identifies the [openCypher load format], or `ntriples`, which identifies the [RDF n-triples] format.

[1]: docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html [2]: docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html [3]: docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#graph_name ⇒ `String`

A name for the new Neptune Analytics graph to be created.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#import_options ⇒ `Types::ImportOptions`

Contains options for controlling the import process. For example, if the ‘failOnError` key is set to `false`, the import skips problem data and attempts to continue (whereas if set to `true`, the default, or if omitted, the import operation halts immediately when an error is encountered.

Returns:

(Types::ImportOptions)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ `String`

Specifies a KMS key to use to encrypt data imported into the new graph.

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#max_provisioned_memory ⇒ `Integer`

The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.

If both the minimum and maximum values are specified, the final ‘provisioned-memory` will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.

Returns:

(Integer)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#min_provisioned_memory ⇒ `Integer`

The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 16

Returns:

(Integer)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#parquet_type ⇒ `String`

The parquet type of the import task.

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#public_connectivity ⇒ `Boolean`

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (‘true` to enable, or `false` to disable).

Returns:

(Boolean)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#replica_count ⇒ `Integer`

The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

Returns:

(Integer)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The ARN of the IAM role that will allow access to the data that is to be imported.

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `String`

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

Returns:

(String)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vector_search_configuration ⇒ `Types::VectorSearchConfiguration`

Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as ‘dimension=`value. Max = 65,535

Returns:

(Types::VectorSearchConfiguration)

# File 'lib/aws-sdk-neptunegraph/types.rb', line 544

class CreateGraphUsingImportTaskInput < Struct.new(
  :graph_name,
  :tags,
  :public_connectivity,
  :kms_key_identifier,
  :vector_search_configuration,
  :replica_count,
  :deletion_protection,
  :import_options,
  :max_provisioned_memory,
  :min_provisioned_memory,
  :fail_on_error,
  :source,
  :format,
  :parquet_type,
  :blank_node_handling,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::NeptuneGraph::Types::CreateGraphUsingImportTaskInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#blank_node_handling ⇒ String

#deletion_protection ⇒ Boolean

#fail_on_error ⇒ Boolean

#format ⇒ String

#graph_name ⇒ String

#import_options ⇒ Types::ImportOptions

#kms_key_identifier ⇒ String

#max_provisioned_memory ⇒ Integer

#min_provisioned_memory ⇒ Integer

#parquet_type ⇒ String

#public_connectivity ⇒ Boolean

#replica_count ⇒ Integer

#role_arn ⇒ String

#source ⇒ String

#tags ⇒ Hash<String,String>

#vector_search_configuration ⇒ Types::VectorSearchConfiguration

#blank_node_handling ⇒ `String`

#deletion_protection ⇒ `Boolean`

#fail_on_error ⇒ `Boolean`

#format ⇒ `String`

#graph_name ⇒ `String`

#import_options ⇒ `Types::ImportOptions`

#kms_key_identifier ⇒ `String`

#max_provisioned_memory ⇒ `Integer`

#min_provisioned_memory ⇒ `Integer`

#parquet_type ⇒ `String`

#public_connectivity ⇒ `Boolean`

#replica_count ⇒ `Integer`

#role_arn ⇒ `String`

#source ⇒ `String`

#tags ⇒ `Hash<String,String>`

#vector_search_configuration ⇒ `Types::VectorSearchConfiguration`