1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. R2BucketSippy
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.R2BucketSippy

Explore with Pulumi AI

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  exampleR2BucketSippy:
    type: cloudflare:R2BucketSippy
    name: example_r2_bucket_sippy
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      bucketName: example-bucket
      destination:
        access_key_id: accessKeyId
        provider: r2
        secret_access_key: secretAccessKey
      source:
        access_key_id: accessKeyId
        bucket: bucket
        provider: aws
        region: region
        secret_access_key: secretAccessKey
Copy

Create R2BucketSippy Resource

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

Constructor syntax

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

@overload
def R2BucketSippy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  account_id: Optional[str] = None,
                  bucket_name: Optional[str] = None,
                  destination: Optional[R2BucketSippyDestinationArgs] = None,
                  jurisdiction: Optional[str] = None,
                  source: Optional[R2BucketSippySourceArgs] = None)
func NewR2BucketSippy(ctx *Context, name string, args R2BucketSippyArgs, opts ...ResourceOption) (*R2BucketSippy, error)
public R2BucketSippy(string name, R2BucketSippyArgs args, CustomResourceOptions? opts = null)
public R2BucketSippy(String name, R2BucketSippyArgs args)
public R2BucketSippy(String name, R2BucketSippyArgs args, CustomResourceOptions options)
type: cloudflare:R2BucketSippy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. R2BucketSippyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. R2BucketSippyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. R2BucketSippyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. R2BucketSippyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. R2BucketSippyArgs
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 r2bucketSippyResource = new Cloudflare.R2BucketSippy("r2bucketSippyResource", new()
{
    AccountId = "string",
    BucketName = "string",
    Destination = new Cloudflare.Inputs.R2BucketSippyDestinationArgs
    {
        AccessKeyId = "string",
        Provider = "string",
        SecretAccessKey = "string",
    },
    Jurisdiction = "string",
    Source = new Cloudflare.Inputs.R2BucketSippySourceArgs
    {
        AccessKeyId = "string",
        Bucket = "string",
        ClientEmail = "string",
        PrivateKey = "string",
        Provider = "string",
        Region = "string",
        SecretAccessKey = "string",
    },
});
Copy
example, err := cloudflare.NewR2BucketSippy(ctx, "r2bucketSippyResource", &cloudflare.R2BucketSippyArgs{
	AccountId:  pulumi.String("string"),
	BucketName: pulumi.String("string"),
	Destination: &cloudflare.R2BucketSippyDestinationArgs{
		AccessKeyId:     pulumi.String("string"),
		Provider:        pulumi.String("string"),
		SecretAccessKey: pulumi.String("string"),
	},
	Jurisdiction: pulumi.String("string"),
	Source: &cloudflare.R2BucketSippySourceArgs{
		AccessKeyId:     pulumi.String("string"),
		Bucket:          pulumi.String("string"),
		ClientEmail:     pulumi.String("string"),
		PrivateKey:      pulumi.String("string"),
		Provider:        pulumi.String("string"),
		Region:          pulumi.String("string"),
		SecretAccessKey: pulumi.String("string"),
	},
})
Copy
var r2bucketSippyResource = new R2BucketSippy("r2bucketSippyResource", R2BucketSippyArgs.builder()
    .accountId("string")
    .bucketName("string")
    .destination(R2BucketSippyDestinationArgs.builder()
        .accessKeyId("string")
        .provider("string")
        .secretAccessKey("string")
        .build())
    .jurisdiction("string")
    .source(R2BucketSippySourceArgs.builder()
        .accessKeyId("string")
        .bucket("string")
        .clientEmail("string")
        .privateKey("string")
        .provider("string")
        .region("string")
        .secretAccessKey("string")
        .build())
    .build());
Copy
r2bucket_sippy_resource = cloudflare.R2BucketSippy("r2bucketSippyResource",
    account_id="string",
    bucket_name="string",
    destination={
        "access_key_id": "string",
        "provider": "string",
        "secret_access_key": "string",
    },
    jurisdiction="string",
    source={
        "access_key_id": "string",
        "bucket": "string",
        "client_email": "string",
        "private_key": "string",
        "provider": "string",
        "region": "string",
        "secret_access_key": "string",
    })
