1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. R2Bucket
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.R2Bucket

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleR2Bucket = new cloudflare.R2Bucket("example_r2_bucket", {
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        name: "example-bucket",
        location: "apac",
        storageClass: "Standard",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_r2_bucket = cloudflare.R2Bucket("example_r2_bucket",
        account_id="023e105f4ecef8ad9ca31a8372d0c353",
        name="example-bucket",
        location="apac",
        storage_class="Standard")
    
    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.NewR2Bucket(ctx, "example_r2_bucket", &cloudflare.R2BucketArgs{
    			AccountId:    pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			Name:         pulumi.String("example-bucket"),
    			Location:     pulumi.String("apac"),
    			StorageClass: pulumi.String("Standard"),
    		})
    		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 exampleR2Bucket = new Cloudflare.R2Bucket("example_r2_bucket", new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            Name = "example-bucket",
            Location = "apac",
            StorageClass = "Standard",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.R2Bucket;
    import com.pulumi.cloudflare.R2BucketArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 exampleR2Bucket = new R2Bucket("exampleR2Bucket", R2BucketArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .name("example-bucket")
                .location("apac")
                .storageClass("Standard")
                .build());
    
        }
    }
    
    resources:
      exampleR2Bucket:
        type: cloudflare:R2Bucket
        name: example_r2_bucket
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          name: example-bucket
          location: apac
          storageClass: Standard
    

    Create R2Bucket Resource

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

    Constructor syntax

    new R2Bucket(name: string, args: R2BucketArgs, opts?: CustomResourceOptions);
    @overload
    def R2Bucket(resource_name: str,
                 args: R2BucketArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def R2Bucket(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_id: Optional[str] = None,
                 name: Optional[str] = None,
                 jurisdiction: Optional[str] = None,
                 location: Optional[str] = None,
                 storage_class: Optional[str] = None)
    func NewR2Bucket(ctx *Context, name string, args R2BucketArgs, opts ...ResourceOption) (*R2Bucket, error)
    public R2Bucket(string name, R2BucketArgs args, CustomResourceOptions? opts = null)
    public R2Bucket(String name, R2BucketArgs args)
    public R2Bucket(String name, R2BucketArgs args, CustomResourceOptions options)
    
    type: cloudflare:R2Bucket
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args R2BucketArgs
    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 R2BucketArgs
    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 R2BucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args R2BucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args R2BucketArgs
    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 r2bucketResource = new Cloudflare.R2Bucket("r2bucketResource", new()
    {
        AccountId = "string",
        Name = "string",
        Jurisdiction = "string",
        Location = "string",
        StorageClass = "string",
    });
    
    example, err := cloudflare.NewR2Bucket(ctx, "r2bucketResource", &cloudflare.R2BucketArgs{
    	AccountId:    pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	Jurisdiction: pulumi.String("string"),
    	Location:     pulumi.String("string"),
    	StorageClass: pulumi.String("string"),
    })
    
    var r2bucketResource = new R2Bucket("r2bucketResource", R2BucketArgs.builder()
        .accountId("string")
        .name("string")
        .jurisdiction("string")
        .location("string")
        .storageClass("string")
        .build());
    
    r2bucket_resource = cloudflare.R2Bucket("r2bucketResource",
        account_id="string",
        name="string",
        jurisdiction="string",
        location="string",
        storage_class="string")
    
    const r2bucketResource = new cloudflare.R2Bucket("r2bucketResource", {
        accountId: "string",
        name: "string",
        jurisdiction: "string",
        location: "string",
        storageClass: "string",
    });
    
    type: cloudflare:R2Bucket
    properties:
        accountId: string
        jurisdiction: string
        location: string
        name: string
        storageClass: string
    

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

    AccountId string
    Account ID
    Name string
    Name of the bucket
    Jurisdiction string
    Jurisdiction of the bucket
    Location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    StorageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    AccountId string
    Account ID
    Name string
    Name of the bucket
    Jurisdiction string
    Jurisdiction of the bucket
    Location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    StorageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId String
    Account ID
    name String
    Name of the bucket
    jurisdiction String
    Jurisdiction of the bucket
    location String
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    storageClass String
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId string
    Account ID
    name string
    Name of the bucket
    jurisdiction string
    Jurisdiction of the bucket
    location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    storageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    account_id str
    Account ID
    name str
    Name of the bucket
    jurisdiction str
    Jurisdiction of the bucket
    location str
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    storage_class str
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId String
    Account ID
    name String
    Name of the bucket
    jurisdiction String
    Jurisdiction of the bucket
    location String
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    storageClass String
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".

    Outputs

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

    CreationDate string
    Creation timestamp
    Id string
    The provider-assigned unique ID for this managed resource.
    CreationDate string
    Creation timestamp
    Id string
    The provider-assigned unique ID for this managed resource.
    creationDate String
    Creation timestamp
    id String
    The provider-assigned unique ID for this managed resource.
    creationDate string
    Creation timestamp
    id string
    The provider-assigned unique ID for this managed resource.
    creation_date str
    Creation timestamp
    id str
    The provider-assigned unique ID for this managed resource.
    creationDate String
    Creation timestamp
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing R2Bucket Resource

    Get an existing R2Bucket 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?: R2BucketState, opts?: CustomResourceOptions): R2Bucket
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            creation_date: Optional[str] = None,
            jurisdiction: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            storage_class: Optional[str] = None) -> R2Bucket
    func GetR2Bucket(ctx *Context, name string, id IDInput, state *R2BucketState, opts ...ResourceOption) (*R2Bucket, error)
    public static R2Bucket Get(string name, Input<string> id, R2BucketState? state, CustomResourceOptions? opts = null)
    public static R2Bucket get(String name, Output<String> id, R2BucketState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:R2Bucket    get:      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 ID
    CreationDate string
    Creation timestamp
    Jurisdiction string
    Jurisdiction of the bucket
    Location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    Name string
    Name of the bucket
    StorageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    AccountId string
    Account ID
    CreationDate string
    Creation timestamp
    Jurisdiction string
    Jurisdiction of the bucket
    Location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    Name string
    Name of the bucket
    StorageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId String
    Account ID
    creationDate String
    Creation timestamp
    jurisdiction String
    Jurisdiction of the bucket
    location String
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    name String
    Name of the bucket
    storageClass String
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId string
    Account ID
    creationDate string
    Creation timestamp
    jurisdiction string
    Jurisdiction of the bucket
    location string
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    name string
    Name of the bucket
    storageClass string
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    account_id str
    Account ID
    creation_date str
    Creation timestamp
    jurisdiction str
    Jurisdiction of the bucket
    location str
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    name str
    Name of the bucket
    storage_class str
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".
    accountId String
    Account ID
    creationDate String
    Creation timestamp
    jurisdiction String
    Jurisdiction of the bucket
    location String
    Location of the bucket Available values: "apac", "eeur", "enam", "weur", "wnam", "oc".
    name String
    Name of the bucket
    storageClass String
    Storage class for newly uploaded objects, unless specified otherwise. Available values: "Standard", "InfrequentAccess".

    Import

    $ pulumi import cloudflare:index/r2Bucket:R2Bucket example '<account_id>/<bucket_name>/<jurisdiction>'
    

    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
    Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi