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

Interface DBCluster.Builder

    • Method Detail

      • allocatedStorage

        DBCluster.Builder allocatedStorage​(Integer allocatedStorage)

        AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        Parameters:
        allocatedStorage - AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        DBCluster.Builder availabilityZones​(Collection<String> availabilityZones)

        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        DBCluster.Builder availabilityZones​(String... availabilityZones)

        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        DBCluster.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.

      • characterSetName

        DBCluster.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.

      • databaseName

        DBCluster.Builder databaseName​(String databaseName)

        Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        Parameters:
        databaseName - Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterIdentifier

        DBCluster.Builder dbClusterIdentifier​(String dbClusterIdentifier)

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

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

      • dbClusterParameterGroup

        DBCluster.Builder dbClusterParameterGroup​(String dbClusterParameterGroup)

        Specifies the name of the DB cluster parameter group for the DB cluster.

        Parameters:
        dbClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroup

        DBCluster.Builder dbSubnetGroup​(String dbSubnetGroup)

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

        Parameters:
        dbSubnetGroup - Specifies information on the subnet group associated with the DB cluster, 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.

      • status

        DBCluster.Builder status​(String status)

        Specifies the current state of this DB cluster.

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

      • percentProgress

        DBCluster.Builder percentProgress​(String percentProgress)

        Specifies the progress of the operation as a percentage.

        Parameters:
        percentProgress - Specifies the progress of the operation as a percentage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • earliestRestorableTime

        DBCluster.Builder earliestRestorableTime​(Instant earliestRestorableTime)

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

        Parameters:
        earliestRestorableTime - Specifies the earliest 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.

      • endpoint

        DBCluster.Builder endpoint​(String endpoint)

        Specifies the connection endpoint for the primary instance of the DB cluster.

        Parameters:
        endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readerEndpoint

        DBCluster.Builder readerEndpoint​(String readerEndpoint)

        The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

        If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        Parameters:
        readerEndpoint - The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

        If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

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

      • multiAZ

        DBCluster.Builder multiAZ​(Boolean multiAZ)

        Specifies whether the DB cluster has instances in multiple Availability Zones.

        Parameters:
        multiAZ - Specifies whether the DB cluster has instances in multiple Availability Zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        DBCluster.Builder engine​(String engine)

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

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

      • engineVersion

        DBCluster.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.

      • latestRestorableTime

        DBCluster.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.

      • port

        DBCluster.Builder port​(Integer port)

        Specifies the port that the database engine is listening on.

        Parameters:
        port - Specifies the port that the database engine is listening on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        DBCluster.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.

      • dbClusterOptionGroupMemberships

        DBCluster.Builder dbClusterOptionGroupMemberships​(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)

        Not supported by Neptune.

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

      • dbClusterOptionGroupMemberships

        DBCluster.Builder dbClusterOptionGroupMemberships​(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)

        Not supported by Neptune.

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

      • preferredBackupWindow

        DBCluster.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.

      • preferredMaintenanceWindow

        DBCluster.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.

      • replicationSourceIdentifier

        DBCluster.Builder replicationSourceIdentifier​(String replicationSourceIdentifier)

        Not supported by Neptune.

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

      • readReplicaIdentifiers

        DBCluster.Builder readReplicaIdentifiers​(Collection<String> readReplicaIdentifiers)

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

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

      • readReplicaIdentifiers

        DBCluster.Builder readReplicaIdentifiers​(String... readReplicaIdentifiers)

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

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

      • dbClusterMembers

        DBCluster.Builder dbClusterMembers​(Collection<DBClusterMember> dbClusterMembers)

        Provides the list of instances that make up the DB cluster.

        Parameters:
        dbClusterMembers - Provides the list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterMembers

        DBCluster.Builder dbClusterMembers​(DBClusterMember... dbClusterMembers)

        Provides the list of instances that make up the DB cluster.

        Parameters:
        dbClusterMembers - Provides the list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroups

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

        Provides a list of VPC security groups that the DB cluster belongs to.

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

      • vpcSecurityGroups

        DBCluster.Builder vpcSecurityGroups​(VpcSecurityGroupMembership... vpcSecurityGroups)

        Provides a list of VPC security groups that the DB cluster belongs to.

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

      • hostedZoneId

        DBCluster.Builder hostedZoneId​(String hostedZoneId)

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        Parameters:
        hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageEncrypted

        DBCluster.Builder storageEncrypted​(Boolean storageEncrypted)

        Specifies whether the DB cluster is encrypted.

        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        DBCluster.Builder kmsKeyId​(String kmsKeyId)

        If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

        Parameters:
        kmsKeyId - If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterResourceId

        DBCluster.Builder dbClusterResourceId​(String dbClusterResourceId)

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

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

      • dbClusterArn

        DBCluster.Builder dbClusterArn​(String dbClusterArn)

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

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

      • associatedRoles

        DBCluster.Builder associatedRoles​(Collection<DBClusterRole> associatedRoles)

        Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

        Parameters:
        associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedRoles

        DBCluster.Builder associatedRoles​(DBClusterRole... associatedRoles)

        Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

        Parameters:
        associatedRoles - Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associatedRoles

        DBCluster.Builder associatedRoles​(Consumer<DBClusterRole.Builder>... associatedRoles)

        Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

        This is a convenience method that creates an instance of the DBClusterRole.Builder avoiding the need to create one manually via DBClusterRole.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #associatedRoles(List).

        Parameters:
        associatedRoles - a consumer that will call methods on DBClusterRole.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #associatedRoles(java.util.Collection)

      • iamDatabaseAuthenticationEnabled

        DBCluster.Builder iamDatabaseAuthenticationEnabled​(Boolean iamDatabaseAuthenticationEnabled)

        True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

      • cloneGroupId

        DBCluster.Builder cloneGroupId​(String cloneGroupId)

        Identifies the clone group to which the DB cluster is associated.

        Parameters:
        cloneGroupId - Identifies the clone group to which the DB cluster is associated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterCreateTime

        DBCluster.Builder clusterCreateTime​(Instant clusterCreateTime)

        Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        Parameters:
        clusterCreateTime - Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        DBCluster.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

        Parameters:
        copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the DB cluster that is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabledCloudwatchLogsExports

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

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

        Parameters:
        enabledCloudwatchLogsExports - A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabledCloudwatchLogsExports

        DBCluster.Builder enabledCloudwatchLogsExports​(String... enabledCloudwatchLogsExports)

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

        Parameters:
        enabledCloudwatchLogsExports - A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingModifiedValues

        DBCluster.Builder pendingModifiedValues​(ClusterPendingModifiedValues pendingModifiedValues)

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        Parameters:
        pendingModifiedValues - This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        DBCluster.Builder deletionProtection​(Boolean deletionProtection)

        Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

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

      • crossAccountClone

        DBCluster.Builder crossAccountClone​(Boolean crossAccountClone)

        If set to true, the DB cluster can be cloned across accounts.

        Parameters:
        crossAccountClone - If set to true, the DB cluster can be cloned across accounts.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • automaticRestartTime

        DBCluster.Builder automaticRestartTime​(Instant automaticRestartTime)

        Time at which the DB cluster will be automatically restarted.

        Parameters:
        automaticRestartTime - Time at which the DB cluster will be automatically restarted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverlessV2ScalingConfiguration

        DBCluster.Builder serverlessV2ScalingConfiguration​(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        Parameters:
        serverlessV2ScalingConfiguration - Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

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

      • globalClusterIdentifier

        DBCluster.Builder globalClusterIdentifier​(String globalClusterIdentifier)

        Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

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

      • ioOptimizedNextAllowedModificationTime

        DBCluster.Builder ioOptimizedNextAllowedModificationTime​(Instant ioOptimizedNextAllowedModificationTime)

        The next time you can modify the DB cluster to use the iopt1 storage type.

        Parameters:
        ioOptimizedNextAllowedModificationTime - The next time you can modify the DB cluster to use the iopt1 storage type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        DBCluster.Builder storageType​(String storageType)

        The storage type associated with the DB cluster.

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