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
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 string
- The unique name of the resource.
- args R2BucketSippyArgs
- 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 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 string
- The unique name of the resource.
- args R2BucketSippyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args R2BucketSippyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
},
});
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"),
},
})
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());
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",
})
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",
},
});
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
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:
- Account
Id string - Account ID
- Bucket
Name string - Name of the bucket
- Destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- Jurisdiction string
- Jurisdiction of the bucket
- Source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- Account
Id string - Account ID
- Bucket
Name string - Name of the bucket
- Destination
R2Bucket
Sippy Destination Args - R2 bucket to copy objects to
- Jurisdiction string
- Jurisdiction of the bucket
- Source
R2Bucket
Sippy Source Args - AWS S3 bucket to copy objects from
- account
Id String - Account ID
- bucket
Name String - Name of the bucket
- destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- jurisdiction String
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- account
Id string - Account ID
- bucket
Name string - Name of the bucket
- destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- jurisdiction string
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- account_
id str - Account ID
- bucket_
name str - Name of the bucket
- destination
R2Bucket
Sippy Destination Args - R2 bucket to copy objects to
- jurisdiction str
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source Args - AWS S3 bucket to copy objects from
- account
Id String - Account ID
- bucket
Name 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:
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
- 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.
- Account
Id string - Account ID
- Bucket
Name string - Name of the bucket
- Destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- Enabled bool
- State of Sippy for this bucket
- Jurisdiction string
- Jurisdiction of the bucket
- Source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- Account
Id string - Account ID
- Bucket
Name string - Name of the bucket
- Destination
R2Bucket
Sippy Destination Args - R2 bucket to copy objects to
- Enabled bool
- State of Sippy for this bucket
- Jurisdiction string
- Jurisdiction of the bucket
- Source
R2Bucket
Sippy Source Args - AWS S3 bucket to copy objects from
- account
Id String - Account ID
- bucket
Name String - Name of the bucket
- destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- enabled Boolean
- State of Sippy for this bucket
- jurisdiction String
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- account
Id string - Account ID
- bucket
Name string - Name of the bucket
- destination
R2Bucket
Sippy Destination - R2 bucket to copy objects to
- enabled boolean
- State of Sippy for this bucket
- jurisdiction string
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source - AWS S3 bucket to copy objects from
- account_
id str - Account ID
- bucket_
name str - Name of the bucket
- destination
R2Bucket
Sippy Destination Args - R2 bucket to copy objects to
- enabled bool
- State of Sippy for this bucket
- jurisdiction str
- Jurisdiction of the bucket
- source
R2Bucket
Sippy Source Args - AWS S3 bucket to copy objects from
- account
Id String - Account ID
- bucket
Name 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
- Access
Key stringId - 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".
- Secret
Access stringKey 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 stringId - 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".
- Secret
Access stringKey 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 StringId - 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".
- secret
Access StringKey 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 stringId - 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".
- secret
Access stringKey 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_ strid - 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_ strkey 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 StringId - 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".
- secret
Access StringKey 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
- Access
Key stringId - Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
- Bucket string
- Name of the AWS S3 bucket
- Client
Email string - Client email of an IAM credential (ideally scoped to a single GCS bucket)
- Private
Key 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
- Secret
Access stringKey - Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
- Access
Key stringId - Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
- Bucket string
- Name of the AWS S3 bucket
- Client
Email string - Client email of an IAM credential (ideally scoped to a single GCS bucket)
- Private
Key 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
- Secret
Access stringKey - Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
- access
Key StringId - Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
- bucket String
- Name of the AWS S3 bucket
- client
Email String - Client email of an IAM credential (ideally scoped to a single GCS bucket)
- private
Key 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
- secret
Access StringKey - Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
- access
Key stringId - Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
- bucket string
- Name of the AWS S3 bucket
- client
Email string - Client email of an IAM credential (ideally scoped to a single GCS bucket)
- private
Key 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
- secret
Access stringKey - Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
- access_
key_ strid - 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_ strkey - Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
- access
Key StringId - Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
- bucket String
- Name of the AWS S3 bucket
- client
Email String - Client email of an IAM credential (ideally scoped to a single GCS bucket)
- private
Key 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
- secret
Access StringKey - 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.