Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getStreams

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleStreams = cloudflare.getStreams({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    creator: "creator-id_abcde12345",
    end: "2014-01-02T02:20:00Z",
    search: "puppy.mp4",
    start: "2014-01-02T02:20:00Z",
    status: "inprogress",
    type: "live",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_streams = cloudflare.get_streams(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    creator="creator-id_abcde12345",
    end="2014-01-02T02:20:00Z",
    search="puppy.mp4",
    start="2014-01-02T02:20:00Z",
    status="inprogress",
    type="live")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupStreams(ctx, &cloudflare.LookupStreamsArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			Creator:   pulumi.StringRef("creator-id_abcde12345"),
			End:       pulumi.StringRef("2014-01-02T02:20:00Z"),
			Search:    pulumi.StringRef("puppy.mp4"),
			Start:     pulumi.StringRef("2014-01-02T02:20:00Z"),
			Status:    pulumi.StringRef("inprogress"),
			Type:      pulumi.StringRef("live"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleStreams = Cloudflare.GetStreams.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        Creator = "creator-id_abcde12345",
        End = "2014-01-02T02:20:00Z",
        Search = "puppy.mp4",
        Start = "2014-01-02T02:20:00Z",
        Status = "inprogress",
        Type = "live",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetStreamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleStreams = CloudflareFunctions.getStreams(GetStreamsArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .creator("creator-id_abcde12345")
            .end("2014-01-02T02:20:00Z")
            .search("puppy.mp4")
            .start("2014-01-02T02:20:00Z")
            .status("inprogress")
            .type("live")
            .build());

    }
}

variables:
  exampleStreams:
    fn::invoke:
      function: cloudflare:getStreams
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        creator: creator-id_abcde12345
        end: 2014-01-02T02:20:00Z
        search: puppy.mp4
        start: 2014-01-02T02:20:00Z
        status: inprogress
        type: live

Using getStreams

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStreams(args: GetStreamsArgs, opts?: InvokeOptions): Promise<GetStreamsResult>
function getStreamsOutput(args: GetStreamsOutputArgs, opts?: InvokeOptions): Output<GetStreamsResult>

def get_streams(account_id: Optional[str] = None,
                asc: Optional[bool] = None,
                creator: Optional[str] = None,
                end: Optional[str] = None,
                include_counts: Optional[bool] = None,
                max_items: Optional[int] = None,
                search: Optional[str] = None,
                start: Optional[str] = None,
                status: Optional[str] = None,
                type: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetStreamsResult
def get_streams_output(account_id: Optional[pulumi.Input[str]] = None,
                asc: Optional[pulumi.Input[bool]] = None,
                creator: Optional[pulumi.Input[str]] = None,
                end: Optional[pulumi.Input[str]] = None,
                include_counts: Optional[pulumi.Input[bool]] = None,
                max_items: Optional[pulumi.Input[int]] = None,
                search: Optional[pulumi.Input[str]] = None,
                start: Optional[pulumi.Input[str]] = None,
                status: Optional[pulumi.Input[str]] = None,
                type: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetStreamsResult]

func LookupStreams(ctx *Context, args *LookupStreamsArgs, opts ...InvokeOption) (*LookupStreamsResult, error)
func LookupStreamsOutput(ctx *Context, args *LookupStreamsOutputArgs, opts ...InvokeOption) LookupStreamsResultOutput

> Note: This function is named LookupStreams in the Go SDK.

public static class GetStreams 
{
    public static Task<GetStreamsResult> InvokeAsync(GetStreamsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamsResult> Invoke(GetStreamsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)
public static Output<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getStreams:getStreams
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: The account identifier tag.
Asc bool: Lists videos in ascending order of creation.
Creator string: A user-defined identifier for the media creator.
End string: Lists videos created before the specified date.
IncludeCounts bool: Includes the total number of videos associated with the submitted query parameters.
MaxItems int: Max items to fetch, default: 1000
Search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
Start string: Lists videos created after the specified date.
Status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
Type string: Specifies whether the video is vod or live.

AccountId string: The account identifier tag.
Asc bool: Lists videos in ascending order of creation.
Creator string: A user-defined identifier for the media creator.
End string: Lists videos created before the specified date.
IncludeCounts bool: Includes the total number of videos associated with the submitted query parameters.
MaxItems int: Max items to fetch, default: 1000
Search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
Start string: Lists videos created after the specified date.
Status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
Type string: Specifies whether the video is vod or live.

accountId String: The account identifier tag.
asc Boolean: Lists videos in ascending order of creation.
creator String: A user-defined identifier for the media creator.
end String: Lists videos created before the specified date.
includeCounts Boolean: Includes the total number of videos associated with the submitted query parameters.
maxItems Integer: Max items to fetch, default: 1000
search String: Searches over the name key in the meta field. This field can be set with or after the upload request.
start String: Lists videos created after the specified date.
status String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type String: Specifies whether the video is vod or live.

accountId string: The account identifier tag.
asc boolean: Lists videos in ascending order of creation.
creator string: A user-defined identifier for the media creator.
end string: Lists videos created before the specified date.
includeCounts boolean: Includes the total number of videos associated with the submitted query parameters.
maxItems number: Max items to fetch, default: 1000
search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
start string: Lists videos created after the specified date.
status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type string: Specifies whether the video is vod or live.

account_id str: The account identifier tag.
asc bool: Lists videos in ascending order of creation.
creator str: A user-defined identifier for the media creator.
end str: Lists videos created before the specified date.
include_counts bool: Includes the total number of videos associated with the submitted query parameters.
max_items int: Max items to fetch, default: 1000
search str: Searches over the name key in the meta field. This field can be set with or after the upload request.
start str: Lists videos created after the specified date.
status str: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type str: Specifies whether the video is vod or live.

accountId String: The account identifier tag.
asc Boolean: Lists videos in ascending order of creation.
creator String: A user-defined identifier for the media creator.
end String: Lists videos created before the specified date.
includeCounts Boolean: Includes the total number of videos associated with the submitted query parameters.
maxItems Number: Max items to fetch, default: 1000
search String: Searches over the name key in the meta field. This field can be set with or after the upload request.
start String: Lists videos created after the specified date.
status String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type String: Specifies whether the video is vod or live.

getStreams Result

The following output properties are available:

AccountId string: The account identifier tag.
Asc bool: Lists videos in ascending order of creation.
Id string: The provider-assigned unique ID for this managed resource.
IncludeCounts bool: Includes the total number of videos associated with the submitted query parameters.
Results List<GetStreamsResult>: The items returned by the data source
Creator string: A user-defined identifier for the media creator.
End string: Lists videos created before the specified date.
MaxItems int: Max items to fetch, default: 1000
Search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
Start string: Lists videos created after the specified date.
Status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
Type string: Specifies whether the video is vod or live.

AccountId string: The account identifier tag.
Asc bool: Lists videos in ascending order of creation.
Id string: The provider-assigned unique ID for this managed resource.
IncludeCounts bool: Includes the total number of videos associated with the submitted query parameters.
Results []GetStreamsResult: The items returned by the data source
Creator string: A user-defined identifier for the media creator.
End string: Lists videos created before the specified date.
MaxItems int: Max items to fetch, default: 1000
Search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
Start string: Lists videos created after the specified date.
Status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
Type string: Specifies whether the video is vod or live.

accountId String: The account identifier tag.
asc Boolean: Lists videos in ascending order of creation.
id String: The provider-assigned unique ID for this managed resource.
includeCounts Boolean: Includes the total number of videos associated with the submitted query parameters.
results List<GetStreamsResult>: The items returned by the data source
creator String: A user-defined identifier for the media creator.
end String: Lists videos created before the specified date.
maxItems Integer: Max items to fetch, default: 1000
search String: Searches over the name key in the meta field. This field can be set with or after the upload request.
start String: Lists videos created after the specified date.
status String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type String: Specifies whether the video is vod or live.

accountId string: The account identifier tag.
asc boolean: Lists videos in ascending order of creation.
id string: The provider-assigned unique ID for this managed resource.
includeCounts boolean: Includes the total number of videos associated with the submitted query parameters.
results GetStreamsResult[]: The items returned by the data source
creator string: A user-defined identifier for the media creator.
end string: Lists videos created before the specified date.
maxItems number: Max items to fetch, default: 1000
search string: Searches over the name key in the meta field. This field can be set with or after the upload request.
start string: Lists videos created after the specified date.
status string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type string: Specifies whether the video is vod or live.

account_id str: The account identifier tag.
asc bool: Lists videos in ascending order of creation.
id str: The provider-assigned unique ID for this managed resource.
include_counts bool: Includes the total number of videos associated with the submitted query parameters.
results Sequence[GetStreamsResult]: The items returned by the data source
creator str: A user-defined identifier for the media creator.
end str: Lists videos created before the specified date.
max_items int: Max items to fetch, default: 1000
search str: Searches over the name key in the meta field. This field can be set with or after the upload request.
start str: Lists videos created after the specified date.
status str: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type str: Specifies whether the video is vod or live.

accountId String: The account identifier tag.
asc Boolean: Lists videos in ascending order of creation.
id String: The provider-assigned unique ID for this managed resource.
includeCounts Boolean: Includes the total number of videos associated with the submitted query parameters.
results List<Property Map>: The items returned by the data source
creator String: A user-defined identifier for the media creator.
end String: Lists videos created before the specified date.
maxItems Number: Max items to fetch, default: 1000
search String: Searches over the name key in the meta field. This field can be set with or after the upload request.
start String: Lists videos created after the specified date.
status String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
type String: Specifies whether the video is vod or live.

Supporting Types

GetStreamsResult

AllowedOrigins List<string>: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
Created string: The date and time the media item was created.
Creator string: A user-defined identifier for the media creator.
Duration double: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
Input GetStreamsResultInput
LiveInput string: The live input ID used to upload a video with Stream Live.
MaxDurationSeconds int: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
Meta string: A user modifiable key-value store used to reference other systems of record for managing videos.
Modified string: The date and time the media item was last modified.
Playback GetStreamsResultPlayback
Preview string: The video's preview page URI. This field is omitted until encoding is complete.
ReadyToStream bool: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
ReadyToStreamAt string: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
RequireSignedUrls bool: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
ScheduledDeletion string: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
Size double: The size of the media item in bytes.
Status GetStreamsResultStatus: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
Thumbnail string: The media item's thumbnail URI. This field is omitted until encoding is complete.
ThumbnailTimestampPct double: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
Uid string: A Cloudflare-generated unique identifier for a media item.
UploadExpiry string: The date and time when the video upload URL is no longer valid for direct user uploads.
Uploaded string: The date and time the media item was uploaded.
Watermark GetStreamsResultWatermark

AllowedOrigins []string: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
Created string: The date and time the media item was created.
Creator string: A user-defined identifier for the media creator.
Duration float64: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
Input GetStreamsResultInputType
LiveInput string: The live input ID used to upload a video with Stream Live.
MaxDurationSeconds int: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
Meta string: A user modifiable key-value store used to reference other systems of record for managing videos.
Modified string: The date and time the media item was last modified.
Playback GetStreamsResultPlayback
Preview string: The video's preview page URI. This field is omitted until encoding is complete.
ReadyToStream bool: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
ReadyToStreamAt string: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
RequireSignedUrls bool: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
ScheduledDeletion string: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
Size float64: The size of the media item in bytes.
Status GetStreamsResultStatus: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
Thumbnail string: The media item's thumbnail URI. This field is omitted until encoding is complete.
ThumbnailTimestampPct float64: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
Uid string: A Cloudflare-generated unique identifier for a media item.
UploadExpiry string: The date and time when the video upload URL is no longer valid for direct user uploads.
Uploaded string: The date and time the media item was uploaded.
Watermark GetStreamsResultWatermark

allowedOrigins List<String>: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
created String: The date and time the media item was created.
creator String: A user-defined identifier for the media creator.
duration Double: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
input GetStreamsResultInput
liveInput String: The live input ID used to upload a video with Stream Live.
maxDurationSeconds Integer: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
meta String: A user modifiable key-value store used to reference other systems of record for managing videos.
modified String: The date and time the media item was last modified.
playback GetStreamsResultPlayback
preview String: The video's preview page URI. This field is omitted until encoding is complete.
readyToStream Boolean: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
readyToStreamAt String: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
requireSignedUrls Boolean: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
scheduledDeletion String: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
size Double: The size of the media item in bytes.
status GetStreamsResultStatus: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
thumbnail String: The media item's thumbnail URI. This field is omitted until encoding is complete.
thumbnailTimestampPct Double: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
uid String: A Cloudflare-generated unique identifier for a media item.
uploadExpiry String: The date and time when the video upload URL is no longer valid for direct user uploads.
uploaded String: The date and time the media item was uploaded.
watermark GetStreamsResultWatermark

allowedOrigins string[]: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
created string: The date and time the media item was created.
creator string: A user-defined identifier for the media creator.
duration number: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
input GetStreamsResultInput
liveInput string: The live input ID used to upload a video with Stream Live.
maxDurationSeconds number: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
meta string: A user modifiable key-value store used to reference other systems of record for managing videos.
modified string: The date and time the media item was last modified.
playback GetStreamsResultPlayback
preview string: The video's preview page URI. This field is omitted until encoding is complete.
readyToStream boolean: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
readyToStreamAt string: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
requireSignedUrls boolean: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
scheduledDeletion string: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
size number: The size of the media item in bytes.
status GetStreamsResultStatus: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
thumbnail string: The media item's thumbnail URI. This field is omitted until encoding is complete.
thumbnailTimestampPct number: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
uid string: A Cloudflare-generated unique identifier for a media item.
uploadExpiry string: The date and time when the video upload URL is no longer valid for direct user uploads.
uploaded string: The date and time the media item was uploaded.
watermark GetStreamsResultWatermark

allowed_origins Sequence[str]: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
created str: The date and time the media item was created.
creator str: A user-defined identifier for the media creator.
duration float: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
input GetStreamsResultInput
live_input str: The live input ID used to upload a video with Stream Live.
max_duration_seconds int: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
meta str: A user modifiable key-value store used to reference other systems of record for managing videos.
modified str: The date and time the media item was last modified.
playback GetStreamsResultPlayback
preview str: The video's preview page URI. This field is omitted until encoding is complete.
ready_to_stream bool: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
ready_to_stream_at str: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
require_signed_urls bool: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
scheduled_deletion str: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
size float: The size of the media item in bytes.
status GetStreamsResultStatus: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
thumbnail str: The media item's thumbnail URI. This field is omitted until encoding is complete.
thumbnail_timestamp_pct float: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
uid str: A Cloudflare-generated unique identifier for a media item.
upload_expiry str: The date and time when the video upload URL is no longer valid for direct user uploads.
uploaded str: The date and time the media item was uploaded.
watermark GetStreamsResultWatermark

allowedOrigins List<String>: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
created String: The date and time the media item was created.
creator String: A user-defined identifier for the media creator.
duration Number: The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
input Property Map
liveInput String: The live input ID used to upload a video with Stream Live.
maxDurationSeconds Number: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
meta String: A user modifiable key-value store used to reference other systems of record for managing videos.
modified String: The date and time the media item was last modified.
playback Property Map
preview String: The video's preview page URI. This field is omitted until encoding is complete.
readyToStream Boolean: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
readyToStreamAt String: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
requireSignedUrls Boolean: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
scheduledDeletion String: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
size Number: The size of the media item in bytes.
status Property Map: Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
thumbnail String: The media item's thumbnail URI. This field is omitted until encoding is complete.
thumbnailTimestampPct Number: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
uid String: A Cloudflare-generated unique identifier for a media item.
uploadExpiry String: The date and time when the video upload URL is no longer valid for direct user uploads.
uploaded String: The date and time the media item was uploaded.
watermark Property Map

GetStreamsResultInput

Height int: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
Width int: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

Height int: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
Width int: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

height Integer: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
width Integer: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

height number: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
width number: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

height int: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
width int: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

height Number: The video height in pixels. A value of -1 means the height is unknown. The value becomes available after the upload and before the video is ready.
width Number: The video width in pixels. A value of -1 means the width is unknown. The value becomes available after the upload and before the video is ready.

GetStreamsResultPlayback

Dash string: DASH Media Presentation Description for the video.
Hls string: The HLS manifest for the video.

Dash string: DASH Media Presentation Description for the video.
Hls string: The HLS manifest for the video.

dash String: DASH Media Presentation Description for the video.
hls String: The HLS manifest for the video.

dash string: DASH Media Presentation Description for the video.
hls string: The HLS manifest for the video.

dash str: DASH Media Presentation Description for the video.
hls str: The HLS manifest for the video.

dash String: DASH Media Presentation Description for the video.
hls String: The HLS manifest for the video.

GetStreamsResultStatus

ErrorReasonCode string: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
ErrorReasonText string: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
PctComplete string: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
State string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

ErrorReasonCode string: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
ErrorReasonText string: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
PctComplete string: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
State string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

errorReasonCode String: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
errorReasonText String: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
pctComplete String: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
state String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

errorReasonCode string: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
errorReasonText string: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
pctComplete string: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
state string: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

error_reason_code str: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
error_reason_text str: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
pct_complete str: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
state str: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

errorReasonCode String: Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
errorReasonText String: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
pctComplete String: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
state String: Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".

GetStreamsResultWatermark

Created string: The date and a time a watermark profile was created.
DownloadedFrom string: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
Height int: The height of the image in pixels.
Name string: A short description of the watermark profile.
Opacity double: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
Padding double: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
Position string: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
Scale double: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
Size double: The size of the image in bytes.
Uid string: The unique identifier for a watermark profile.
Width int: The width of the image in pixels.

Created string: The date and a time a watermark profile was created.
DownloadedFrom string: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
Height int: The height of the image in pixels.
Name string: A short description of the watermark profile.
Opacity float64: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
Padding float64: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
Position string: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
Scale float64: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
Size float64: The size of the image in bytes.
Uid string: The unique identifier for a watermark profile.
Width int: The width of the image in pixels.

created String: The date and a time a watermark profile was created.
downloadedFrom String: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
height Integer: The height of the image in pixels.
name String: A short description of the watermark profile.
opacity Double: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
padding Double: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
position String: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
scale Double: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
size Double: The size of the image in bytes.
uid String: The unique identifier for a watermark profile.
width Integer: The width of the image in pixels.

created string: The date and a time a watermark profile was created.
downloadedFrom string: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
height number: The height of the image in pixels.
name string: A short description of the watermark profile.
opacity number: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
padding number: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
position string: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
scale number: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
size number: The size of the image in bytes.
uid string: The unique identifier for a watermark profile.
width number: The width of the image in pixels.

created str: The date and a time a watermark profile was created.
downloaded_from str: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
height int: The height of the image in pixels.
name str: A short description of the watermark profile.
opacity float: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
padding float: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
position str: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
scale float: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
size float: The size of the image in bytes.
uid str: The unique identifier for a watermark profile.
width int: The width of the image in pixels.

created String: The date and a time a watermark profile was created.
downloadedFrom String: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
height Number: The height of the image in pixels.
name String: A short description of the watermark profile.
opacity Number: The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.
padding Number: The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.
position String: The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.
scale Number: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0fills the entire video.
size Number: The size of the image in bytes.
uid String: The unique identifier for a watermark profile.
width Number: The width of the image in pixels.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getStreams

On this page

On this page

Example Usage

Using getStreams

getStreams Result

Supporting Types

GetStreamsResult

GetStreamsResultInput

GetStreamsResultPlayback

GetStreamsResultStatus

GetStreamsResultWatermark

Package Details

On this page

On this page