NeptuneSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.NeptuneSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NeptuneSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines an Amazon Neptune endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NeptuneSettings()

Constructors
Constructor and Description
`NeptuneSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NeptuneSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getErrorRetryDuration()` 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.
`Boolean`	`getIamAuthEnabled()` If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true`.
`Integer`	`getMaxFileSize()` 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.
`Integer`	`getMaxRetryCount()` The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
`String`	`getS3BucketFolder()` A folder path where you want DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`
`String`	`getS3BucketName()` 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.
`String`	`getServiceAccessRoleArn()` The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.
`int`	`hashCode()`
`Boolean`	`isIamAuthEnabled()` If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setErrorRetryDuration(Integer errorRetryDuration)` 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.
`void`	`setIamAuthEnabled(Boolean iamAuthEnabled)` If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true`.
`void`	`setMaxFileSize(Integer maxFileSize)` 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.
`void`	`setMaxRetryCount(Integer maxRetryCount)` The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
`void`	`setS3BucketFolder(String s3BucketFolder)` A folder path where you want DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`
`void`	`setS3BucketName(String s3BucketName)` 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.
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.
`String`	`toString()` Returns a string representation of this object.
`NeptuneSettings`	`withErrorRetryDuration(Integer errorRetryDuration)` 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.
`NeptuneSettings`	`withIamAuthEnabled(Boolean iamAuthEnabled)` If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true`.
`NeptuneSettings`	`withMaxFileSize(Integer maxFileSize)` 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.
`NeptuneSettings`	`withMaxRetryCount(Integer maxRetryCount)` The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.
`NeptuneSettings`	`withS3BucketFolder(String s3BucketFolder)` A folder path where you want DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`
`NeptuneSettings`	`withS3BucketName(String s3BucketName)` 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.
`NeptuneSettings`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NeptuneSettings
```
public NeptuneSettings()
```
- Method Detail
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    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.
    
    Parameters:
    
    serviceAccessRoleArn - 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.
  - getServiceAccessRoleArn
```
public 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 Database Migration Service User Guide.
    
    Returns:
    
    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.
  - withServiceAccessRoleArn
```
public NeptuneSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    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.
    
    Parameters:
    
    serviceAccessRoleArn - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BucketName
```
public void setS3BucketName(String s3BucketName)
```
    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.
    
    Parameters:
    
    s3BucketName - 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.
  - getS3BucketName
```
public String getS3BucketName()
```
    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:
    
    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.
  - withS3BucketName
```
public NeptuneSettings withS3BucketName(String s3BucketName)
```
    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.
    
    Parameters:
    
    s3BucketName - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BucketFolder
```
public void setS3BucketFolder(String s3BucketFolder)
```
    A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    
    Parameters:
    
    s3BucketFolder - A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
  - getS3BucketFolder
```
public String getS3BucketFolder()
```
    A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    
    Returns:
    
    A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
  - withS3BucketFolder
```
public NeptuneSettings withS3BucketFolder(String s3BucketFolder)
```
    A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    
    Parameters:
    
    s3BucketFolder - A folder path where you want DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorRetryDuration
```
public void setErrorRetryDuration(Integer errorRetryDuration)
```
    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.
    
    Parameters:
    
    errorRetryDuration - 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.
  - getErrorRetryDuration
```
public Integer getErrorRetryDuration()
```
    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:
    
    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.
  - withErrorRetryDuration
```
public NeptuneSettings withErrorRetryDuration(Integer errorRetryDuration)
```
    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.
    
    Parameters:
    
    errorRetryDuration - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxFileSize
```
public void setMaxFileSize(Integer maxFileSize)
```
    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.
    
    Parameters:
    
    maxFileSize - 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.
  - getMaxFileSize
```
public Integer getMaxFileSize()
```
    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:
    
    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.
  - withMaxFileSize
```
public NeptuneSettings withMaxFileSize(Integer maxFileSize)
```
    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.
    
    Parameters:
    
    maxFileSize - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetryCount
```
public void setMaxRetryCount(Integer maxRetryCount)
```
    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.
    
    Parameters:
    
    maxRetryCount - 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.
  - getMaxRetryCount
```
public Integer getMaxRetryCount()
```
    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:
    
    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.
  - withMaxRetryCount
```
public NeptuneSettings withMaxRetryCount(Integer maxRetryCount)
```
    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.
    
    Parameters:
    
    maxRetryCount - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamAuthEnabled
```
public void setIamAuthEnabled(Boolean iamAuthEnabled)
```
    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.
    
    Parameters:
    
    iamAuthEnabled - 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.
  - getIamAuthEnabled
```
public Boolean getIamAuthEnabled()
```
    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:
    
    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.
  - withIamAuthEnabled
```
public NeptuneSettings withIamAuthEnabled(Boolean iamAuthEnabled)
```
    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.
    
    Parameters:
    
    iamAuthEnabled - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIamAuthEnabled
```
public Boolean isIamAuthEnabled()
```
    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:
    
    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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NeptuneSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class NeptuneSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NeptuneSettings

Method Detail

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setS3BucketName

getS3BucketName

withS3BucketName

setS3BucketFolder

getS3BucketFolder

withS3BucketFolder

setErrorRetryDuration

getErrorRetryDuration

withErrorRetryDuration

setMaxFileSize

getMaxFileSize

withMaxFileSize

setMaxRetryCount

getMaxRetryCount

withMaxRetryCount

setIamAuthEnabled

getIamAuthEnabled

withIamAuthEnabled

isIamAuthEnabled

toString

equals

hashCode

clone

marshall