Package software.amazon.awssdk.services.neptune.model

Interface DBInstance.Builder

    • Method Detail

      • dbInstanceIdentifier

        DBInstance.Builder dbInstanceIdentifier​(String dbInstanceIdentifier)

        Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        Parameters:
        dbInstanceIdentifier - Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceClass

        DBInstance.Builder dbInstanceClass​(String dbInstanceClass)

        Contains the name of the compute and memory capacity class of the DB instance.

        Parameters:
        dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        DBInstance.Builder engine​(String engine)

        Provides the name of the database engine to be used for this DB instance.

        Parameters:
        engine - Provides the name of the database engine to be used for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceStatus

        DBInstance.Builder dbInstanceStatus​(String dbInstanceStatus)

        Specifies the current state of this database.

        Parameters:
        dbInstanceStatus - Specifies the current state of this database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        DBInstance.Builder masterUsername​(String masterUsername)

        Not supported by Neptune.

        Parameters:
        masterUsername - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbName

        DBInstance.Builder dbName​(String dbName)

        The database name.

        Parameters:
        dbName - The database name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpoint

        DBInstance.Builder endpoint​(Endpoint endpoint)

        Specifies the connection endpoint.

        Parameters:
        endpoint - Specifies the connection endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        DBInstance.Builder allocatedStorage​(Integer allocatedStorage)

        Not supported by Neptune.

        Parameters:
        allocatedStorage - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceCreateTime

        DBInstance.Builder instanceCreateTime​(Instant instanceCreateTime)

        Provides the date and time the DB instance was created.

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

      • preferredBackupWindow

        DBInstance.Builder preferredBackupWindow​(String preferredBackupWindow)

        Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        Parameters:
        preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        DBInstance.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        Specifies the number of days for which automatic DB snapshots are retained.

        Parameters:
        backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        DBInstance.Builder dbSecurityGroups​(Collection<DBSecurityGroupMembership> dbSecurityGroups)

        Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

        Parameters:
        dbSecurityGroups - Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        DBInstance.Builder dbSecurityGroups​(DBSecurityGroupMembership... dbSecurityGroups)

        Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

        Parameters:
        dbSecurityGroups - Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

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

        Provides a list of VPC security group elements that the DB instance belongs to.

        Parameters:
        vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

        DBInstance.Builder vpcSecurityGroups​(VpcSecurityGroupMembership... vpcSecurityGroups)

        Provides a list of VPC security group elements that the DB instance belongs to.

        Parameters:
        vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroups

        DBInstance.Builder dbParameterGroups​(Collection<DBParameterGroupStatus> dbParameterGroups)

        Provides the list of DB parameter groups applied to this DB instance.

        Parameters:
        dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroups

        DBInstance.Builder dbParameterGroups​(DBParameterGroupStatus... dbParameterGroups)

        Provides the list of DB parameter groups applied to this DB instance.

        Parameters:
        dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        DBInstance.Builder availabilityZone​(String availabilityZone)

        Specifies the name of the Availability Zone the DB instance is located in.

        Parameters:
        availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroup

        DBInstance.Builder dbSubnetGroup​(DBSubnetGroup dbSubnetGroup)

        Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

        Parameters:
        dbSubnetGroup - Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        DBInstance.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingModifiedValues

        DBInstance.Builder pendingModifiedValues​(PendingModifiedValues pendingModifiedValues)

        Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

        Parameters:
        pendingModifiedValues - Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestRestorableTime

        DBInstance.Builder latestRestorableTime​(Instant latestRestorableTime)

        Specifies the latest time to which a database can be restored with point-in-time restore.

        Parameters:
        latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZ

        DBInstance.Builder multiAZ​(Boolean multiAZ)

        Specifies if the DB instance is a Multi-AZ deployment.

        Parameters:
        multiAZ - Specifies if the DB instance is a Multi-AZ deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        DBInstance.Builder engineVersion​(String engineVersion)

        Indicates the database engine version.

        Parameters:
        engineVersion - Indicates the database engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        DBInstance.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        Indicates that minor version patches are applied automatically.

        Parameters:
        autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaSourceDBInstanceIdentifier

        DBInstance.Builder readReplicaSourceDBInstanceIdentifier​(String readReplicaSourceDBInstanceIdentifier)

        Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        Parameters:
        readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB instance if this DB instance is a Read Replica.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBInstanceIdentifiers

        DBInstance.Builder readReplicaDBInstanceIdentifiers​(Collection<String> readReplicaDBInstanceIdentifiers)

        Contains one or more identifiers of the Read Replicas associated with this DB instance.

        Parameters:
        readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBInstanceIdentifiers

        DBInstance.Builder readReplicaDBInstanceIdentifiers​(String... readReplicaDBInstanceIdentifiers)

        Contains one or more identifiers of the Read Replicas associated with this DB instance.

        Parameters:
        readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBClusterIdentifiers

        DBInstance.Builder readReplicaDBClusterIdentifiers​(Collection<String> readReplicaDBClusterIdentifiers)

        Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        Parameters:
        readReplicaDBClusterIdentifiers - Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readReplicaDBClusterIdentifiers

        DBInstance.Builder readReplicaDBClusterIdentifiers​(String... readReplicaDBClusterIdentifiers)

        Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        Parameters:
        readReplicaDBClusterIdentifiers - Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • licenseModel

        DBInstance.Builder licenseModel​(String licenseModel)

        License model information for this DB instance.

        Parameters:
        licenseModel - License model information for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iops

        DBInstance.Builder iops​(Integer iops)

        Specifies the Provisioned IOPS (I/O operations per second) value.

        Parameters:
        iops - Specifies the Provisioned IOPS (I/O operations per second) value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupMemberships

        DBInstance.Builder optionGroupMemberships​(Collection<OptionGroupMembership> optionGroupMemberships)

        (Not supported by Neptune)

        Parameters:
        optionGroupMemberships - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupMemberships

        DBInstance.Builder optionGroupMemberships​(OptionGroupMembership... optionGroupMemberships)

        (Not supported by Neptune)

        Parameters:
        optionGroupMemberships - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • characterSetName

        DBInstance.Builder characterSetName​(String characterSetName)

        (Not supported by Neptune)

        Parameters:
        characterSetName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryAvailabilityZone

        DBInstance.Builder secondaryAvailabilityZone​(String secondaryAvailabilityZone)

        If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        Parameters:
        secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        @Deprecated
