Package software.amazon.awssdk.services.rds.model

Interface DescribeEventsRequest.Builder

    • Method Detail

      • sourceIdentifier

        DescribeEventsRequest.Builder sourceIdentifier​(String sourceIdentifier)

        The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

        Constraints:

        • If SourceIdentifier is supplied, SourceType must also be provided.

        • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        • Can't end with a hyphen or contain two consecutive hyphens.

        Parameters:
        sourceIdentifier - The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

        Constraints:

        • If SourceIdentifier is supplied, SourceType must also be provided.

        • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        • Can't end with a hyphen or contain two consecutive hyphens.

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

      • sourceType

        DescribeEventsRequest.Builder sourceType​(String sourceType)

        The event source to retrieve events for. If no value is specified, all events are returned.

        Parameters:
        sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • sourceType

        DescribeEventsRequest.Builder sourceType​(SourceType sourceType)

        The event source to retrieve events for. If no value is specified, all events are returned.

        Parameters:
        sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • startTime

        DescribeEventsRequest.Builder startTime​(Instant startTime)

        The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: 2009-07-08T18:00Z

        Parameters:
        startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: 2009-07-08T18:00Z

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

      • endTime

        DescribeEventsRequest.Builder endTime​(Instant endTime)

        The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: 2009-07-08T18:00Z

        Parameters:
        endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: 2009-07-08T18:00Z

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

      • duration

        DescribeEventsRequest.Builder duration​(Integer duration)

        The number of minutes to retrieve events for.

        Default: 60

        Parameters:
        duration - The number of minutes to retrieve events for.

        Default: 60

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

      • eventCategories

        DescribeEventsRequest.Builder eventCategories​(Collection<String> eventCategories)

        A list of event categories that trigger notifications for a event notification subscription.

        Parameters:
        eventCategories - A list of event categories that trigger notifications for a event notification subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventCategories

        DescribeEventsRequest.Builder eventCategories​(String... eventCategories)

        A list of event categories that trigger notifications for a event notification subscription.

        Parameters:
        eventCategories - A list of event categories that trigger notifications for a event notification subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

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

        This parameter isn't currently supported.

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

      • filters

        DescribeEventsRequest.Builder filters​(Filter... filters)

        This parameter isn't currently supported.

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

      • maxRecords

        DescribeEventsRequest.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 you can retrieve the remaining results.

        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 you can retrieve the remaining results.

        Default: 100

        Constraints: Minimum 20, maximum 100.

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

      • marker

        DescribeEventsRequest.Builder marker​(String marker)

        An optional pagination token provided by a previous DescribeEvents 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 DescribeEvents 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.