Class: AWSCDK::DMS::CfnEndpoint::NeptuneSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dms/cfn_endpoint.rb

Overview

Provides information that defines an Amazon Neptune endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_retry_duration: nil, iam_auth_enabled: nil, max_file_size: nil, max_retry_count: nil, s3_bucket_folder: nil, s3_bucket_name: nil, service_access_role_arn: nil) ⇒ NeptuneSettingsProperty

Returns a new instance of NeptuneSettingsProperty.

Parameters:

  • error_retry_duration (Numeric, nil) (defaults to: nil) —

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

  • iam_auth_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If you want IAM authorization enabled for this endpoint, set this parameter to true .

  • max_file_size (Numeric, nil) (defaults to: nil) —

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

  • max_retry_count (Numeric, nil) (defaults to: nil) —

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

  • s3_bucket_folder (String, nil) (defaults to: nil) —

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

  • s3_bucket_name (String, nil) (defaults to: nil) —

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

  • service_access_role_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'dms/cfn_endpoint.rb', line 2371

def initialize(error_retry_duration: nil, iam_auth_enabled: nil, max_file_size: nil, max_retry_count: nil, s3_bucket_folder: nil, s3_bucket_name: nil, service_access_role_arn: nil)
  @error_retry_duration = error_retry_duration
  Jsii::Type.check_type(@error_retry_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "errorRetryDuration") unless @error_retry_duration.nil?
  @iam_auth_enabled = iam_auth_enabled
  Jsii::Type.check_type(@iam_auth_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "iamAuthEnabled") unless @iam_auth_enabled.nil?
  @max_file_size = max_file_size
  Jsii::Type.check_type(@max_file_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxFileSize") unless @max_file_size.nil?
  @max_retry_count = max_retry_count
  Jsii::Type.check_type(@max_retry_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRetryCount") unless @max_retry_count.nil?
  @s3_bucket_folder = s3_bucket_folder
  Jsii::Type.check_type(@s3_bucket_folder, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketFolder") unless @s3_bucket_folder.nil?
  @s3_bucket_name = s3_bucket_name
  Jsii::Type.check_type(@s3_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName") unless @s3_bucket_name.nil?
  @service_access_role_arn = service_access_role_arn
  Jsii::Type.check_type(@service_access_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceAccessRoleArn") unless @service_access_role_arn.nil?
end

Instance Attribute Details

#error_retry_duration ⇒ Numeric? (readonly)

The number of milliseconds for AWS 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:

  • (Numeric, nil)

See Also:



2394
2395
2396
 
# File 'dms/cfn_endpoint.rb', line 2394

def error_retry_duration
  @error_retry_duration
end

#iam_auth_enabled ⇒ Boolean, ... (readonly)

If you want 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:

See Also:



2401
2402
2403
 
# File 'dms/cfn_endpoint.rb', line 2401

def iam_auth_enabled
  @iam_auth_enabled
end

#max_file_size ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



2406
2407
2408
 
# File 'dms/cfn_endpoint.rb', line 2406

def max_file_size
  @max_file_size
end

#max_retry_count ⇒ Numeric? (readonly)

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

The default is 5.

Returns:

  • (Numeric, nil)

See Also:



2413
2414
2415
 
# File 'dms/cfn_endpoint.rb', line 2413

def max_retry_count
  @max_retry_count
end

#s3_bucket_folder ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2418
2419
2420
 
# File 'dms/cfn_endpoint.rb', line 2418

def s3_bucket_folder
  @s3_bucket_folder
end

#s3_bucket_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2423
2424
2425
 
# File 'dms/cfn_endpoint.rb', line 2423

def s3_bucket_name
  @s3_bucket_name
end

#service_access_role_arn ⇒ String? (readonly)

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 AWS Database Migration Service User Guide .

Returns:

  • (String, nil)

See Also:



2432
2433
2434
 
# File 'dms/cfn_endpoint.rb', line 2432

def service_access_role_arn
  @service_access_role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
 
# File 'dms/cfn_endpoint.rb', line 2434

def self.jsii_properties
  {
    :error_retry_duration => "errorRetryDuration",
    :iam_auth_enabled => "iamAuthEnabled",
    :max_file_size => "maxFileSize",
    :max_retry_count => "maxRetryCount",
    :s3_bucket_folder => "s3BucketFolder",
    :s3_bucket_name => "s3BucketName",
    :service_access_role_arn => "serviceAccessRoleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
 
# File 'dms/cfn_endpoint.rb', line 2446

def to_jsii
  result = {}
  result.merge!({
    "errorRetryDuration" => @error_retry_duration,
    "iamAuthEnabled" => @iam_auth_enabled,
    "maxFileSize" => @max_file_size,
    "maxRetryCount" => @max_retry_count,
    "s3BucketFolder" => @s3_bucket_folder,
    "s3BucketName" => @s3_bucket_name,
    "serviceAccessRoleArn" => @service_access_role_arn,
  })
  result.compact
end