1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. MoqRelay
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
cloudflare logo
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi

    Import

    $ pulumi import cloudflare:index/moqRelay:MoqRelay example '<account_id>/<relay_id>'
    

    Create MoqRelay Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MoqRelay(name: string, args: MoqRelayArgs, opts?: CustomResourceOptions);
    @overload
    def MoqRelay(resource_name: str,
                 args: MoqRelayArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def MoqRelay(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_id: Optional[str] = None,
                 name: Optional[str] = None,
                 config: Optional[MoqRelayConfigArgs] = None)
    func NewMoqRelay(ctx *Context, name string, args MoqRelayArgs, opts ...ResourceOption) (*MoqRelay, error)
    public MoqRelay(string name, MoqRelayArgs args, CustomResourceOptions? opts = null)
    public MoqRelay(String name, MoqRelayArgs args)
    public MoqRelay(String name, MoqRelayArgs args, CustomResourceOptions options)
    
    type: cloudflare:MoqRelay
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "cloudflare_moq_relay" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MoqRelayArgs
    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 MoqRelayArgs
    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 MoqRelayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MoqRelayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MoqRelayArgs
    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 moqRelayResource = new Cloudflare.MoqRelay("moqRelayResource", new()
    {
        AccountId = "string",
        Name = "string",
        Config = new Cloudflare.Inputs.MoqRelayConfigArgs
        {
            LingeringSubscribe = new Cloudflare.Inputs.MoqRelayConfigLingeringSubscribeArgs
            {
                Enabled = false,
                MaxTimeoutMs = 0,
            },
            Upstreams = new Cloudflare.Inputs.MoqRelayConfigUpstreamsArgs
            {
                Enabled = false,
                Upstreams = new[]
                {
                    new Cloudflare.Inputs.MoqRelayConfigUpstreamsUpstreamArgs
                    {
                        Url = "string",
                    },
                },
            },
        },
    });
    
    example, err := cloudflare.NewMoqRelay(ctx, "moqRelayResource", &cloudflare.MoqRelayArgs{
    	AccountId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Config: &cloudflare.MoqRelayConfigArgs{
    		LingeringSubscribe: &cloudflare.MoqRelayConfigLingeringSubscribeArgs{
    			Enabled:      pulumi.Bool(false),
    			MaxTimeoutMs: pulumi.Int(0),
    		},
    		Upstreams: &cloudflare.MoqRelayConfigUpstreamsArgs{
    			Enabled: pulumi.Bool(false),
    			Upstreams: cloudflare.MoqRelayConfigUpstreamsUpstreamArray{
    				&cloudflare.MoqRelayConfigUpstreamsUpstreamArgs{
    					Url: pulumi.String("string"),
    				},
    			},
    		},
    	},
    })
    
    resource "cloudflare_moq_relay" "moqRelayResource" {
      lifecycle {
        create_before_destroy = true
      }
      account_id = "string"
      name       = "string"
      config = {
        lingering_subscribe = {
          enabled        = false
          max_timeout_ms = 0
        }
        upstreams = {
          enabled = false
          upstreams = [{
            url = "string"
          }]
        }
      }
    }
    
    var moqRelayResource = new MoqRelay("moqRelayResource", MoqRelayArgs.builder()
        .accountId("string")
        .name("string")
        .config(MoqRelayConfigArgs.builder()
            .lingeringSubscribe(MoqRelayConfigLingeringSubscribeArgs.builder()
                .enabled(false)
                .maxTimeoutMs(0)
                .build())
            .upstreams(MoqRelayConfigUpstreamsArgs.builder()
                .enabled(false)
                .upstreams(MoqRelayConfigUpstreamsUpstreamArgs.builder()
                    .url("string")
                    .build())
                .build())
            .build())
        .build());
    
    moq_relay_resource = cloudflare.MoqRelay("moqRelayResource",
        account_id="string",
        name="string",
        config={
            "lingering_subscribe": {
                "enabled": False,
                "max_timeout_ms": 0,
            },
            "upstreams": {
                "enabled": False,
                "upstreams": [{
                    "url": "string",
                }],
            },
        })
    
    const moqRelayResource = new cloudflare.MoqRelay("moqRelayResource", {
        accountId: "string",
        name: "string",
        config: {
            lingeringSubscribe: {
                enabled: false,
                maxTimeoutMs: 0,
            },
            upstreams: {
                enabled: false,
                upstreams: [{
                    url: "string",
                }],
            },
        },
    });
    
    type: cloudflare:MoqRelay
    properties:
        accountId: string
        config:
            lingeringSubscribe:
                enabled: false
                maxTimeoutMs: 0
            upstreams:
                enabled: false
                upstreams:
                    - url: string
        name: string
    

    MoqRelay 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 MoqRelay resource accepts the following input properties:

    AccountId string
    Cloudflare account identifier.
    Name string
    Human-readable name for the relay.
    Config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    AccountId string
    Cloudflare account identifier.
    Name string
    Human-readable name for the relay.
    Config MoqRelayConfigArgs
    upstreams and lingeringSubscribe are mutually exclusive.
    account_id string
    Cloudflare account identifier.
    name string
    Human-readable name for the relay.
    config object
    upstreams and lingeringSubscribe are mutually exclusive.
    accountId String
    Cloudflare account identifier.
    name String
    Human-readable name for the relay.
    config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    accountId string
    Cloudflare account identifier.
    name string
    Human-readable name for the relay.
    config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    account_id str
    Cloudflare account identifier.
    name str
    Human-readable name for the relay.
    config MoqRelayConfigArgs
    upstreams and lingeringSubscribe are mutually exclusive.
    accountId String
    Cloudflare account identifier.
    name String
    Human-readable name for the relay.
    config Property Map
    upstreams and lingeringSubscribe are mutually exclusive.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MoqRelay resource produces the following output properties:

    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    Status string
    "connected" when active, omitted otherwise. Available values: "connected".
    TokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    TokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    Uid string
    Server-generated unique identifier (32 hex chars).
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    Status string
    "connected" when active, omitted otherwise. Available values: "connected".
    TokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    TokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    Uid string
    Server-generated unique identifier (32 hex chars).
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    status string
    "connected" when active, omitted otherwise. Available values: "connected".
    token_publish_subscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    token_subscribe string
    Subscribe-only token. Treat as sensitive.
    uid string
    Server-generated unique identifier (32 hex chars).
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    status String
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe String
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe String
    Subscribe-only token. Treat as sensitive.
    uid String
    Server-generated unique identifier (32 hex chars).
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    status string
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    uid string
    Server-generated unique identifier (32 hex chars).
    created str
    id str
    The provider-assigned unique ID for this managed resource.
    modified str
    status str
    "connected" when active, omitted otherwise. Available values: "connected".
    token_publish_subscribe str
    Full access token (publish + subscribe). Treat as sensitive.
    token_subscribe str
    Subscribe-only token. Treat as sensitive.
    uid str
    Server-generated unique identifier (32 hex chars).
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    status String
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe String
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe String
    Subscribe-only token. Treat as sensitive.
    uid String
    Server-generated unique identifier (32 hex chars).

    Look up Existing MoqRelay Resource

    Get an existing MoqRelay 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?: MoqRelayState, opts?: CustomResourceOptions): MoqRelay
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            config: Optional[MoqRelayConfigArgs] = None,
            created: Optional[str] = None,
            modified: Optional[str] = None,
            name: Optional[str] = None,
            status: Optional[str] = None,
            token_publish_subscribe: Optional[str] = None,
            token_subscribe: Optional[str] = None,
            uid: Optional[str] = None) -> MoqRelay
    func GetMoqRelay(ctx *Context, name string, id IDInput, state *MoqRelayState, opts ...ResourceOption) (*MoqRelay, error)
    public static MoqRelay Get(string name, Input<string> id, MoqRelayState? state, CustomResourceOptions? opts = null)
    public static MoqRelay get(String name, Output<String> id, MoqRelayState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:MoqRelay    get:      id: ${id}
    import {
      to = cloudflare_moq_relay.example
      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.
    The following state arguments are supported:
    AccountId string
    Cloudflare account identifier.
    Config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    Created string
    Modified string
    Name string
    Human-readable name for the relay.
    Status string
    "connected" when active, omitted otherwise. Available values: "connected".
    TokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    TokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    Uid string
    Server-generated unique identifier (32 hex chars).
    AccountId string
    Cloudflare account identifier.
    Config MoqRelayConfigArgs
    upstreams and lingeringSubscribe are mutually exclusive.
    Created string
    Modified string
    Name string
    Human-readable name for the relay.
    Status string
    "connected" when active, omitted otherwise. Available values: "connected".
    TokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    TokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    Uid string
    Server-generated unique identifier (32 hex chars).
    account_id string
    Cloudflare account identifier.
    config object
    upstreams and lingeringSubscribe are mutually exclusive.
    created string
    modified string
    name string
    Human-readable name for the relay.
    status string
    "connected" when active, omitted otherwise. Available values: "connected".
    token_publish_subscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    token_subscribe string
    Subscribe-only token. Treat as sensitive.
    uid string
    Server-generated unique identifier (32 hex chars).
    accountId String
    Cloudflare account identifier.
    config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    created String
    modified String
    name String
    Human-readable name for the relay.
    status String
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe String
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe String
    Subscribe-only token. Treat as sensitive.
    uid String
    Server-generated unique identifier (32 hex chars).
    accountId string
    Cloudflare account identifier.
    config MoqRelayConfig
    upstreams and lingeringSubscribe are mutually exclusive.
    created string
    modified string
    name string
    Human-readable name for the relay.
    status string
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe string
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe string
    Subscribe-only token. Treat as sensitive.
    uid string
    Server-generated unique identifier (32 hex chars).
    account_id str
    Cloudflare account identifier.
    config MoqRelayConfigArgs
    upstreams and lingeringSubscribe are mutually exclusive.
    created str
    modified str
    name str
    Human-readable name for the relay.
    status str
    "connected" when active, omitted otherwise. Available values: "connected".
    token_publish_subscribe str
    Full access token (publish + subscribe). Treat as sensitive.
    token_subscribe str
    Subscribe-only token. Treat as sensitive.
    uid str
    Server-generated unique identifier (32 hex chars).
    accountId String
    Cloudflare account identifier.
    config Property Map
    upstreams and lingeringSubscribe are mutually exclusive.
    created String
    modified String
    name String
    Human-readable name for the relay.
    status String
    "connected" when active, omitted otherwise. Available values: "connected".
    tokenPublishSubscribe String
    Full access token (publish + subscribe). Treat as sensitive.
    tokenSubscribe String
    Subscribe-only token. Treat as sensitive.
    uid String
    Server-generated unique identifier (32 hex chars).

    Supporting Types

    MoqRelayConfig, MoqRelayConfigArgs

    LingeringSubscribe MoqRelayConfigLingeringSubscribe
    Upstreams MoqRelayConfigUpstreams
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    LingeringSubscribe MoqRelayConfigLingeringSubscribe
    Upstreams MoqRelayConfigUpstreams
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    lingering_subscribe object
    upstreams object
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    lingeringSubscribe MoqRelayConfigLingeringSubscribe
    upstreams MoqRelayConfigUpstreams
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    lingeringSubscribe MoqRelayConfigLingeringSubscribe
    upstreams MoqRelayConfigUpstreams
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    lingering_subscribe MoqRelayConfigLingeringSubscribe
    upstreams MoqRelayConfigUpstreams
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.
    lingeringSubscribe Property Map
    upstreams Property Map
    Upstreams are external MOQT server publishers that a relay falls back to when it has no local publisher for a requested namespace/track.

    MoqRelayConfigLingeringSubscribe, MoqRelayConfigLingeringSubscribeArgs

    Enabled bool
    MaxTimeoutMs int
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    Enabled bool
    MaxTimeoutMs int
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    enabled bool
    max_timeout_ms number
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    enabled Boolean
    maxTimeoutMs Integer
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    enabled boolean
    maxTimeoutMs number
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    enabled bool
    max_timeout_ms int
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.
    enabled Boolean
    maxTimeoutMs Number
    Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

    MoqRelayConfigUpstreams, MoqRelayConfigUpstreamsArgs

    Enabled bool
    Upstreams List<MoqRelayConfigUpstreamsUpstream>
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    Enabled bool
    Upstreams []MoqRelayConfigUpstreamsUpstream
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    enabled bool
    upstreams list(object)
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    enabled Boolean
    upstreams List<MoqRelayConfigUpstreamsUpstream>
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    enabled boolean
    upstreams MoqRelayConfigUpstreamsUpstream[]
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    enabled bool
    upstreams Sequence[MoqRelayConfigUpstreamsUpstream]
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.
    enabled Boolean
    upstreams List<Property Map>
    Ordered list of upstream MOQT server publishers. Each entry is an object (not a bare string) so per-upstream configuration can be added in the future without another breaking change.

    MoqRelayConfigUpstreamsUpstream, MoqRelayConfigUpstreamsUpstreamArgs

    Url string
    Upstream MOQT server publisher URL.
    Url string
    Upstream MOQT server publisher URL.
    url string
    Upstream MOQT server publisher URL.
    url String
    Upstream MOQT server publisher URL.
    url string
    Upstream MOQT server publisher URL.
    url str
    Upstream MOQT server publisher URL.
    url String
    Upstream MOQT server publisher URL.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.18.0
    published on Thursday, Jul 16, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial