Package software.amazon.awssdk.services.databasemigration.model

Class NeptuneSettings

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.NeptuneSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NeptuneSettings.Builder,NeptuneSettings>
@Generated("software.amazon.awssdk:codegen") public final class NeptuneSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NeptuneSettings.Builder,NeptuneSettings>

Provides information that defines an Amazon Neptune endpoint.

See Also:

  • Method Details

    • serviceAccessRoleArn

      public final 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.

      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.

    • s3BucketName

      public final 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.

      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.

    • s3BucketFolder

      public final String s3BucketFolder()

      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

    • errorRetryDuration

      public final 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.

      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.

    • maxFileSize

      public final 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.

      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.

    • maxRetryCount

      public final 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.

      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.

    • iamAuthEnabled

      public final 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.

      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.

    • toBuilder

      public NeptuneSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NeptuneSettings.Builder,NeptuneSettings>
      Returns:
      a builder for type T

    • builder

      public static NeptuneSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NeptuneSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.