1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. Share
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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleShare = new cloudflare.Share("example_share", {
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        name: "My Shared WAF Managed Rule",
        recipients: [{
            organizationId: "023e105f4ecef8ad9ca31a8372d0c353",
            recipientAccountId: "023e105f4ecef8ad9ca31a8372d0c353",
        }],
        resources: [{
            meta: {},
            resourceAccountId: "023e105f4ecef8ad9ca31a8372d0c353",
            resourceId: "023e105f4ecef8ad9ca31a8372d0c353",
            resourceType: "custom-ruleset",
        }],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_share = cloudflare.Share("example_share",
        account_id="023e105f4ecef8ad9ca31a8372d0c353",
        name="My Shared WAF Managed Rule",
        recipients=[{
            "organization_id": "023e105f4ecef8ad9ca31a8372d0c353",
            "recipient_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
        }],
        resources=[{
            "meta": {},
            "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
            "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
            "resource_type": "custom-ruleset",
        }])
    
    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.NewShare(ctx, "example_share", &cloudflare.ShareArgs{
    			AccountId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			Name:      pulumi.String("My Shared WAF Managed Rule"),
    			Recipients: cloudflare.ShareRecipientTypeArray{
    				&cloudflare.ShareRecipientTypeArgs{
    					OrganizationId:     pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    					RecipientAccountId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    				},
    			},
    			Resources: cloudflare.ShareResourceTypeArray{
    				&cloudflare.ShareResourceTypeArgs{
    					Meta:              pulumi.String{},
    					ResourceAccountId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    					ResourceId:        pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    					ResourceType:      pulumi.String("custom-ruleset"),
    				},
    			},
    		})
    		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 exampleShare = new Cloudflare.Share("example_share", new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            Name = "My Shared WAF Managed Rule",
            Recipients = new[]
            {
                new Cloudflare.Inputs.ShareRecipientArgs
                {
                    OrganizationId = "023e105f4ecef8ad9ca31a8372d0c353",
                    RecipientAccountId = "023e105f4ecef8ad9ca31a8372d0c353",
                },
            },
            Resources = new[]
            {
                new Cloudflare.Inputs.ShareResourceArgs
                {
                    Meta = null,
                    ResourceAccountId = "023e105f4ecef8ad9ca31a8372d0c353",
                    ResourceId = "023e105f4ecef8ad9ca31a8372d0c353",
                    ResourceType = "custom-ruleset",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.Share;
    import com.pulumi.cloudflare.ShareArgs;
    import com.pulumi.cloudflare.inputs.ShareRecipientArgs;
    import com.pulumi.cloudflare.inputs.ShareResourceArgs;
    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 exampleShare = new Share("exampleShare", ShareArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .name("My Shared WAF Managed Rule")
                .recipients(ShareRecipientArgs.builder()
                    .organizationId("023e105f4ecef8ad9ca31a8372d0c353")
                    .recipientAccountId("023e105f4ecef8ad9ca31a8372d0c353")
                    .build())
                .resources(ShareResourceArgs.builder()
                    .meta(Map.ofEntries(
                    ))
                    .resourceAccountId("023e105f4ecef8ad9ca31a8372d0c353")
                    .resourceId("023e105f4ecef8ad9ca31a8372d0c353")
                    .resourceType("custom-ruleset")
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleShare:
        type: cloudflare:Share
        name: example_share
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          name: My Shared WAF Managed Rule
          recipients:
            - organizationId: 023e105f4ecef8ad9ca31a8372d0c353
              recipientAccountId: 023e105f4ecef8ad9ca31a8372d0c353
          resources:
            - meta: {}
              resourceAccountId: 023e105f4ecef8ad9ca31a8372d0c353
              resourceId: 023e105f4ecef8ad9ca31a8372d0c353
              resourceType: custom-ruleset
    
    pulumi {
      required_providers {
        cloudflare = {
          source = "pulumi/cloudflare"
        }
      }
    }
    
    resource "cloudflare_share" "example_share" {
      account_id = "023e105f4ecef8ad9ca31a8372d0c353"
      name       = "My Shared WAF Managed Rule"
      recipients {
        organization_id      = "023e105f4ecef8ad9ca31a8372d0c353"
        recipient_account_id = "023e105f4ecef8ad9ca31a8372d0c353"
      }
      resources {
        meta                = {}
        resource_account_id = "023e105f4ecef8ad9ca31a8372d0c353"
        resource_id         = "023e105f4ecef8ad9ca31a8372d0c353"
        resource_type       = "custom-ruleset"
      }
    }
    

    Create Share Resource

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

    Constructor syntax

    new Share(name: string, args: ShareArgs, opts?: CustomResourceOptions);
    @overload
    def Share(resource_name: str,
              args: ShareArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Share(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              account_id: Optional[str] = None,
              name: Optional[str] = None,
              recipients: Optional[Sequence[ShareRecipientArgs]] = None,
              resources: Optional[Sequence[ShareResourceArgs]] = None)
    func NewShare(ctx *Context, name string, args ShareArgs, opts ...ResourceOption) (*Share, error)
    public Share(string name, ShareArgs args, CustomResourceOptions? opts = null)
    public Share(String name, ShareArgs args)
    public Share(String name, ShareArgs args, CustomResourceOptions options)
    
    type: cloudflare:Share
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "cloudflare_share" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ShareArgs
    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 ShareArgs
    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 ShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShareArgs
    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 shareResource = new Cloudflare.Share("shareResource", new()
    {
        AccountId = "string",
        Name = "string",
        Recipients = new[]
        {
            new Cloudflare.Inputs.ShareRecipientArgs
            {
                OrganizationId = "string",
                RecipientAccountId = "string",
            },
        },
        Resources = new[]
        {
            new Cloudflare.Inputs.ShareResourceArgs
            {
                Meta = "string",
                ResourceAccountId = "string",
                ResourceId = "string",
                ResourceType = "string",
            },
        },
    });
    
    example, err := cloudflare.NewShare(ctx, "shareResource", &cloudflare.ShareArgs{
    	AccountId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Recipients: cloudflare.ShareRecipientTypeArray{
    		&cloudflare.ShareRecipientTypeArgs{
    			OrganizationId:     pulumi.String("string"),
    			RecipientAccountId: pulumi.String("string"),
    		},
    	},
    	Resources: cloudflare.ShareResourceTypeArray{
    		&cloudflare.ShareResourceTypeArgs{
    			Meta:              pulumi.String("string"),
    			ResourceAccountId: pulumi.String("string"),
    			ResourceId:        pulumi.String("string"),
    			ResourceType:      pulumi.String("string"),
    		},
    	},
    })
    
    resource "cloudflare_share" "shareResource" {
      lifecycle {
        create_before_destroy = true
      }
      account_id = "string"
      name       = "string"
      recipients {
        organization_id      = "string"
        recipient_account_id = "string"
      }
      resources {
        meta                = "string"
        resource_account_id = "string"
        resource_id         = "string"
        resource_type       = "string"
      }
    }
    
    var shareResource = new Share("shareResource", ShareArgs.builder()
        .accountId("string")
        .name("string")
        .recipients(com.pulumi.cloudflare.inputs.ShareRecipientArgs.builder()
            .organizationId("string")
            .recipientAccountId("string")
            .build())
        .resources(com.pulumi.cloudflare.inputs.ShareResourceArgs.builder()
            .meta("string")
            .resourceAccountId("string")
            .resourceId("string")
            .resourceType("string")
            .build())
        .build());
    
    share_resource = cloudflare.Share("shareResource",
        account_id="string",
        name="string",
        recipients=[{
            "organization_id": "string",
            "recipient_account_id": "string",
        }],
        resources=[{
            "meta": "string",
            "resource_account_id": "string",
            "resource_id": "string",
            "resource_type": "string",
        }])
    
    const shareResource = new cloudflare.Share("shareResource", {
        accountId: "string",
        name: "string",
        recipients: [{
            organizationId: "string",
            recipientAccountId: "string",
        }],
        resources: [{
            meta: "string",
            resourceAccountId: "string",
            resourceId: "string",
            resourceType: "string",
        }],
    });
    
    type: cloudflare:Share
    properties:
        accountId: string
        name: string
        recipients:
            - organizationId: string
              recipientAccountId: string
        resources:
            - meta: string
              resourceAccountId: string
              resourceId: string
              resourceType: string
    

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

    AccountId string
    Account identifier.
    Name string
    The name of the share.
    Recipients List<ShareRecipient>
    Resources List<ShareResource>
    AccountId string
    Account identifier.
    Name string
    The name of the share.
    Recipients []ShareRecipientTypeArgs
    Resources []ShareResourceTypeArgs
    account_id string
    Account identifier.
    name string
    The name of the share.
    recipients list(object)
    resources list(object)
    accountId String
    Account identifier.
    name String
    The name of the share.
    recipients List<ShareRecipient>
    resources List<ShareResource>
    accountId string
    Account identifier.
    name string
    The name of the share.
    recipients ShareRecipient[]
    resources ShareResource[]
    accountId String
    Account identifier.
    name String
    The name of the share.
    recipients List<Property Map>
    resources List<Property Map>

    Outputs

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

    AccountName string
    The display name of an account.
    AssociatedRecipientCount int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    AssociatingRecipientCount int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Created string
    When the share was created.
    DisassociatedRecipientCount int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    DisassociatingRecipientCount int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Available values: "sent", "received".
    Modified string
    When the share was modified.
    OrganizationId string
    Organization identifier.
    Status string
    Available values: "active", "deleting", "deleted".
    TargetType string
    Available values: "account", "organization".
    AccountName string
    The display name of an account.
    AssociatedRecipientCount int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    AssociatingRecipientCount int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Created string
    When the share was created.
    DisassociatedRecipientCount int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    DisassociatingRecipientCount int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Available values: "sent", "received".
    Modified string
    When the share was modified.
    OrganizationId string
    Organization identifier.
    Status string
    Available values: "active", "deleting", "deleted".
    TargetType string
    Available values: "account", "organization".
    account_name string
    The display name of an account.
    associated_recipient_count number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associating_recipient_count number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created string
    When the share was created.
    disassociated_recipient_count number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociating_recipient_count number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Available values: "sent", "received".
    modified string
    When the share was modified.
    organization_id string
    Organization identifier.
    status string
    Available values: "active", "deleting", "deleted".
    target_type string
    Available values: "account", "organization".
    accountName String
    The display name of an account.
    associatedRecipientCount Integer
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount Integer
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created String
    When the share was created.
    disassociatedRecipientCount Integer
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount Integer
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Available values: "sent", "received".
    modified String
    When the share was modified.
    organizationId String
    Organization identifier.
    status String
    Available values: "active", "deleting", "deleted".
    targetType String
    Available values: "account", "organization".
    accountName string
    The display name of an account.
    associatedRecipientCount number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created string
    When the share was created.
    disassociatedRecipientCount number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Available values: "sent", "received".
    modified string
    When the share was modified.
    organizationId string
    Organization identifier.
    status string
    Available values: "active", "deleting", "deleted".
    targetType string
    Available values: "account", "organization".
    account_name str
    The display name of an account.
    associated_recipient_count int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associating_recipient_count int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created str
    When the share was created.
    disassociated_recipient_count int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociating_recipient_count int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    Available values: "sent", "received".
    modified str
    When the share was modified.
    organization_id str
    Organization identifier.
    status str
    Available values: "active", "deleting", "deleted".
    target_type str
    Available values: "account", "organization".
    accountName String
    The display name of an account.
    associatedRecipientCount Number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount Number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created String
    When the share was created.
    disassociatedRecipientCount Number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount Number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Available values: "sent", "received".
    modified String
    When the share was modified.
    organizationId String
    Organization identifier.
    status String
    Available values: "active", "deleting", "deleted".
    targetType String
    Available values: "account", "organization".

    Look up Existing Share Resource

    Get an existing Share 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?: ShareState, opts?: CustomResourceOptions): Share
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            account_name: Optional[str] = None,
            associated_recipient_count: Optional[int] = None,
            associating_recipient_count: Optional[int] = None,
            created: Optional[str] = None,
            disassociated_recipient_count: Optional[int] = None,
            disassociating_recipient_count: Optional[int] = None,
            kind: Optional[str] = None,
            modified: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            recipients: Optional[Sequence[ShareRecipientArgs]] = None,
            resources: Optional[Sequence[ShareResourceArgs]] = None,
            status: Optional[str] = None,
            target_type: Optional[str] = None) -> Share
    func GetShare(ctx *Context, name string, id IDInput, state *ShareState, opts ...ResourceOption) (*Share, error)
    public static Share Get(string name, Input<string> id, ShareState? state, CustomResourceOptions? opts = null)
    public static Share get(String name, Output<String> id, ShareState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:Share    get:      id: ${id}
    import {
      to = cloudflare_share.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.
    AccountName string
    The display name of an account.
    AssociatedRecipientCount int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    AssociatingRecipientCount int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Created string
    When the share was created.
    DisassociatedRecipientCount int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    DisassociatingRecipientCount int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Kind string
    Available values: "sent", "received".
    Modified string
    When the share was modified.
    Name string
    The name of the share.
    OrganizationId string
    Organization identifier.
    Recipients List<ShareRecipient>
    Resources List<ShareResource>
    Status string
    Available values: "active", "deleting", "deleted".
    TargetType string
    Available values: "account", "organization".
    AccountId string
    Account identifier.
    AccountName string
    The display name of an account.
    AssociatedRecipientCount int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    AssociatingRecipientCount int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Created string
    When the share was created.
    DisassociatedRecipientCount int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    DisassociatingRecipientCount int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    Kind string
    Available values: "sent", "received".
    Modified string
    When the share was modified.
    Name string
    The name of the share.
    OrganizationId string
    Organization identifier.
    Recipients []ShareRecipientTypeArgs
    Resources []ShareResourceTypeArgs
    Status string
    Available values: "active", "deleting", "deleted".
    TargetType string
    Available values: "account", "organization".
    account_id string
    Account identifier.
    account_name string
    The display name of an account.
    associated_recipient_count number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associating_recipient_count number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created string
    When the share was created.
    disassociated_recipient_count number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociating_recipient_count number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    kind string
    Available values: "sent", "received".
    modified string
    When the share was modified.
    name string
    The name of the share.
    organization_id string
    Organization identifier.
    recipients list(object)
    resources list(object)
    status string
    Available values: "active", "deleting", "deleted".
    target_type string
    Available values: "account", "organization".
    accountId String
    Account identifier.
    accountName String
    The display name of an account.
    associatedRecipientCount Integer
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount Integer
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created String
    When the share was created.
    disassociatedRecipientCount Integer
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount Integer
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    kind String
    Available values: "sent", "received".
    modified String
    When the share was modified.
    name String
    The name of the share.
    organizationId String
    Organization identifier.
    recipients List<ShareRecipient>
    resources List<ShareResource>
    status String
    Available values: "active", "deleting", "deleted".
    targetType String
    Available values: "account", "organization".
    accountId string
    Account identifier.
    accountName string
    The display name of an account.
    associatedRecipientCount number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created string
    When the share was created.
    disassociatedRecipientCount number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    kind string
    Available values: "sent", "received".
    modified string
    When the share was modified.
    name string
    The name of the share.
    organizationId string
    Organization identifier.
    recipients ShareRecipient[]
    resources ShareResource[]
    status string
    Available values: "active", "deleting", "deleted".
    targetType string
    Available values: "account", "organization".
    account_id str
    Account identifier.
    account_name str
    The display name of an account.
    associated_recipient_count int
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associating_recipient_count int
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created str
    When the share was created.
    disassociated_recipient_count int
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociating_recipient_count int
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    kind str
    Available values: "sent", "received".
    modified str
    When the share was modified.
    name str
    The name of the share.
    organization_id str
    Organization identifier.
    recipients Sequence[ShareRecipientArgs]
    resources Sequence[ShareResourceArgs]
    status str
    Available values: "active", "deleting", "deleted".
    target_type str
    Available values: "account", "organization".
    accountId String
    Account identifier.
    accountName String
    The display name of an account.
    associatedRecipientCount Number
    The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    associatingRecipientCount Number
    The number of recipients in the 'associating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    created String
    When the share was created.
    disassociatedRecipientCount Number
    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    disassociatingRecipientCount Number
    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
    kind String
    Available values: "sent", "received".
    modified String
    When the share was modified.
    name String
    The name of the share.
    organizationId String
    Organization identifier.
    recipients List<Property Map>
    resources List<Property Map>
    status String
    Available values: "active", "deleting", "deleted".
    targetType String
    Available values: "account", "organization".

    Supporting Types

    ShareRecipient, ShareRecipientArgs

    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    OrganizationId string
    Organization identifier.
    RecipientAccountId string
    The account that will receive the share.
    organization_id string
    Organization identifier.
    recipient_account_id string
    The account that will receive the share.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.
    organizationId string
    Organization identifier.
    recipientAccountId string
    The account that will receive the share.
    organization_id str
    Organization identifier.
    recipient_account_id str
    The account that will receive the share.
    organizationId String
    Organization identifier.
    recipientAccountId String
    The account that will receive the share.

    ShareResource, ShareResourceArgs

    Meta string
    Resource Metadata.
    ResourceAccountId string
    Account identifier.
    ResourceId string
    Share Resource identifier.
    ResourceType string
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    Meta string
    Resource Metadata.
    ResourceAccountId string
    Account identifier.
    ResourceId string
    Share Resource identifier.
    ResourceType string
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    meta string
    Resource Metadata.
    resource_account_id string
    Account identifier.
    resource_id string
    Share Resource identifier.
    resource_type string
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    meta String
    Resource Metadata.
    resourceAccountId String
    Account identifier.
    resourceId String
    Share Resource identifier.
    resourceType String
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    meta string
    Resource Metadata.
    resourceAccountId string
    Account identifier.
    resourceId string
    Share Resource identifier.
    resourceType string
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    meta str
    Resource Metadata.
    resource_account_id str
    Account identifier.
    resource_id str
    Share Resource identifier.
    resource_type str
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".
    meta String
    Resource Metadata.
    resourceAccountId String
    Account identifier.
    resourceId String
    Share Resource identifier.
    resourceType String
    Resource Type. Available values: "custom-ruleset", "gateway-policy", "gateway-destination-ip", "gateway-block-page-settings", "gateway-extended-email-matching", "idp-federation-grant".

    Import

    $ pulumi import cloudflare:index/share:Share example '<account_id>/<share_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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial