Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.NeptuneSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.NeptuneSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.NeptuneSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 NeptuneSettingsProperty neptuneSettingsProperty = NeptuneSettingsProperty.builder()
         .errorRetryDuration(123)
         .iamAuthEnabled(false)
         .maxFileSize(123)
         .maxRetryCount(123)
         .s3BucketFolder("s3BucketFolder")
         .s3BucketName("s3BucketName")
         .serviceAccessRoleArn("serviceAccessRoleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.NeptuneSettingsProperty.Builder	A builder for CfnEndpoint.NeptuneSettingsProperty
static final class	CfnEndpoint.NeptuneSettingsProperty.Jsii$Proxy	An implementation for CfnEndpoint.NeptuneSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.NeptuneSettingsProperty.Builder	builder()
default Number	getErrorRetryDuration()	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.
default Object	getIamAuthEnabled()	If you want IAM authorization enabled for this endpoint, set this parameter to true .
default Number	getMaxFileSize()	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.
default Number	getMaxRetryCount()	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.
default String	getS3BucketFolder()	A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName.
default String	getS3BucketName()	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.
default String	getServiceAccessRoleArn()	The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getErrorRetryDuration

@Stability(Stable)
@Nullable
default Number getErrorRetryDuration()

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

getIamAuthEnabled

@Stability(Stable)
@Nullable
default Object getIamAuthEnabled()

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

getMaxFileSize

@Stability(Stable)
@Nullable
default Number getMaxFileSize()

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

getMaxRetryCount

@Stability(Stable)
@Nullable
default Number getMaxRetryCount()

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

getS3BucketFolder

@Stability(Stable)
@Nullable
default String getS3BucketFolder()

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

getS3BucketName

@Stability(Stable)
@Nullable
default String getS3BucketName()

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

getServiceAccessRoleArn

@Stability(Stable)
@Nullable
default String getServiceAccessRoleArn()

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

builder

@Stability(Stable)
static CfnEndpoint.NeptuneSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.NeptuneSettingsProperty.Builder of CfnEndpoint.NeptuneSettingsProperty