Package software.amazon.awssdk.services.docdb.model

Interface DescribeDbClusterSnapshotsRequest.Builder

    • Method Detail

      • dbClusterIdentifier

        DescribeDbClusterSnapshotsRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

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

        Constraints:

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

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

        Constraints:

        • If provided, 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 cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

        Constraints:

        • If provided, 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 cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

        Constraints:

        • If provided, 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 cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

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

        If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic 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 cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

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

        If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic 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 (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 (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 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 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)

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

        Parameters:
        includeShared - Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includePublic

        DescribeDbClusterSnapshotsRequest.Builder includePublic​(Boolean includePublic)

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

        Parameters:
        includePublic - Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.