Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getShareRecipients
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.getShareRecipients

cloudflare logo
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Example Usage

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

const exampleShareRecipients = cloudflare.getShareRecipients({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    shareId: "3fd85f74b32742f1bff64a85009dda07",
    includeResources: true,
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_share_recipients = cloudflare.get_share_recipients(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    share_id="3fd85f74b32742f1bff64a85009dda07",
    include_resources=True)

    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.GetShareRecipients(ctx, &cloudflare.LookupShareRecipientsArgs{
			AccountId:        "023e105f4ecef8ad9ca31a8372d0c353",
			ShareId:          "3fd85f74b32742f1bff64a85009dda07",
			IncludeResources: pulumi.BoolRef(true),
		}, 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 exampleShareRecipients = Cloudflare.GetShareRecipients.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ShareId = "3fd85f74b32742f1bff64a85009dda07",
        IncludeResources = true,
    });

});

    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.GetShareRecipientsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 exampleShareRecipients = CloudflareFunctions.getShareRecipients(GetShareRecipientsArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .shareId("3fd85f74b32742f1bff64a85009dda07")
            .includeResources(true)
            .build());

    }
}

    variables:
  exampleShareRecipients:
    fn::invoke:
      function: cloudflare:getShareRecipients
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        shareId: 3fd85f74b32742f1bff64a85009dda07
        includeResources: true

    pulumi {
  required_providers {
    cloudflare = {
      source = "pulumi/cloudflare"
    }
  }
}

data "cloudflare_getsharerecipients" "exampleShareRecipients" {
  account_id        = "023e105f4ecef8ad9ca31a8372d0c353"
  share_id          = "3fd85f74b32742f1bff64a85009dda07"
  include_resources = true
}

    Using getShareRecipients

    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 getShareRecipients(args: GetShareRecipientsArgs, opts?: InvokeOptions): Promise<GetShareRecipientsResult>
function getShareRecipientsOutput(args: GetShareRecipientsOutputArgs, opts?: InvokeOptions): Output<GetShareRecipientsResult>
    def get_share_recipients(account_id: Optional[str] = None,
                         include_resources: Optional[bool] = None,
                         max_items: Optional[int] = None,
                         share_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetShareRecipientsResult
def get_share_recipients_output(account_id: pulumi.Input[Optional[str]] = None,
                         include_resources: pulumi.Input[Optional[bool]] = None,
                         max_items: pulumi.Input[Optional[int]] = None,
                         share_id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetShareRecipientsResult]
    func LookupShareRecipients(ctx *Context, args *LookupShareRecipientsArgs, opts ...InvokeOption) (*LookupShareRecipientsResult, error)
func LookupShareRecipientsOutput(ctx *Context, args *LookupShareRecipientsOutputArgs, opts ...InvokeOption) LookupShareRecipientsResultOutput

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

    public static class GetShareRecipients 
{
    public static Task<GetShareRecipientsResult> InvokeAsync(GetShareRecipientsArgs args, InvokeOptions? opts = null)
    public static Output<GetShareRecipientsResult> Invoke(GetShareRecipientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShareRecipientsResult> getShareRecipients(GetShareRecipientsArgs args, InvokeOptions options)
public static Output<GetShareRecipientsResult> getShareRecipients(GetShareRecipientsArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getShareRecipients:getShareRecipients
  arguments:
    # arguments dictionary
    data "cloudflare_get_share_recipients" "name" {
    # arguments
}

    The following arguments are supported:

    AccountId string
    Account identifier.
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Account identifier.
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    MaxItems int
    Max items to fetch, default: 1000
    account_id string
    Account identifier.
    share_id string
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    max_items number
    Max items to fetch, default: 1000
    accountId String
    Account identifier.
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Account identifier.
    shareId string
    Share identifier tag.
    includeResources boolean
    Include resources in the response.
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Account identifier.
    share_id str
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Account identifier.
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    maxItems Number
    Max items to fetch, default: 1000

    getShareRecipients Result

    The following output properties are available:

    AccountId string
    Account identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetShareRecipientsResult>
    The items returned by the data source
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Account identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetShareRecipientsResult
    The items returned by the data source
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    MaxItems int
    Max items to fetch, default: 1000
    account_id string
    Account identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    results list(object)
    The items returned by the data source
    share_id string
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    max_items number
    Max items to fetch, default: 1000
    accountId String
    Account identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetShareRecipientsResult>
    The items returned by the data source
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Account identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    results GetShareRecipientsResult[]
    The items returned by the data source
    shareId string
    Share identifier tag.
    includeResources boolean
    Include resources in the response.
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Account identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetShareRecipientsResult]
    The items returned by the data source
    share_id str
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Account identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetShareRecipientsResult

    AccountId string
    Account identifier.
    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Id string
    Share Recipient identifier tag.
    Modified string
    When the share was modified.
    Resources List<GetShareRecipientsResultResource>
    AccountId string
    Account identifier.
    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Id string
    Share Recipient identifier tag.
    Modified string
    When the share was modified.
    Resources []GetShareRecipientsResultResource
    account_id string
    Account identifier.
    association_status string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created string
    When the share was created.
    id string
    Share Recipient identifier tag.
    modified string
    When the share was modified.
    resources list(object)
    accountId String
    Account identifier.
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    id String
    Share Recipient identifier tag.
    modified String
    When the share was modified.
    resources List<GetShareRecipientsResultResource>
    accountId string
    Account identifier.
    associationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created string
    When the share was created.
    id string
    Share Recipient identifier tag.
    modified string
    When the share was modified.
    resources GetShareRecipientsResultResource[]
    account_id str
    Account identifier.
    association_status str
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created str
    When the share was created.
    id str
    Share Recipient identifier tag.
    modified str
    When the share was modified.
    resources Sequence[GetShareRecipientsResultResource]
    accountId String
    Account identifier.
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    id String
    Share Recipient identifier tag.
    modified String
    When the share was modified.
    resources List<Property Map>

    GetShareRecipientsResultResource

    Error string
    Share Recipient error message.
    ResourceId string
    Share Resource identifier.
    ResourceVersion int
    Resource Version.
    Terminal bool
    Whether the error is terminal or will be continually retried.
    Error string
    Share Recipient error message.
    ResourceId string
    Share Resource identifier.
    ResourceVersion int
    Resource Version.
    Terminal bool
    Whether the error is terminal or will be continually retried.
    error string
    Share Recipient error message.
    resource_id string
    Share Resource identifier.
    resource_version number
    Resource Version.
    terminal bool
    Whether the error is terminal or will be continually retried.
    error String
    Share Recipient error message.
    resourceId String
    Share Resource identifier.
    resourceVersion Integer
    Resource Version.
    terminal Boolean
    Whether the error is terminal or will be continually retried.
    error string
    Share Recipient error message.
    resourceId string
    Share Resource identifier.
    resourceVersion number
    Resource Version.
    terminal boolean
    Whether the error is terminal or will be continually retried.
    error str
    Share Recipient error message.
    resource_id str
    Share Resource identifier.
    resource_version int
    Resource Version.
    terminal bool
    Whether the error is terminal or will be continually retried.
    error String
    Share Recipient error message.
    resourceId String
    Share Resource identifier.
    resourceVersion Number
    Resource Version.
    terminal Boolean
    Whether the error is terminal or will be continually retried.

    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
    Schema (JSON)
    pulumi/pulumi-cloudflare

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial