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

cloudflare.ShareRecipient

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 = new cloudflare.ShareRecipient("example_share_recipient", {
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    shareId: "3fd85f74b32742f1bff64a85009dda07",
    organizationId: "023e105f4ecef8ad9ca31a8372d0c353",
    recipientAccountId: "023e105f4ecef8ad9ca31a8372d0c353",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_share_recipient = cloudflare.ShareRecipient("example_share_recipient",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    share_id="3fd85f74b32742f1bff64a85009dda07",
    organization_id="023e105f4ecef8ad9ca31a8372d0c353",
    recipient_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.NewShareRecipient(ctx, "example_share_recipient", &cloudflare.ShareRecipientArgs{
			AccountId:          pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			ShareId:            pulumi.String("3fd85f74b32742f1bff64a85009dda07"),
			OrganizationId:     pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			RecipientAccountId: 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 exampleShareRecipient = new Cloudflare.ShareRecipient("example_share_recipient", new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ShareId = "3fd85f74b32742f1bff64a85009dda07",
        OrganizationId = "023e105f4ecef8ad9ca31a8372d0c353",
        RecipientAccountId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.ShareRecipient;
import com.pulumi.cloudflare.ShareRecipientArgs;
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) {
        var exampleShareRecipient = new ShareRecipient("exampleShareRecipient", ShareRecipientArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .shareId("3fd85f74b32742f1bff64a85009dda07")
            .organizationId("023e105f4ecef8ad9ca31a8372d0c353")
            .recipientAccountId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

    resources:
  exampleShareRecipient:
    type: cloudflare:ShareRecipient
    name: example_share_recipient
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      shareId: 3fd85f74b32742f1bff64a85009dda07
      organizationId: 023e105f4ecef8ad9ca31a8372d0c353
      recipientAccountId: 023e105f4ecef8ad9ca31a8372d0c353

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

resource "cloudflare_sharerecipient" "example_share_recipient" {
  account_id           = "023e105f4ecef8ad9ca31a8372d0c353"
  share_id             = "3fd85f74b32742f1bff64a85009dda07"
  organization_id      = "023e105f4ecef8ad9ca31a8372d0c353"
  recipient_account_id = "023e105f4ecef8ad9ca31a8372d0c353"
}

    Create ShareRecipient Resource

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

    Constructor syntax

    new ShareRecipient(name: string, args: ShareRecipientArgs, opts?: CustomResourceOptions);
    @overload
def ShareRecipient(resource_name: str,
                   args: ShareRecipientInitArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ShareRecipient(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   account_id: Optional[str] = None,
                   share_id: Optional[str] = None,
                   organization_id: Optional[str] = None,
                   recipient_account_id: Optional[str] = None)
    func NewShareRecipient(ctx *Context, name string, args ShareRecipientArgs, opts ...ResourceOption) (*ShareRecipient, error)
    public ShareRecipient(string name, ShareRecipientArgs args, CustomResourceOptions? opts = null)
    public ShareRecipient(String name, ShareRecipientArgs args)
public ShareRecipient(String name, ShareRecipientArgs args, CustomResourceOptions options)

    type: cloudflare:ShareRecipient
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "cloudflare_share_recipient" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ShareRecipientArgs
    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 ShareRecipientInitArgs
    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 ShareRecipientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShareRecipientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShareRecipientArgs
    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 shareRecipientResource = new Cloudflare.ShareRecipient("shareRecipientResource", new()
{
    AccountId = "string",
    ShareId = "string",
    OrganizationId = "string",
    RecipientAccountId = "string",
});

    example, err := cloudflare.NewShareRecipient(ctx, "shareRecipientResource", &cloudflare.ShareRecipientArgs{
	AccountId:          pulumi.String("string"),
	ShareId:            pulumi.String("string"),
	OrganizationId:     pulumi.String("string"),
	RecipientAccountId: pulumi.String("string"),
})

    resource "cloudflare_share_recipient" "shareRecipientResource" {
  lifecycle {
    create_before_destroy = true
  }
  account_id           = "string"
  share_id             = "string"
  organization_id      = "string"
  recipient_account_id = "string"
}

    var shareRecipientResource = new ShareRecipient("shareRecipientResource", ShareRecipientArgs.builder()
    .accountId("string")
    .shareId("string")
    .organizationId("string")
    .recipientAccountId("string")
    .build());

    share_recipient_resource = cloudflare.ShareRecipient("shareRecipientResource",
    account_id="string",
    share_id="string",
    organization_id="string",
    recipient_account_id="string")

    const shareRecipientResource = new cloudflare.ShareRecipient("shareRecipientResource", {
    accountId: "string",
    shareId: "string",
    organizationId: "string",
    recipientAccountId: "string",
});

    type: cloudflare:ShareRecipient
properties:
    accountId: string
    organizationId: string
    recipientAccountId: string
    shareId: string

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

    AccountId string
    Account identifier.
    ShareId string
    Share identifier tag.
    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    AccountId string
    Account identifier.
    ShareId string
    Share identifier tag.
    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    account_id string
    Account identifier.
    share_id string
    Share identifier tag.
    organization_id string
    Organization identifier.
    recipient_account_id string
    The account that will receive the share.
    accountId String
    Account identifier.
    shareId String
    Share identifier tag.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.
    accountId string
    Account identifier.
    shareId string
    Share identifier tag.
    organizationId string
    Organization identifier.
    recipientAccountId string
    The account that will receive the share.
    account_id str
    Account identifier.
    share_id str
    Share identifier tag.
    organization_id str
    Organization identifier.
    recipient_account_id str
    The account that will receive the share.
    accountId String
    Account identifier.
    shareId String
    Share identifier tag.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.

    Outputs

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

    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    When the share was modified.
    Resources List<ShareRecipientResource>
    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    When the share was modified.
    Resources []ShareRecipientResource
    association_status string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created string
    When the share was created.
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    When the share was modified.
    resources list(object)
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    When the share was modified.
    resources List<ShareRecipientResource>
    associationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created string
    When the share was created.
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    When the share was modified.
    resources ShareRecipientResource[]
    association_status str
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created str
    When the share was created.
    id str
    The provider-assigned unique ID for this managed resource.
    modified str
    When the share was modified.
    resources Sequence[ShareRecipientResource]
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    When the share was modified.
    resources List<Property Map>

    Look up Existing ShareRecipient Resource

    Get an existing ShareRecipient 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?: ShareRecipientState, opts?: CustomResourceOptions): ShareRecipient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        association_status: Optional[str] = None,
        created: Optional[str] = None,
        modified: Optional[str] = None,
        organization_id: Optional[str] = None,
        recipient_account_id: Optional[str] = None,
        resources: Optional[Sequence[ShareRecipientResourceArgs]] = None,
        share_id: Optional[str] = None) -> ShareRecipient
    func GetShareRecipient(ctx *Context, name string, id IDInput, state *ShareRecipientState, opts ...ResourceOption) (*ShareRecipient, error)
    public static ShareRecipient Get(string name, Input<string> id, ShareRecipientState? state, CustomResourceOptions? opts = null)
    public static ShareRecipient get(String name, Output<String> id, ShareRecipientState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:ShareRecipient    get:      id: ${id}
    import {
  to = cloudflare_share_recipient.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
    Account identifier.
    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Modified string
    When the share was modified.
    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    Resources List<ShareRecipientResource>
    ShareId string
    Share identifier tag.
    AccountId string
    Account identifier.
    AssociationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    Created string
    When the share was created.
    Modified string
    When the share was modified.
    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    Resources []ShareRecipientResourceArgs
    ShareId string
    Share identifier tag.
    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.
    modified string
    When the share was modified.
    organization_id string
    Organization identifier.
    recipient_account_id string
    The account that will receive the share.
    resources list(object)
    share_id string
    Share identifier tag.
    accountId String
    Account identifier.
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    modified String
    When the share was modified.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.
    resources List<ShareRecipientResource>
    shareId String
    Share identifier tag.
    accountId string
    Account identifier.
    associationStatus string
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created string
    When the share was created.
    modified string
    When the share was modified.
    organizationId string
    Organization identifier.
    recipientAccountId string
    The account that will receive the share.
    resources ShareRecipientResource[]
    shareId string
    Share identifier tag.
    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.
    modified str
    When the share was modified.
    organization_id str
    Organization identifier.
    recipient_account_id str
    The account that will receive the share.
    resources Sequence[ShareRecipientResourceArgs]
    share_id str
    Share identifier tag.
    accountId String
    Account identifier.
    associationStatus String
    Share Recipient association status. Available values: "associating", "associated", "disassociating", "disassociated".
    created String
    When the share was created.
    modified String
    When the share was modified.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.
    resources List<Property Map>
    shareId String
    Share identifier tag.

    Supporting Types

    ShareRecipientResource, ShareRecipientResourceArgs

    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.

    Import

    $ pulumi import cloudflare:index/shareRecipient:ShareRecipient example '<account_id>/<share_id>/<recipient_id>'

    To learn more about importing existing cloud resources, see Importing resources.

    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