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

cloudflare.getShareRecipient

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 exampleShareRecipient = cloudflare.getShareRecipient({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    shareId: "3fd85f74b32742f1bff64a85009dda07",
    recipientId: "3fd85f74b32742f1bff64a85009dda07",
    includeResources: true,
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_share_recipient = cloudflare.get_share_recipient(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    share_id="3fd85f74b32742f1bff64a85009dda07",
    recipient_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.GetShareRecipient(ctx, &cloudflare.LookupShareRecipientArgs{
			AccountId:        "023e105f4ecef8ad9ca31a8372d0c353",
			ShareId:          "3fd85f74b32742f1bff64a85009dda07",
			RecipientId:      "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 exampleShareRecipient = Cloudflare.GetShareRecipient.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ShareId = "3fd85f74b32742f1bff64a85009dda07",
        RecipientId = "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.GetShareRecipientArgs;
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 exampleShareRecipient = CloudflareFunctions.getShareRecipient(GetShareRecipientArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .shareId("3fd85f74b32742f1bff64a85009dda07")
            .recipientId("3fd85f74b32742f1bff64a85009dda07")
            .includeResources(true)
            .build());

    }
}

    variables:
  exampleShareRecipient:
    fn::invoke:
      function: cloudflare:getShareRecipient
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        shareId: 3fd85f74b32742f1bff64a85009dda07
        recipientId: 3fd85f74b32742f1bff64a85009dda07
        includeResources: true

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

data "cloudflare_getsharerecipient" "exampleShareRecipient" {
  account_id        = "023e105f4ecef8ad9ca31a8372d0c353"
  share_id          = "3fd85f74b32742f1bff64a85009dda07"
  recipient_id      = "3fd85f74b32742f1bff64a85009dda07"
  include_resources = true
}

    Using getShareRecipient

    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 getShareRecipient(args: GetShareRecipientArgs, opts?: InvokeOptions): Promise<GetShareRecipientResult>
function getShareRecipientOutput(args: GetShareRecipientOutputArgs, opts?: InvokeOptions): Output<GetShareRecipientResult>
    def get_share_recipient(account_id: Optional[str] = None,
                        include_resources: Optional[bool] = None,
                        recipient_id: Optional[str] = None,
                        share_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetShareRecipientResult
def get_share_recipient_output(account_id: pulumi.Input[Optional[str]] = None,
                        include_resources: pulumi.Input[Optional[bool]] = None,
                        recipient_id: pulumi.Input[Optional[str]] = None,
                        share_id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetShareRecipientResult]
    func LookupShareRecipient(ctx *Context, args *LookupShareRecipientArgs, opts ...InvokeOption) (*LookupShareRecipientResult, error)
func LookupShareRecipientOutput(ctx *Context, args *LookupShareRecipientOutputArgs, opts ...InvokeOption) LookupShareRecipientResultOutput

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

    public static class GetShareRecipient 
{
    public static Task<GetShareRecipientResult> InvokeAsync(GetShareRecipientArgs args, InvokeOptions? opts = null)
    public static Output<GetShareRecipientResult> Invoke(GetShareRecipientInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShareRecipientResult> getShareRecipient(GetShareRecipientArgs args, InvokeOptions options)
public static Output<GetShareRecipientResult> getShareRecipient(GetShareRecipientArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getShareRecipient:getShareRecipient
  arguments:
    # arguments dictionary
    data "cloudflare_get_share_recipient" "name" {
    # arguments
}

    The following arguments are supported:

    AccountId string
    Account identifier.
    RecipientId string
    Share Recipient identifier tag.
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    AccountId string
    Account identifier.
    RecipientId string
    Share Recipient identifier tag.
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    account_id string
    Account identifier.
    recipient_id string
    Share Recipient identifier tag.
    share_id string
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    accountId String
    Account identifier.
    recipientId String
    Share Recipient identifier tag.
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    accountId string
    Account identifier.
    recipientId string
    Share Recipient identifier tag.
    shareId string
    Share identifier tag.
    includeResources boolean
    Include resources in the response.
    account_id str
    Account identifier.
    recipient_id str
    Share Recipient identifier tag.
    share_id str
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    accountId String
    Account identifier.
    recipientId String
    Share Recipient identifier tag.
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.

    getShareRecipient Result

    The following output properties are available:

    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.
    RecipientId string
    Share Recipient identifier tag.
    Resources List<GetShareRecipientResource>
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    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.
    RecipientId string
    Share Recipient identifier tag.
    Resources []GetShareRecipientResource
    ShareId string
    Share identifier tag.
    IncludeResources bool
    Include resources in the response.
    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.
    recipient_id string
    Share Recipient identifier tag.
    resources list(object)
    share_id string
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    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.
    recipientId String
    Share Recipient identifier tag.
    resources List<GetShareRecipientResource>
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.
    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.
    recipientId string
    Share Recipient identifier tag.
    resources GetShareRecipientResource[]
    shareId string
    Share identifier tag.
    includeResources boolean
    Include resources in the response.
    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.
    recipient_id str
    Share Recipient identifier tag.
    resources Sequence[GetShareRecipientResource]
    share_id str
    Share identifier tag.
    include_resources bool
    Include resources in the response.
    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.
    recipientId String
    Share Recipient identifier tag.
    resources List<Property Map>
    shareId String
    Share identifier tag.
    includeResources Boolean
    Include resources in the response.

    Supporting Types

    GetShareRecipientResource

    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