1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getStreamWatermarks
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getStreamWatermarks

Explore with Pulumi AI

cloudflare logo
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 exampleStreamWatermarks = cloudflare.getStreamWatermarks({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_stream_watermarks = cloudflare.get_stream_watermarks(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.LookupStreamWatermarks(ctx, &cloudflare.LookupStreamWatermarksArgs{
    			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
    		}, 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 exampleStreamWatermarks = Cloudflare.GetStreamWatermarks.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    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.GetStreamWatermarksArgs;
    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 exampleStreamWatermarks = CloudflareFunctions.getStreamWatermarks(GetStreamWatermarksArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleStreamWatermarks:
        fn::invoke:
          function: cloudflare:getStreamWatermarks
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getStreamWatermarks

    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 getStreamWatermarks(args: GetStreamWatermarksArgs, opts?: InvokeOptions): Promise<GetStreamWatermarksResult>
    function getStreamWatermarksOutput(args: GetStreamWatermarksOutputArgs, opts?: InvokeOptions): Output<GetStreamWatermarksResult>
    def get_stream_watermarks(account_id: Optional[str] = None,
                              max_items: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetStreamWatermarksResult
    def get_stream_watermarks_output(account_id: Optional[pulumi.Input[str]] = None,
                              max_items: Optional[pulumi.Input[int]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetStreamWatermarksResult]
    func LookupStreamWatermarks(ctx *Context, args *LookupStreamWatermarksArgs, opts ...InvokeOption) (*LookupStreamWatermarksResult, error)
    func LookupStreamWatermarksOutput(ctx *Context, args *LookupStreamWatermarksOutputArgs, opts ...InvokeOption) LookupStreamWatermarksResultOutput

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

    public static class GetStreamWatermarks 
    {
        public static Task<GetStreamWatermarksResult> InvokeAsync(GetStreamWatermarksArgs args, InvokeOptions? opts = null)
        public static Output<GetStreamWatermarksResult> Invoke(GetStreamWatermarksInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStreamWatermarksResult> getStreamWatermarks(GetStreamWatermarksArgs args, InvokeOptions options)
    public static Output<GetStreamWatermarksResult> getStreamWatermarks(GetStreamWatermarksArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getStreamWatermarks:getStreamWatermarks
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    The account identifier tag.
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    The account identifier tag.
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    The account identifier tag.
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    The account identifier tag.
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    The account identifier tag.
    max_items int
    Max items to fetch, default: 1000
    accountId String
    The account identifier tag.
    maxItems Number
    Max items to fetch, default: 1000

    getStreamWatermarks Result

    The following output properties are available:

    AccountId string
    The account identifier tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetStreamWatermarksResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    The account identifier tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetStreamWatermarksResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    The account identifier tag.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetStreamWatermarksResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    The account identifier tag.
    id string
    The provider-assigned unique ID for this managed resource.
    results GetStreamWatermarksResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    The account identifier tag.
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetStreamWatermarksResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    accountId String
    The account identifier tag.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetStreamWatermarksResult

    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 logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi