|
| 1 | +# AWS::DMS::Endpoint NeptuneSettings<a name="aws-properties-dms-endpoint-neptunesettings"></a> |
| 2 | + |
| 3 | +Provides information that describes an Amazon Neptune endpoint\. This includes service access credentials and information that AWS DMS needs to access and bulk\-load the Neptune database\. |
| 4 | + |
| 5 | +## Syntax<a name="aws-properties-dms-endpoint-neptunesettings-syntax"></a> |
| 6 | + |
| 7 | +To declare this entity in your AWS CloudFormation template, use the following syntax: |
| 8 | + |
| 9 | +### JSON<a name="aws-properties-dms-endpoint-neptunesettings-syntax.json"></a> |
| 10 | + |
| 11 | +``` |
| 12 | +{ |
| 13 | + "[ErrorRetryDuration](#cfn-dms-endpoint-neptunesettings-errorretryduration)" : Integer, |
| 14 | + "[IamAuthEnabled](#cfn-dms-endpoint-neptunesettings-iamauthenabled)" : Boolean, |
| 15 | + "[MaxFileSize](#cfn-dms-endpoint-neptunesettings-maxfilesize)" : Integer, |
| 16 | + "[MaxRetryCount](#cfn-dms-endpoint-neptunesettings-maxretrycount)" : Integer, |
| 17 | + "[S3BucketFolder](#cfn-dms-endpoint-neptunesettings-s3bucketfolder)" : String, |
| 18 | + "[S3BucketName](#cfn-dms-endpoint-neptunesettings-s3bucketname)" : String, |
| 19 | + "[ServiceAccessRoleArn](#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn)" : String |
| 20 | +} |
| 21 | +``` |
| 22 | + |
| 23 | +### YAML<a name="aws-properties-dms-endpoint-neptunesettings-syntax.yaml"></a> |
| 24 | + |
| 25 | +``` |
| 26 | + [ErrorRetryDuration](#cfn-dms-endpoint-neptunesettings-errorretryduration): Integer |
| 27 | + [IamAuthEnabled](#cfn-dms-endpoint-neptunesettings-iamauthenabled): Boolean |
| 28 | + [MaxFileSize](#cfn-dms-endpoint-neptunesettings-maxfilesize): Integer |
| 29 | + [MaxRetryCount](#cfn-dms-endpoint-neptunesettings-maxretrycount): Integer |
| 30 | + [S3BucketFolder](#cfn-dms-endpoint-neptunesettings-s3bucketfolder): String |
| 31 | + [S3BucketName](#cfn-dms-endpoint-neptunesettings-s3bucketname): String |
| 32 | + [ServiceAccessRoleArn](#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn): String |
| 33 | +``` |
| 34 | + |
| 35 | +## Properties<a name="aws-properties-dms-endpoint-neptunesettings-properties"></a> |
| 36 | + |
| 37 | +`ErrorRetryDuration` <a name="cfn-dms-endpoint-neptunesettings-errorretryduration"></a> |
| 38 | +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\. |
| 39 | +*Required*: No |
| 40 | +*Type*: Integer |
| 41 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 42 | + |
| 43 | +`IamAuthEnabled` <a name="cfn-dms-endpoint-neptunesettings-iamauthenabled"></a> |
| 44 | +If you want AWS 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`\. |
| 45 | +*Required*: No |
| 46 | +*Type*: Boolean |
| 47 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 48 | + |
| 49 | +`MaxFileSize` <a name="cfn-dms-endpoint-neptunesettings-maxfilesize"></a> |
| 50 | +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\. |
| 51 | +*Required*: No |
| 52 | +*Type*: Integer |
| 53 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 54 | + |
| 55 | +`MaxRetryCount` <a name="cfn-dms-endpoint-neptunesettings-maxretrycount"></a> |
| 56 | +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\. |
| 57 | +*Required*: No |
| 58 | +*Type*: Integer |
| 59 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 60 | + |
| 61 | +`S3BucketFolder` <a name="cfn-dms-endpoint-neptunesettings-s3bucketfolder"></a> |
| 62 | +A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by `S3BucketName` |
| 63 | +*Required*: No |
| 64 | +*Type*: String |
| 65 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 66 | + |
| 67 | +`S3BucketName` <a name="cfn-dms-endpoint-neptunesettings-s3bucketname"></a> |
| 68 | +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\. |
| 69 | +*Required*: No |
| 70 | +*Type*: String |
| 71 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 72 | + |
| 73 | +`ServiceAccessRoleArn` <a name="cfn-dms-endpoint-neptunesettings-serviceaccessrolearn"></a> |
| 74 | +The Amazon Resource Name \(ARN\) of the service role that you created for the Neptune target endpoint\. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide\. * |
| 75 | +*Required*: No |
| 76 | +*Type*: String |
| 77 | +*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
0 commit comments