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

Interface ReplicationInstance.Builder

    • Method Detail

      • replicationInstanceIdentifier

        ReplicationInstance.Builder replicationInstanceIdentifier​(String replicationInstanceIdentifier)

        The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain 1-63 alphanumeric characters or hyphens.

        • First character must be a letter.

        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

        Parameters:
        replicationInstanceIdentifier - The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain 1-63 alphanumeric characters or hyphens.

        • First character must be a letter.

        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: myrepinstance

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstanceClass

        ReplicationInstance.Builder replicationInstanceClass​(String replicationInstanceClass)

        The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

        For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

        Parameters:
        replicationInstanceClass - The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

        For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstanceStatus

        ReplicationInstance.Builder replicationInstanceStatus​(String replicationInstanceStatus)

        The status of the replication instance. The possible return values include:

        • "available"

        • "creating"

        • "deleted"

        • "deleting"

        • "failed"

        • "modifying"

        • "upgrading"

        • "rebooting"

        • "resetting-master-credentials"

        • "storage-full"

        • "incompatible-credentials"

        • "incompatible-network"

        • "maintenance"

        Parameters:
        replicationInstanceStatus - The status of the replication instance. The possible return values include:

        • "available"

        • "creating"

        • "deleted"

        • "deleting"

        • "failed"

        • "modifying"

        • "upgrading"

        • "rebooting"

        • "resetting-master-credentials"

        • "storage-full"

        • "incompatible-credentials"

        • "incompatible-network"

        • "maintenance"

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        ReplicationInstance.Builder allocatedStorage​(Integer allocatedStorage)

        The amount of storage (in gigabytes) that is allocated for the replication instance.

        Parameters:
        allocatedStorage - The amount of storage (in gigabytes) that is allocated for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceCreateTime

        ReplicationInstance.Builder instanceCreateTime​(Instant instanceCreateTime)

        The time the replication instance was created.

        Parameters:
        instanceCreateTime - The time the replication instance was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

        ReplicationInstance.Builder vpcSecurityGroups​(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

        The VPC security group for the instance.

        Parameters:
        vpcSecurityGroups - The VPC security group for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

        ReplicationInstance.Builder vpcSecurityGroups​(VpcSecurityGroupMembership... vpcSecurityGroups)

        The VPC security group for the instance.

        Parameters:
        vpcSecurityGroups - The VPC security group for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        ReplicationInstance.Builder availabilityZone​(String availabilityZone)

        The Availability Zone for the instance.

        Parameters:
        availabilityZone - The Availability Zone for the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationSubnetGroup

        ReplicationInstance.Builder replicationSubnetGroup​(ReplicationSubnetGroup replicationSubnetGroup)

        The subnet group for the replication instance.

        Parameters:
        replicationSubnetGroup - The subnet group for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        ReplicationInstance.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

        Parameters:
        preferredMaintenanceWindow - The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingModifiedValues

        ReplicationInstance.Builder pendingModifiedValues​(ReplicationPendingModifiedValues pendingModifiedValues)

        The pending modification values.

        Parameters:
        pendingModifiedValues - The pending modification values.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZ

        ReplicationInstance.Builder multiAZ​(Boolean multiAZ)

        Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

        Parameters:
        multiAZ - Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        ReplicationInstance.Builder engineVersion​(String engineVersion)

        The engine version number of the replication instance.

        If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

        When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

        Parameters:
        engineVersion - The engine version number of the replication instance.

        If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

        When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        ReplicationInstance.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        Boolean value indicating if minor version upgrades will be automatically applied to the instance.

        Parameters:
        autoMinorVersionUpgrade - Boolean value indicating if minor version upgrades will be automatically applied to the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        ReplicationInstance.Builder kmsKeyId​(String kmsKeyId)

        An KMS key identifier that is used to encrypt the data on the replication instance.

        If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

        KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

        Parameters:
        kmsKeyId - An KMS key identifier that is used to encrypt the data on the replication instance.

        If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

        KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstanceArn

        ReplicationInstance.Builder replicationInstanceArn​(String replicationInstanceArn)

        The Amazon Resource Name (ARN) of the replication instance.

        Parameters:
        replicationInstanceArn - The Amazon Resource Name (ARN) of the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePublicIpAddress

        @Deprecated
ReplicationInstance.Builder replicationInstancePublicIpAddress​(String replicationInstancePublicIpAddress)
        Deprecated.

        The public IP address of the replication instance.

        Parameters:
        replicationInstancePublicIpAddress - The public IP address of the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePrivateIpAddress

        @Deprecated
ReplicationInstance.Builder replicationInstancePrivateIpAddress​(String replicationInstancePrivateIpAddress)
        Deprecated.

        The private IP address of the replication instance.

        Parameters:
        replicationInstancePrivateIpAddress - The private IP address of the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePublicIpAddresses

        ReplicationInstance.Builder replicationInstancePublicIpAddresses​(Collection<String> replicationInstancePublicIpAddresses)

        One or more public IP addresses for the replication instance.

        Parameters:
        replicationInstancePublicIpAddresses - One or more public IP addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePublicIpAddresses

        ReplicationInstance.Builder replicationInstancePublicIpAddresses​(String... replicationInstancePublicIpAddresses)

        One or more public IP addresses for the replication instance.

        Parameters:
        replicationInstancePublicIpAddresses - One or more public IP addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePrivateIpAddresses

        ReplicationInstance.Builder replicationInstancePrivateIpAddresses​(Collection<String> replicationInstancePrivateIpAddresses)

        One or more private IP addresses for the replication instance.

        Parameters:
        replicationInstancePrivateIpAddresses - One or more private IP addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstancePrivateIpAddresses

        ReplicationInstance.Builder replicationInstancePrivateIpAddresses​(String... replicationInstancePrivateIpAddresses)

        One or more private IP addresses for the replication instance.

        Parameters:
        replicationInstancePrivateIpAddresses - One or more private IP addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstanceIpv6Addresses

        ReplicationInstance.Builder replicationInstanceIpv6Addresses​(Collection<String> replicationInstanceIpv6Addresses)

        One or more IPv6 addresses for the replication instance.

        Parameters:
        replicationInstanceIpv6Addresses - One or more IPv6 addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationInstanceIpv6Addresses

        ReplicationInstance.Builder replicationInstanceIpv6Addresses​(String... replicationInstanceIpv6Addresses)

        One or more IPv6 addresses for the replication instance.

        Parameters:
        replicationInstanceIpv6Addresses - One or more IPv6 addresses for the replication instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        ReplicationInstance.Builder publiclyAccessible​(Boolean publiclyAccessible)

        Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

        Parameters:
        publiclyAccessible - Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryAvailabilityZone

        ReplicationInstance.Builder secondaryAvailabilityZone​(String secondaryAvailabilityZone)

        The Availability Zone of the standby replication instance in a Multi-AZ deployment.

        Parameters:
        secondaryAvailabilityZone - The Availability Zone of the standby replication instance in a Multi-AZ deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • freeUntil

        ReplicationInstance.Builder freeUntil​(Instant freeUntil)

        The expiration date of the free replication instance that is part of the Free DMS program.

        Parameters:
        freeUntil - The expiration date of the free replication instance that is part of the Free DMS program.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dnsNameServers

        ReplicationInstance.Builder dnsNameServers​(String dnsNameServers)

        The DNS name servers supported for the replication instance to access your on-premise source or target database.

        Parameters:
        dnsNameServers - The DNS name servers supported for the replication instance to access your on-premise source or target database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkType

        ReplicationInstance.Builder networkType​(String networkType)

        The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

        Parameters:
        networkType - The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.