Copy
const r2bucketSippyResource = new cloudflare.R2BucketSippy("r2bucketSippyResource", {
    accountId: "string",
    bucketName: "string",
    destination: {
        accessKeyId: "string",
        provider: "string",
        secretAccessKey: "string",
    },
    jurisdiction: "string",
    source: {
        accessKeyId: "string",
        bucket: "string",
        clientEmail: "string",
        privateKey: "string",
        provider: "string",
        region: "string",
        secretAccessKey: "string",
    },
});
Copy
type: cloudflare:R2BucketSippy
properties:
    accountId: string
    bucketName: string
    destination:
        accessKeyId: string
        provider: string
        secretAccessKey: string
    jurisdiction: string
    source:
        accessKeyId: string
        bucket: string
        clientEmail: string
        privateKey: string
        provider: string
        region: string
        secretAccessKey: string
Copy

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

AccountId This property is required. string
Account ID
BucketName This property is required. string
Name of the bucket
Destination R2BucketSippyDestination
R2 bucket to copy objects to
Jurisdiction string
Jurisdiction of the bucket
Source R2BucketSippySource
AWS S3 bucket to copy objects from
AccountId This property is required. string
Account ID
BucketName This property is required. string
Name of the bucket
Destination R2BucketSippyDestinationArgs
R2 bucket to copy objects to
Jurisdiction string
Jurisdiction of the bucket
Source R2BucketSippySourceArgs
AWS S3 bucket to copy objects from
accountId This property is required. String
Account ID
bucketName This property is required. String
Name of the bucket
destination R2BucketSippyDestination
R2 bucket to copy objects to
jurisdiction String
Jurisdiction of the bucket
source R2BucketSippySource
AWS S3 bucket to copy objects from
accountId This property is required. string
Account ID
bucketName This property is required. string
Name of the bucket
destination R2BucketSippyDestination
R2 bucket to copy objects to
jurisdiction string
Jurisdiction of the bucket
source R2BucketSippySource
AWS S3 bucket to copy objects from
account_id This property is required. str
Account ID
bucket_name This property is required. str
Name of the bucket
destination R2BucketSippyDestinationArgs
R2 bucket to copy objects to
jurisdiction str
Jurisdiction of the bucket
source R2BucketSippySourceArgs
AWS S3 bucket to copy objects from
accountId This property is required. String
Account ID
bucketName This property is required. String
Name of the bucket
destination Property Map
R2 bucket to copy objects to
jurisdiction String
Jurisdiction of the bucket
source Property Map
AWS S3 bucket to copy objects from

Outputs

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

Enabled bool
State of Sippy for this bucket
Id string
The provider-assigned unique ID for this managed resource.
Enabled bool
State of Sippy for this bucket
Id string
The provider-assigned unique ID for this managed resource.
enabled Boolean
State of Sippy for this bucket
id String
The provider-assigned unique ID for this managed resource.
enabled boolean
State of Sippy for this bucket
id string
The provider-assigned unique ID for this managed resource.
enabled bool
State of Sippy for this bucket
id str
The provider-assigned unique ID for this managed resource.
enabled Boolean
State of Sippy for this bucket
id String
The provider-assigned unique ID for this managed resource.

Look up Existing R2BucketSippy Resource

Get an existing R2BucketSippy 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?: R2BucketSippyState, opts?: CustomResourceOptions): R2BucketSippy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        bucket_name: Optional[str] = None,
        destination: Optional[R2BucketSippyDestinationArgs] = None,
        enabled: Optional[bool] = None,
        jurisdiction: Optional[str] = None,
        source: Optional[R2BucketSippySourceArgs] = None) -> R2BucketSippy
func GetR2BucketSippy(ctx *Context, name string, id IDInput, state *R2BucketSippyState, opts ...ResourceOption) (*R2BucketSippy, error)
public static R2BucketSippy Get(string name, Input<string> id, R2BucketSippyState? state, CustomResourceOptions? opts = null)
public static R2BucketSippy get(String name, Output<String> id, R2BucketSippyState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:R2BucketSippy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
BucketName string
Name of the bucket
Destination R2BucketSippyDestination
R2 bucket to copy objects to
Enabled bool
State of Sippy for this bucket
Jurisdiction string
Jurisdiction of the bucket
Source R2BucketSippySource
AWS S3 bucket to copy objects from
AccountId string
Account ID
BucketName string
Name of the bucket
Destination R2BucketSippyDestinationArgs
R2 bucket to copy objects to
Enabled bool
State of Sippy for this bucket
Jurisdiction string
Jurisdiction of the bucket
Source R2BucketSippySourceArgs
AWS S3 bucket to copy objects from
accountId String
Account ID
bucketName String
Name of the bucket
destination R2BucketSippyDestination
R2 bucket to copy objects to
enabled Boolean
State of Sippy for this bucket
jurisdiction String
Jurisdiction of the bucket
source R2BucketSippySource
AWS S3 bucket to copy objects from
accountId string
Account ID
bucketName string
Name of the bucket
destination R2BucketSippyDestination
R2 bucket to copy objects to
enabled boolean
State of Sippy for this bucket
jurisdiction string
Jurisdiction of the bucket
source R2BucketSippySource
AWS S3 bucket to copy objects from
account_id str
Account ID
bucket_name str
Name of the bucket
destination R2BucketSippyDestinationArgs
R2 bucket to copy objects to
enabled bool
State of Sippy for this bucket
jurisdiction str
Jurisdiction of the bucket
source R2BucketSippySourceArgs
AWS S3 bucket to copy objects from
accountId String
Account ID
bucketName String
Name of the bucket
destination Property Map
R2 bucket to copy objects to
enabled Boolean
State of Sippy for this bucket
jurisdiction String
Jurisdiction of the bucket
source Property Map
AWS S3 bucket to copy objects from

Supporting Types

R2BucketSippyDestination
, R2BucketSippyDestinationArgs

AccessKeyId string
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
Provider string
Available values: "r2".
SecretAccessKey string

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

AccessKeyId string
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
Provider string
Available values: "r2".
SecretAccessKey string

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

accessKeyId String
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
provider String
Available values: "r2".
secretAccessKey String

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

accessKeyId string
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
provider string
Available values: "r2".
secretAccessKey string

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

access_key_id str
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
provider str
Available values: "r2".
secret_access_key str

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

accessKeyId String
ID of a Cloudflare API token. This is the value labelled "Access Key ID" when creating an API token from the R2 dashboard.
provider String
Available values: "r2".
secretAccessKey String

Value of a Cloudflare API token. This is the value labelled "Secret Access Key" when creating an API token from the R2 dashboard.

Sippy will use this token when writing objects to R2, so it is best to scope this token to the bucket you're enabling Sippy for.

R2BucketSippySource
, R2BucketSippySourceArgs

AccessKeyId string
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
Bucket string
Name of the AWS S3 bucket
ClientEmail string
Client email of an IAM credential (ideally scoped to a single GCS bucket)
PrivateKey string
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
Provider string
Available values: "aws".
Region string
Name of the AWS availability zone
SecretAccessKey string
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
AccessKeyId string
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
Bucket string
Name of the AWS S3 bucket
ClientEmail string
Client email of an IAM credential (ideally scoped to a single GCS bucket)
PrivateKey string
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
Provider string
Available values: "aws".
Region string
Name of the AWS availability zone
SecretAccessKey string
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
accessKeyId String
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
bucket String
Name of the AWS S3 bucket
clientEmail String
Client email of an IAM credential (ideally scoped to a single GCS bucket)
privateKey String
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
provider String
Available values: "aws".
region String
Name of the AWS availability zone
secretAccessKey String
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
accessKeyId string
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
bucket string
Name of the AWS S3 bucket
clientEmail string
Client email of an IAM credential (ideally scoped to a single GCS bucket)
privateKey string
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
provider string
Available values: "aws".
region string
Name of the AWS availability zone
secretAccessKey string
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
access_key_id str
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
bucket str
Name of the AWS S3 bucket
client_email str
Client email of an IAM credential (ideally scoped to a single GCS bucket)
private_key str
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
provider str
Available values: "aws".
region str
Name of the AWS availability zone
secret_access_key str
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
accessKeyId String
Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
bucket String
Name of the AWS S3 bucket
clientEmail String
Client email of an IAM credential (ideally scoped to a single GCS bucket)
privateKey String
Private Key of an IAM credential (ideally scoped to a single GCS bucket)
provider String
Available values: "aws".
region String
Name of the AWS availability zone
secretAccessKey String
Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.