cloudflare.Stream
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleStream = new cloudflare.Stream("example_stream", {accountId: "023e105f4ecef8ad9ca31a8372d0c353"});
import pulumi
import pulumi_cloudflare as cloudflare
example_stream = cloudflare.Stream("example_stream", account_id="023e105f4ecef8ad9ca31a8372d0c353")
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.NewStream(ctx, "example_stream", &cloudflare.StreamArgs{
AccountId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
})
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 exampleStream = new Cloudflare.Stream("example_stream", new()
{
AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.Stream;
import com.pulumi.cloudflare.StreamArgs;
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) {
var exampleStream = new Stream("exampleStream", StreamArgs.builder()
.accountId("023e105f4ecef8ad9ca31a8372d0c353")
.build());
}
}
resources:
exampleStream:
type: cloudflare:Stream
name: example_stream
properties:
accountId: 023e105f4ecef8ad9ca31a8372d0c353
Create Stream Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Stream(name: string, args: StreamArgs, opts?: CustomResourceOptions);
@overload
def Stream(resource_name: str,
args: StreamArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Stream(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
allowed_origins: Optional[Sequence[str]] = None,
creator: Optional[str] = None,
identifier: Optional[str] = None,
max_duration_seconds: Optional[int] = None,
meta: Optional[str] = None,
require_signed_urls: Optional[bool] = None,
scheduled_deletion: Optional[str] = None,
thumbnail_timestamp_pct: Optional[float] = None,
upload_expiry: Optional[str] = None)
func NewStream(ctx *Context, name string, args StreamArgs, opts ...ResourceOption) (*Stream, error)
public Stream(string name, StreamArgs args, CustomResourceOptions? opts = null)
public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)
type: cloudflare:Stream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var streamResource = new Cloudflare.Stream("streamResource", new()
{
AccountId = "string",
AllowedOrigins = new[]
{
"string",
},
Creator = "string",
Identifier = "string",
MaxDurationSeconds = 0,
Meta = "string",
RequireSignedUrls = false,
ScheduledDeletion = "string",
ThumbnailTimestampPct = 0,
UploadExpiry = "string",
});
example, err := cloudflare.NewStream(ctx, "streamResource", &cloudflare.StreamArgs{
AccountId: pulumi.String("string"),
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
Creator: pulumi.String("string"),
Identifier: pulumi.String("string"),
MaxDurationSeconds: pulumi.Int(0),
Meta: pulumi.String("string"),
RequireSignedUrls: pulumi.Bool(false),
ScheduledDeletion: pulumi.String("string"),
ThumbnailTimestampPct: pulumi.Float64(0),
UploadExpiry: pulumi.String("string"),
})
var streamResource = new Stream("streamResource", StreamArgs.builder()
.accountId("string")
.allowedOrigins("string")
.creator("string")
.identifier("string")
.maxDurationSeconds(0)
.meta("string")
.requireSignedUrls(false)
.scheduledDeletion("string")
.thumbnailTimestampPct(0)
.uploadExpiry("string")
.build());
stream_resource = cloudflare.Stream("streamResource",
account_id="string",
allowed_origins=["string"],
creator="string",
identifier="string",
max_duration_seconds=0,
meta="string",
require_signed_urls=False,
scheduled_deletion="string",
thumbnail_timestamp_pct=0,
upload_expiry="string")
const streamResource = new cloudflare.Stream("streamResource", {
accountId: "string",
allowedOrigins: ["string"],
creator: "string",
identifier: "string",
maxDurationSeconds: 0,
meta: "string",
requireSignedUrls: false,
scheduledDeletion: "string",
thumbnailTimestampPct: 0,
uploadExpiry: "string",
});
type: cloudflare:Stream
properties:
accountId: string
allowedOrigins:
- string
creator: string
identifier: string
maxDurationSeconds: 0
meta: string
requireSignedUrls: false
scheduledDeletion: string
thumbnailTimestampPct: 0
uploadExpiry: string
Stream Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Stream resource accepts the following input properties:
- Account
Id string - The account identifier tag.
- Allowed
Origins 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. - Creator string
- A user-defined identifier for the media creator.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Max
Duration intSeconds - 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.
- Require
Signed boolUrls - 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 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. - Thumbnail
Timestamp doublePct - 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.
- Upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- Account
Id string - The account identifier tag.
- Allowed
Origins []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. - Creator string
- A user-defined identifier for the media creator.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Max
Duration intSeconds - 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.
- Require
Signed boolUrls - 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 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. - Thumbnail
Timestamp float64Pct - 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.
- Upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- account
Id String - The account identifier tag.
- allowed
Origins 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. - creator String
- A user-defined identifier for the media creator.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
- max
Duration IntegerSeconds - 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.
- require
Signed BooleanUrls - 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 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. - thumbnail
Timestamp DoublePct - 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.
- upload
Expiry String - The date and time when the video upload URL is no longer valid for direct user uploads.
- account
Id string - The account identifier tag.
- allowed
Origins 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. - creator string
- A user-defined identifier for the media creator.
- identifier string
- A Cloudflare-generated unique identifier for a media item.
- max
Duration numberSeconds - 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.
- require
Signed booleanUrls - 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 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. - thumbnail
Timestamp numberPct - 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.
- upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- account_
id str - The account identifier tag.
- 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. - creator str
- A user-defined identifier for the media creator.
- identifier str
- A Cloudflare-generated unique identifier for a media item.
- max_
duration_ intseconds - 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.
- require_
signed_ boolurls - 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. - thumbnail_
timestamp_ floatpct - 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.
- upload_
expiry str - The date and time when the video upload URL is no longer valid for direct user uploads.
- account
Id String - The account identifier tag.
- allowed
Origins 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. - creator String
- A user-defined identifier for the media creator.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
- max
Duration NumberSeconds - 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.
- require
Signed BooleanUrls - 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 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. - thumbnail
Timestamp NumberPct - 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.
- upload
Expiry String - The date and time when the video upload URL is no longer valid for direct user uploads.
Outputs
All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:
- Created string
- The date and time the media item was created.
- 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Input
Stream
Input - Live
Input string - The live input ID used to upload a video with Stream Live.
- Modified string
- The date and time the media item was last modified.
- Playback
Stream
Playback - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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 stringStream At - 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.
- Size double
- The size of the media item in bytes.
- Status
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Uid string
- A Cloudflare-generated unique identifier for a media item.
- Uploaded string
- The date and time the media item was uploaded.
- Watermark
Stream
Watermark
- Created string
- The date and time the media item was created.
- 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Input
Stream
Input Type - Live
Input string - The live input ID used to upload a video with Stream Live.
- Modified string
- The date and time the media item was last modified.
- Playback
Stream
Playback - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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 stringStream At - 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.
- Size float64
- The size of the media item in bytes.
- Status
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Uid string
- A Cloudflare-generated unique identifier for a media item.
- Uploaded string
- The date and time the media item was uploaded.
- Watermark
Stream
Watermark Type
- created String
- The date and time the media item was created.
- 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. - id String
- The provider-assigned unique ID for this managed resource.
- input
Stream
Input - live
Input String - The live input ID used to upload a video with Stream Live.
- modified String
- The date and time the media item was last modified.
- playback
Stream
Playback - preview String
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To BooleanStream - 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 StringStream At - 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.
- size Double
- The size of the media item in bytes.
- status
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- uid String
- A Cloudflare-generated unique identifier for a media item.
- uploaded String
- The date and time the media item was uploaded.
- watermark
Stream
Watermark
- created string
- The date and time the media item was created.
- 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. - id string
- The provider-assigned unique ID for this managed resource.
- input
Stream
Input - live
Input string - The live input ID used to upload a video with Stream Live.
- modified string
- The date and time the media item was last modified.
- playback
Stream
Playback - preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To booleanStream - 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 stringStream At - 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.
- size number
- The size of the media item in bytes.
- status
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- uid string
- A Cloudflare-generated unique identifier for a media item.
- uploaded string
- The date and time the media item was uploaded.
- watermark
Stream
Watermark
- created str
- The date and time the media item was created.
- 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. - id str
- The provider-assigned unique ID for this managed resource.
- input
Stream
Input - live_
input str - The live input ID used to upload a video with Stream Live.
- modified str
- The date and time the media item was last modified.
- playback
Stream
Playback - preview str
- The video's preview page URI. This field is omitted until encoding is complete.
- ready_
to_ boolstream - 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_ strstream_ at - 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.
- size float
- The size of the media item in bytes.
- status
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail str
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- uid str
- A Cloudflare-generated unique identifier for a media item.
- uploaded str
- The date and time the media item was uploaded.
- watermark
Stream
Watermark
- created String
- The date and time the media item was created.
- 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. - id String
- The provider-assigned unique ID for this managed resource.
- input Property Map
- live
Input String - The live input ID used to upload a video with Stream Live.
- 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.
- ready
To BooleanStream - 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 StringStream At - 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.
- size Number
- The size of the media item in bytes.
- status Property Map
- Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- uid String
- A Cloudflare-generated unique identifier for a media item.
- uploaded String
- The date and time the media item was uploaded.
- watermark Property Map
Look up Existing Stream Resource
Get an existing Stream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: StreamState, opts?: CustomResourceOptions): Stream
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
allowed_origins: Optional[Sequence[str]] = None,
created: Optional[str] = None,
creator: Optional[str] = None,
duration: Optional[float] = None,
identifier: Optional[str] = None,
input: Optional[StreamInputArgs] = None,
live_input: Optional[str] = None,
max_duration_seconds: Optional[int] = None,
meta: Optional[str] = None,
modified: Optional[str] = None,
playback: Optional[StreamPlaybackArgs] = None,
preview: Optional[str] = None,
ready_to_stream: Optional[bool] = None,
ready_to_stream_at: Optional[str] = None,
require_signed_urls: Optional[bool] = None,
scheduled_deletion: Optional[str] = None,
size: Optional[float] = None,
status: Optional[StreamStatusArgs] = None,
thumbnail: Optional[str] = None,
thumbnail_timestamp_pct: Optional[float] = None,
uid: Optional[str] = None,
upload_expiry: Optional[str] = None,
uploaded: Optional[str] = None,
watermark: Optional[StreamWatermarkArgs] = None) -> Stream
func GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)
public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)
public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)
resources: _: type: cloudflare:Stream get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - The account identifier tag.
- Allowed
Origins 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. - Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Input
Stream
Input - Live
Input string - The live input ID used to upload a video with Stream Live.
- Max
Duration intSeconds - 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
Stream
Playback - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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 stringStream At - 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 boolUrls - 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 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
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Thumbnail
Timestamp doublePct - 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.
- Upload
Expiry 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
Stream
Watermark
- Account
Id string - The account identifier tag.
- Allowed
Origins []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. - Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Input
Stream
Input Type Args - Live
Input string - The live input ID used to upload a video with Stream Live.
- Max
Duration intSeconds - 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
Stream
Playback Args - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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 stringStream At - 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 boolUrls - 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 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
Stream
Status Args - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Thumbnail
Timestamp float64Pct - 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.
- Upload
Expiry 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
Stream
Watermark Type Args
- account
Id String - The account identifier tag.
- allowed
Origins 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. - identifier String
- A Cloudflare-generated unique identifier for a media item.
- input
Stream
Input - live
Input String - The live input ID used to upload a video with Stream Live.
- max
Duration IntegerSeconds - 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
Stream
Playback - preview String
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To BooleanStream - 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 StringStream At - 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 BooleanUrls - 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 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
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp DoublePct - 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.
- upload
Expiry 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
Stream
Watermark
- account
Id string - The account identifier tag.
- allowed
Origins 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. - identifier string
- A Cloudflare-generated unique identifier for a media item.
- input
Stream
Input - live
Input string - The live input ID used to upload a video with Stream Live.
- max
Duration numberSeconds - 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
Stream
Playback - preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To booleanStream - 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 stringStream At - 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 booleanUrls - 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 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
Stream
Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp numberPct - 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.
- upload
Expiry 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
Stream
Watermark
- account_
id str - The account identifier tag.
- 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. - identifier str
- A Cloudflare-generated unique identifier for a media item.
- input
Stream
Input Args - live_
input str - The live input ID used to upload a video with Stream Live.
- max_
duration_ intseconds - 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
Stream
Playback Args - preview str
- The video's preview page URI. This field is omitted until encoding is complete.
- ready_
to_ boolstream - 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_ strstream_ at - 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_ boolurls - 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
Stream
Status Args - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail str
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail_
timestamp_ floatpct - 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
Stream
Watermark Args
- account
Id String - The account identifier tag.
- allowed
Origins 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. - identifier String
- A Cloudflare-generated unique identifier for a media item.
- input Property Map
- live
Input String - The live input ID used to upload a video with Stream Live.
- max
Duration NumberSeconds - 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.
- ready
To BooleanStream - 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 StringStream At - 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 BooleanUrls - 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 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
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp NumberPct - 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.
- upload
Expiry 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
Supporting Types
StreamInput, StreamInputArgs
- 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.
StreamPlayback, StreamPlaybackArgs
StreamStatus, StreamStatusArgs
- Error
Reason stringCode - 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 stringText - 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 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 stringCode - 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 stringText - 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 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 StringCode - 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 StringText - 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 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 stringCode - 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 stringText - 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 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_ strcode - 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_ strtext - 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".
- error
Reason StringCode - 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 StringText - 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 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".
StreamWatermark, StreamWatermarkArgs
- Created string
- The date and a time a watermark profile was created.
- Downloaded
From 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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.
- Downloaded
From 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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.
- downloaded
From 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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.
- downloaded
From 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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.
- downloaded
From 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, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.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, and1.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
, andcenter
. Note thatcenter
ignores thepadding
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), and1.0
fills 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.