1. Packages
  2. Cloudflare
  3. API Docs
  4. R2Bucket
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.R2Bucket

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.R2Bucket("example", {
        accountId: "f037e56e89293a057740de681ac9abbe",
        name: "terraform-bucket",
        location: "enam",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.R2Bucket("example",
        account_id="f037e56e89293a057740de681ac9abbe",
        name="terraform-bucket",
        location="enam")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.NewR2Bucket(ctx, "example", &cloudflare.R2BucketArgs{
    			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
    			Name:      pulumi.String("terraform-bucket"),
    			Location:  pulumi.String("enam"),
    		})
    		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 example = new Cloudflare.R2Bucket("example", new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
            Name = "terraform-bucket",
            Location = "enam",
        });
    
    });
    
    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 example = new R2Bucket("example", R2BucketArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .name("terraform-bucket")
                .location("enam")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:R2Bucket
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          name: terraform-bucket
          location: enam
    

    Available location values can be found in the R2 documentation.

    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,
                 location: 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",
        Location = "string",
    });
    
    example, err := cloudflare.NewR2Bucket(ctx, "r2bucketResource", &cloudflare.R2BucketArgs{
    	AccountId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Location:  pulumi.String("string"),
    })
    
    var r2bucketResource = new R2Bucket("r2bucketResource", R2BucketArgs.builder()
        .accountId("string")
        .name("string")
        .location("string")
        .build());
    
    r2bucket_resource = cloudflare.R2Bucket("r2bucketResource",
        account_id="string",
        name="string",
        location="string")
    
    const r2bucketResource = new cloudflare.R2Bucket("r2bucketResource", {
        accountId: "string",
        name: "string",
        location: "string",
    });
    
    type: cloudflare:R2Bucket
    properties:
        accountId: string
        location: string
        name: 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

    The R2Bucket resource accepts the following input properties:

    AccountId string
    The account identifier to target for the resource.
    Name string
    The name of the R2 bucket.
    Location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    AccountId string
    The account identifier to target for the resource.
    Name string
    The name of the R2 bucket.
    Location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the R2 bucket.
    location String
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    accountId string
    The account identifier to target for the resource.
    name string
    The name of the R2 bucket.
    location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    account_id str
    The account identifier to target for the resource.
    name str
    The name of the R2 bucket.
    location str
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the R2 bucket.
    location String
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    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,
            location: Optional[str] = None,
            name: 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)
    Resource lookup is not supported in YAML
    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
    The account identifier to target for the resource.
    Location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    Name string
    The name of the R2 bucket.
    AccountId string
    The account identifier to target for the resource.
    Location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    Name string
    The name of the R2 bucket.
    accountId String
    The account identifier to target for the resource.
    location String
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    name String
    The name of the R2 bucket.
    accountId string
    The account identifier to target for the resource.
    location string
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    name string
    The name of the R2 bucket.
    account_id str
    The account identifier to target for the resource.
    location str
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    name str
    The name of the R2 bucket.
    accountId String
    The account identifier to target for the resource.
    location String
    The location hint of the R2 bucket. Available values: WNAM, ENAM, WEUR, EEUR, APAC
    name String
    The name of the R2 bucket.

    Import

    $ pulumi import cloudflare:index/r2Bucket:R2Bucket default <account id>/<bucket name>
    

    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 v5.34.0 published on Friday, Jul 12, 2024 by Pulumi