2.185.0

interface NeptuneSettingsProperty

LanguageType name
.NETAmazon.CDK.AWS.DMS.CfnEndpoint.NeptuneSettingsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpoint_NeptuneSettingsProperty
Javasoftware.amazon.awscdk.services.dms.CfnEndpoint.NeptuneSettingsProperty
Pythonaws_cdk.aws_dms.CfnEndpoint.NeptuneSettingsProperty
TypeScript aws-cdk-lib » aws_dms » CfnEndpoint » NeptuneSettingsProperty

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const neptuneSettingsProperty: dms.CfnEndpoint.NeptuneSettingsProperty = {
  errorRetryDuration: 123,
  iamAuthEnabled: false,
  maxFileSize: 123,
  maxRetryCount: 123,
  s3BucketFolder: 's3BucketFolder',
  s3BucketName: 's3BucketName',
  serviceAccessRoleArn: 'serviceAccessRoleArn',
};

Properties

NameTypeDescription
errorRetryDuration?numberThe 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.
iamAuthEnabled?boolean | IResolvableIf you want IAM authorization enabled for this endpoint, set this parameter to true .
maxFileSize?numberThe 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.
maxRetryCount?numberThe number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
s3BucketFolder?stringA folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName.
s3BucketName?stringThe 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.
serviceAccessRoleArn?stringThe Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.

errorRetryDuration?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-errorretryduration

iamAuthEnabled?

Type: boolean | IResolvable (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-iamauthenabled

maxFileSize?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxfilesize

maxRetryCount?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxretrycount

s3BucketFolder?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketfolder

s3BucketName?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketname

serviceAccessRoleArn?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn

← PreviousNext →