Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
published on Thursday, Jul 16, 2026 by Pulumi
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
published on Thursday, Jul 16, 2026 by Pulumi
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleShare = cloudflare.getShare({
accountId: "023e105f4ecef8ad9ca31a8372d0c353",
shareId: "3fd85f74b32742f1bff64a85009dda07",
includeRecipientCounts: true,
includeResources: true,
});
import pulumi
import pulumi_cloudflare as cloudflare
example_share = cloudflare.get_share(account_id="023e105f4ecef8ad9ca31a8372d0c353",
share_id="3fd85f74b32742f1bff64a85009dda07",
include_recipient_counts=True,
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.GetShare(ctx, &cloudflare.LookupShareArgs{
AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
ShareId: pulumi.StringRef("3fd85f74b32742f1bff64a85009dda07"),
IncludeRecipientCounts: pulumi.BoolRef(true),
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 exampleShare = Cloudflare.GetShare.Invoke(new()
{
AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
ShareId = "3fd85f74b32742f1bff64a85009dda07",
IncludeRecipientCounts = true,
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.GetShareArgs;
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 exampleShare = CloudflareFunctions.getShare(GetShareArgs.builder()
.accountId("023e105f4ecef8ad9ca31a8372d0c353")
.shareId("3fd85f74b32742f1bff64a85009dda07")
.includeRecipientCounts(true)
.includeResources(true)
.build());
}
}
variables:
exampleShare:
fn::invoke:
function: cloudflare:getShare
arguments:
accountId: 023e105f4ecef8ad9ca31a8372d0c353
shareId: 3fd85f74b32742f1bff64a85009dda07
includeRecipientCounts: true
includeResources: true
pulumi {
required_providers {
cloudflare = {
source = "pulumi/cloudflare"
}
}
}
data "cloudflare_getshare" "exampleShare" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
share_id = "3fd85f74b32742f1bff64a85009dda07"
include_recipient_counts = true
include_resources = true
}
Using getShare
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 getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>
function getShareOutput(args: GetShareOutputArgs, opts?: InvokeOptions): Output<GetShareResult>def get_share(account_id: Optional[str] = None,
filter: Optional[GetShareFilter] = None,
include_recipient_counts: Optional[bool] = None,
include_resources: Optional[bool] = None,
share_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetShareResult
def get_share_output(account_id: pulumi.Input[Optional[str]] = None,
filter: pulumi.Input[Optional[GetShareFilterArgs]] = None,
include_recipient_counts: pulumi.Input[Optional[bool]] = None,
include_resources: pulumi.Input[Optional[bool]] = None,
share_id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetShareResult]func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)
func LookupShareOutput(ctx *Context, args *LookupShareOutputArgs, opts ...InvokeOption) LookupShareResultOutput> Note: This function is named LookupShare in the Go SDK.
public static class GetShare
{
public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
public static Output<GetShareResult> Invoke(GetShareInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
public static Output<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
fn::invoke:
function: cloudflare:index/getShare:getShare
arguments:
# arguments dictionarydata "cloudflare_get_share" "name" {
# arguments
}The following arguments are supported:
- Account
Id string - Account identifier.
- Filter
Get
Share Filter - Include
Recipient boolCounts - Include recipient counts in the response.
- Include
Resources bool - Include resources in the response.
- string
- Share identifier tag.
- Account
Id string - Account identifier.
- Filter
Get
Share Filter - Include
Recipient boolCounts - Include recipient counts in the response.
- Include
Resources bool - Include resources in the response.
- string
- Share identifier tag.
- account_
id string - Account identifier.
- filter object
- include_
recipient_ boolcounts - Include recipient counts in the response.
- include_
resources bool - Include resources in the response.
- string
- Share identifier tag.
- account
Id String - Account identifier.
- filter
Get
Share Filter - include
Recipient BooleanCounts - Include recipient counts in the response.
- include
Resources Boolean - Include resources in the response.
- String
- Share identifier tag.
- account
Id string - Account identifier.
- filter
Get
Share Filter - include
Recipient booleanCounts - Include recipient counts in the response.
- include
Resources boolean - Include resources in the response.
- string
- Share identifier tag.
- account_
id str - Account identifier.
- filter
Get
Share Filter - include_
recipient_ boolcounts - Include recipient counts in the response.
- include_
resources bool - Include resources in the response.
- str
- Share identifier tag.
- account
Id String - Account identifier.
- filter Property Map
- include
Recipient BooleanCounts - Include recipient counts in the response.
- include
Resources Boolean - Include resources in the response.
- String
- Share identifier tag.
getShare Result
The following output properties are available:
- Account
Id string - Account identifier.
- Account
Name string - The display name of an account.
- Associated
Recipient intCount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Associating
Recipient intCount - 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 intCount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Disassociating
Recipient intCount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Id string
- Share identifier tag.
- 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.
- Resources
List<Get
Share Resource> - A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- Status string
- Available values: "active", "deleting", "deleted".
- Target
Type string - Available values: "account", "organization".
- Filter
Get
Share Filter - Include
Recipient boolCounts - Include recipient counts in the response.
- Include
Resources bool - Include resources in the response.
- string
- Share identifier tag.
- Account
Id string - Account identifier.
- Account
Name string - The display name of an account.
- Associated
Recipient intCount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Associating
Recipient intCount - 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 intCount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Disassociating
Recipient intCount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- Id string
- Share identifier tag.
- 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.
- Resources
[]Get
Share Resource Type - A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- Status string
- Available values: "active", "deleting", "deleted".
- Target
Type string - Available values: "account", "organization".
- Filter
Get
Share Filter - Include
Recipient boolCounts - Include recipient counts in the response.
- Include
Resources bool - Include resources in the response.
- string
- Share identifier tag.
- account_
id string - Account identifier.
- account_
name string - The display name of an account.
- associated_
recipient_ numbercount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- associating_
recipient_ numbercount - 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_ numbercount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- disassociating_
recipient_ numbercount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- id string
- Share identifier tag.
- 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.
- resources list(object)
- A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- status string
- Available values: "active", "deleting", "deleted".
- target_
type string - Available values: "account", "organization".
- filter object
- include_
recipient_ boolcounts - Include recipient counts in the response.
- include_
resources bool - Include resources in the response.
- string
- Share identifier tag.
- account
Id String - Account identifier.
- account
Name String - The display name of an account.
- associated
Recipient IntegerCount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- associating
Recipient IntegerCount - 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 IntegerCount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- disassociating
Recipient IntegerCount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- id String
- Share identifier tag.
- 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.
- resources
List<Get
Share Resource> - A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- status String
- Available values: "active", "deleting", "deleted".
- target
Type String - Available values: "account", "organization".
- filter
Get
Share Filter - include
Recipient BooleanCounts - Include recipient counts in the response.
- include
Resources Boolean - Include resources in the response.
- String
- Share identifier tag.
- account
Id string - Account identifier.
- account
Name string - The display name of an account.
- associated
Recipient numberCount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- associating
Recipient numberCount - 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 numberCount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- disassociating
Recipient numberCount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- id string
- Share identifier tag.
- 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.
- resources
Get
Share Resource[] - A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- status string
- Available values: "active", "deleting", "deleted".
- target
Type string - Available values: "account", "organization".
- filter
Get
Share Filter - include
Recipient booleanCounts - Include recipient counts in the response.
- include
Resources boolean - Include resources in the response.
- string
- Share identifier tag.
- account_
id str - Account identifier.
- account_
name str - The display name of an account.
- associated_
recipient_ intcount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- associating_
recipient_ intcount - 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_ intcount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- disassociating_
recipient_ intcount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- id str
- Share identifier tag.
- 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.
- resources
Sequence[Get
Share Resource] - A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- status str
- Available values: "active", "deleting", "deleted".
- target_
type str - Available values: "account", "organization".
- filter
Get
Share Filter - include_
recipient_ boolcounts - Include recipient counts in the response.
- include_
resources bool - Include resources in the response.
- str
- Share identifier tag.
- account
Id String - Account identifier.
- account
Name String - The display name of an account.
- associated
Recipient NumberCount - The number of recipients in the 'associated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- associating
Recipient NumberCount - 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 NumberCount - The number of recipients in the 'disassociated' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- disassociating
Recipient NumberCount - The number of recipients in the 'disassociating' state. This field is only included when requested via the 'includerecipientcounts' parameter.
- id String
- Share identifier tag.
- 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.
- resources List<Property Map>
- A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.
- status String
- Available values: "active", "deleting", "deleted".
- target
Type String - Available values: "account", "organization".
- filter Property Map
- include
Recipient BooleanCounts - Include recipient counts in the response.
- include
Resources Boolean - Include resources in the response.
- String
- Share identifier tag.
Supporting Types
GetShareFilter
- Direction string
- Direction to sort objects. Available values: "asc", "desc".
- Order string
- Order shares by values in the given field. Available values: "name", "created".
- Kind string
- Filter shares by kind. Available values: "sent", "received".
- Resource
Types List<string> - Filter share resources by resource_types.
- Status string
- Filter shares by status. Available values: "active", "deleting", "deleted".
- List<string>
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - Target
Type string - Filter shares by target_type. Available values: "account", "organization".
- Direction string
- Direction to sort objects. Available values: "asc", "desc".
- Order string
- Order shares by values in the given field. Available values: "name", "created".
- Kind string
- Filter shares by kind. Available values: "sent", "received".
- Resource
Types []string - Filter share resources by resource_types.
- Status string
- Filter shares by status. Available values: "active", "deleting", "deleted".
- []string
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - Target
Type string - Filter shares by target_type. Available values: "account", "organization".
- direction string
- Direction to sort objects. Available values: "asc", "desc".
- order string
- Order shares by values in the given field. Available values: "name", "created".
- kind string
- Filter shares by kind. Available values: "sent", "received".
- resource_
types list(string) - Filter share resources by resource_types.
- status string
- Filter shares by status. Available values: "active", "deleting", "deleted".
- list(string)
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - target_
type string - Filter shares by target_type. Available values: "account", "organization".
- direction String
- Direction to sort objects. Available values: "asc", "desc".
- order String
- Order shares by values in the given field. Available values: "name", "created".
- kind String
- Filter shares by kind. Available values: "sent", "received".
- resource
Types List<String> - Filter share resources by resource_types.
- status String
- Filter shares by status. Available values: "active", "deleting", "deleted".
- List<String>
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - target
Type String - Filter shares by target_type. Available values: "account", "organization".
- direction string
- Direction to sort objects. Available values: "asc", "desc".
- order string
- Order shares by values in the given field. Available values: "name", "created".
- kind string
- Filter shares by kind. Available values: "sent", "received".
- resource
Types string[] - Filter share resources by resource_types.
- status string
- Filter shares by status. Available values: "active", "deleting", "deleted".
- string[]
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - target
Type string - Filter shares by target_type. Available values: "account", "organization".
- direction str
- Direction to sort objects. Available values: "asc", "desc".
- order str
- Order shares by values in the given field. Available values: "name", "created".
- kind str
- Filter shares by kind. Available values: "sent", "received".
- resource_
types Sequence[str] - Filter share resources by resource_types.
- status str
- Filter shares by status. Available values: "active", "deleting", "deleted".
- Sequence[str]
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - target_
type str - Filter shares by target_type. Available values: "account", "organization".
- direction String
- Direction to sort objects. Available values: "asc", "desc".
- order String
- Order shares by values in the given field. Available values: "name", "created".
- kind String
- Filter shares by kind. Available values: "sent", "received".
- resource
Types List<String> - Filter share resources by resource_types.
- status String
- Filter shares by status. Available values: "active", "deleting", "deleted".
- List<String>
- Filter shares by tag. Each value is either
key=value(matches shares whose tags contain that key/value pair) orkeyalone (matches shares that have any value for that key). May be repeated; multipletagparameters are ANDed together. Maximum 20tagparameters per request. - target
Type String - Filter shares by target_type. Available values: "account", "organization".
GetShareResource
- Created string
- When the share was created.
- Id string
- Share Resource identifier.
- Meta string
- Resource Metadata.
- Modified string
- When the share was modified.
- Resource
Account stringId - 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".
- Resource
Version int - Resource Version.
- Status string
- Resource Status. Available values: "active", "deleting", "deleted".
- Created string
- When the share was created.
- Id string
- Share Resource identifier.
- Meta string
- Resource Metadata.
- Modified string
- When the share was modified.
- Resource
Account stringId - 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".
- Resource
Version int - Resource Version.
- Status string
- Resource Status. Available values: "active", "deleting", "deleted".
- created string
- When the share was created.
- id string
- Share Resource identifier.
- meta string
- Resource Metadata.
- modified string
- When the share was modified.
- resource_
account_ stringid - 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".
- resource_
version number - Resource Version.
- status string
- Resource Status. Available values: "active", "deleting", "deleted".
- created String
- When the share was created.
- id String
- Share Resource identifier.
- meta String
- Resource Metadata.
- modified String
- When the share was modified.
- resource
Account StringId - 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".
- resource
Version Integer - Resource Version.
- status String
- Resource Status. Available values: "active", "deleting", "deleted".
- created string
- When the share was created.
- id string
- Share Resource identifier.
- meta string
- Resource Metadata.
- modified string
- When the share was modified.
- resource
Account stringId - 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".
- resource
Version number - Resource Version.
- status string
- Resource Status. Available values: "active", "deleting", "deleted".
- created str
- When the share was created.
- id str
- Share Resource identifier.
- meta str
- Resource Metadata.
- modified str
- When the share was modified.
- resource_
account_ strid - 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".
- resource_
version int - Resource Version.
- status str
- Resource Status. Available values: "active", "deleting", "deleted".
- created String
- When the share was created.
- id String
- Share Resource identifier.
- meta String
- Resource Metadata.
- modified String
- When the share was modified.
- resource
Account StringId - 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".
- resource
Version Number - Resource Version.
- status String
- Resource Status. Available values: "active", "deleting", "deleted".
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflareTerraform Provider.
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
published on Thursday, Jul 16, 2026 by Pulumi