DBInstance.Builder publiclyAccessible​(Boolean publiclyAccessible)
        Deprecated.

        This flag should no longer be used.

        Parameters:
        publiclyAccessible - This flag should no longer be used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusInfos

        DBInstance.Builder statusInfos​(Collection<DBInstanceStatusInfo> statusInfos)

        The status of a Read Replica. If the instance is not a Read Replica, this is blank.

        Parameters:
        statusInfos - The status of a Read Replica. If the instance is not a Read Replica, this is blank.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusInfos

        DBInstance.Builder statusInfos​(DBInstanceStatusInfo... statusInfos)

        The status of a Read Replica. If the instance is not a Read Replica, this is blank.

        Parameters:
        statusInfos - The status of a Read Replica. If the instance is not a Read Replica, this is blank.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        DBInstance.Builder storageType​(String storageType)

        Specifies the storage type associated with DB instance.

        Parameters:
        storageType - Specifies the storage type associated with DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tdeCredentialArn

        DBInstance.Builder tdeCredentialArn​(String tdeCredentialArn)

        The ARN from the key store with which the instance is associated for TDE encryption.

        Parameters:
        tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstancePort

        DBInstance.Builder dbInstancePort​(Integer dbInstancePort)

        Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        Parameters:
        dbInstancePort - Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterIdentifier

        DBInstance.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        Parameters:
        dbClusterIdentifier - If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageEncrypted

        DBInstance.Builder storageEncrypted​(Boolean storageEncrypted)

        Not supported: The encryption for DB instances is managed by the DB cluster.

        Parameters:
        storageEncrypted - Not supported: The encryption for DB instances is managed by the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        DBInstance.Builder kmsKeyId​(String kmsKeyId)

        Not supported: The encryption for DB instances is managed by the DB cluster.

        Parameters:
        kmsKeyId - Not supported: The encryption for DB instances is managed by the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbiResourceId

        DBInstance.Builder dbiResourceId​(String dbiResourceId)

        The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

        Parameters:
        dbiResourceId - The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • caCertificateIdentifier

        DBInstance.Builder caCertificateIdentifier​(String caCertificateIdentifier)

        The identifier of the CA certificate for this DB instance.

        Parameters:
        caCertificateIdentifier - The identifier of the CA certificate for this DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainMemberships

        DBInstance.Builder domainMemberships​(Collection<DomainMembership> domainMemberships)

        Not supported

        Parameters:
        domainMemberships - Not supported
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainMemberships

        DBInstance.Builder domainMemberships​(DomainMembership... domainMemberships)

        Not supported

        Parameters:
        domainMemberships - Not supported
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        DBInstance.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        Parameters:
        copyTagsToSnapshot - Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringInterval

        DBInstance.Builder monitoringInterval​(Integer monitoringInterval)

        The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        Parameters:
        monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enhancedMonitoringResourceArn

        DBInstance.Builder enhancedMonitoringResourceArn​(String enhancedMonitoringResourceArn)

        The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        Parameters:
        enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringRoleArn

        DBInstance.Builder monitoringRoleArn​(String monitoringRoleArn)

        The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        Parameters:
        monitoringRoleArn - The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotionTier

        DBInstance.Builder promotionTier​(Integer promotionTier)

        A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        Parameters:
        promotionTier - A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceArn

        DBInstance.Builder dbInstanceArn​(String dbInstanceArn)

        The Amazon Resource Name (ARN) for the DB instance.

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

      • timezone

        DBInstance.Builder timezone​(String timezone)

        Not supported.

        Parameters:
        timezone - Not supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamDatabaseAuthenticationEnabled

        DBInstance.Builder iamDatabaseAuthenticationEnabled​(Boolean iamDatabaseAuthenticationEnabled)

        True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        Parameters:
        iamDatabaseAuthenticationEnabled - True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceInsightsEnabled

        DBInstance.Builder performanceInsightsEnabled​(Boolean performanceInsightsEnabled)

        (Not supported by Neptune)

        Parameters:
        performanceInsightsEnabled - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceInsightsKMSKeyId

        DBInstance.Builder performanceInsightsKMSKeyId​(String performanceInsightsKMSKeyId)

        (Not supported by Neptune)

        Parameters:
        performanceInsightsKMSKeyId - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabledCloudwatchLogsExports

        DBInstance.Builder enabledCloudwatchLogsExports​(Collection<String> enabledCloudwatchLogsExports)

        A list of log types that this DB instance is configured to export to CloudWatch Logs.

        Parameters:
        enabledCloudwatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabledCloudwatchLogsExports

        DBInstance.Builder enabledCloudwatchLogsExports​(String... enabledCloudwatchLogsExports)

        A list of log types that this DB instance is configured to export to CloudWatch Logs.

        Parameters:
        enabledCloudwatchLogsExports - A list of log types that this DB instance is configured to export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        DBInstance.Builder deletionProtection​(Boolean deletionProtection)

        Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

        Parameters:
        deletionProtection - Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.