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

Interface DescribeDbClusterSnapshotsRequest.Builder

    • Method Detail

      • dbClusterIdentifier

        DescribeDbClusterSnapshotsRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

        Constraints:

        • If supplied, must match the identifier of an existing DBCluster.

        Parameters:
        dbClusterIdentifier - The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

        Constraints:

        • If supplied, must match the identifier of an existing DBCluster.

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

      • dbClusterSnapshotIdentifier

        DescribeDbClusterSnapshotsRequest.Builder dbClusterSnapshotIdentifier​(String dbClusterSnapshotIdentifier)

        A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

        Constraints:

        • If supplied, must match the identifier of an existing DBClusterSnapshot.

        • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

        Parameters:
        dbClusterSnapshotIdentifier - A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

        Constraints:

        • If supplied, must match the identifier of an existing DBClusterSnapshot.

        • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

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

      • snapshotType

        DescribeDbClusterSnapshotsRequest.Builder snapshotType​(String snapshotType)

        The type of DB cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.

        • manual - Return all DB cluster snapshots that have been taken by my Amazon account.

        • shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.

        • public - Return all DB cluster snapshots that have been marked as public.

        If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

        The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

        Parameters:
        snapshotType - The type of DB cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.

        • manual - Return all DB cluster snapshots that have been taken by my Amazon account.

        • shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.

        • public - Return all DB cluster snapshots that have been marked as public.

        If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

        The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

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

      • filters

        DescribeDbClusterSnapshotsRequest.Builder filters​(Collection<Filter> filters)

        This parameter is not currently supported.

        Parameters:
        filters - This parameter is not currently supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        DescribeDbClusterSnapshotsRequest.Builder filters​(Filter... filters)

        This parameter is not currently supported.

        Parameters:
        filters - This parameter is not currently supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxRecords

        DescribeDbClusterSnapshotsRequest.Builder maxRecords​(Integer maxRecords)

        The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

        Default: 100

        Constraints: Minimum 20, maximum 100.

        Parameters:
        maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

        Default: 100

        Constraints: Minimum 20, maximum 100.

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

      • marker

        DescribeDbClusterSnapshotsRequest.Builder marker​(String marker)

        An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

        Parameters:
        marker - An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeShared

        DescribeDbClusterSnapshotsRequest.Builder includeShared​(Boolean includeShared)

        True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false.

        You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

        Parameters:
        includeShared - True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false .

        You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

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

      • includePublic

        DescribeDbClusterSnapshotsRequest.Builder includePublic​(Boolean includePublic)

        True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

        You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

        Parameters:
        includePublic - True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

        You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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