Class: Aws::DatabaseMigrationService::Types::NeptuneSettings

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

Overview

Note:

When making an API call, you may pass NeptuneSettings data as a hash:

{
  service_access_role_arn: "String",
  s3_bucket_name: "String", # required
  s3_bucket_folder: "String", # required
  error_retry_duration: 1,
  max_file_size: 1,
  max_retry_count: 1,
  iam_auth_enabled: false,
}

Provides information that defines an Amazon Neptune endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_retry_durationInteger

The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.

Returns:

  • (Integer)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#iam_auth_enabledBoolean

If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.

Returns:

  • (Boolean)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#max_file_sizeInteger

The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.

Returns:

  • (Integer)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#max_retry_countInteger

The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.

Returns:

  • (Integer)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_folderString

A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName

Returns:

  • (String)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.

Returns:

  • (String)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arnString

The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User Guide.

Returns:

  • (String)


6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 6095

class NeptuneSettings < Struct.new(
  :service_access_role_arn,
  :s3_bucket_name,
  :s3_bucket_folder,
  :error_retry_duration,
  :max_file_size,
  :max_retry_count,
  :iam_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end