1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. CloudConnectorRules
Cloudflare v6.0.0 published on Monday, Apr 14, 2025 by Pulumi

cloudflare.CloudConnectorRules

Explore with Pulumi AI

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  exampleCloudConnectorRules:
    type: cloudflare:CloudConnectorRules
    name: example_cloud_connector_rules
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      rules:
        - id: 95c365e17e1b46599cd99e5b231fac4e
          description: Rule description
          enabled: true
          expression: http.cookie eq "a=b"
          parameters:
            host: examplebucket.s3.eu-north-1.amazonaws.com
          cloud_provider: aws_s3
Copy

Create CloudConnectorRules Resource

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

Constructor syntax

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

@overload
def CloudConnectorRules(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        zone_id: Optional[str] = None,
                        rules: Optional[Sequence[CloudConnectorRulesRuleArgs]] = None)
func NewCloudConnectorRules(ctx *Context, name string, args CloudConnectorRulesArgs, opts ...ResourceOption) (*CloudConnectorRules, error)
public CloudConnectorRules(string name, CloudConnectorRulesArgs args, CustomResourceOptions? opts = null)
public CloudConnectorRules(String name, CloudConnectorRulesArgs args)
public CloudConnectorRules(String name, CloudConnectorRulesArgs args, CustomResourceOptions options)
type: cloudflare:CloudConnectorRules
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. CloudConnectorRulesArgs
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. CloudConnectorRulesArgs
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. CloudConnectorRulesArgs
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. CloudConnectorRulesArgs
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. CloudConnectorRulesArgs
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 cloudConnectorRulesResource = new Cloudflare.CloudConnectorRules("cloudConnectorRulesResource", new()
{
    ZoneId = "string",
    Rules = new[]
    {
        new Cloudflare.Inputs.CloudConnectorRulesRuleArgs
        {
            CloudProvider = "string",
            Description = "string",
            Enabled = false,
            Expression = "string",
            Id = "string",
            Parameters = new Cloudflare.Inputs.CloudConnectorRulesRuleParametersArgs
            {
                Host = "string",
            },
        },
    },
});
Copy
example, err := cloudflare.NewCloudConnectorRules(ctx, "cloudConnectorRulesResource", &cloudflare.CloudConnectorRulesArgs{
	ZoneId: pulumi.String("string"),
	Rules: cloudflare.CloudConnectorRulesRuleArray{
		&cloudflare.CloudConnectorRulesRuleArgs{
			CloudProvider: pulumi.String("string"),
			Description:   pulumi.String("string"),
			Enabled:       pulumi.Bool(false),
			Expression:    pulumi.String("string"),
			Id:            pulumi.String("string"),
			Parameters: &cloudflare.CloudConnectorRulesRuleParametersArgs{
				Host: pulumi.String("string"),
			},
		},
	},
})
Copy
var cloudConnectorRulesResource = new CloudConnectorRules("cloudConnectorRulesResource", CloudConnectorRulesArgs.builder()
    .zoneId("string")
    .rules(CloudConnectorRulesRuleArgs.builder()
        .cloudProvider("string")
        .description("string")
        .enabled(false)
        .expression("string")
        .id("string")
        .parameters(CloudConnectorRulesRuleParametersArgs.builder()
            .host("string")
            .build())
        .build())
    .build());
Copy
cloud_connector_rules_resource = cloudflare.CloudConnectorRules("cloudConnectorRulesResource",
    zone_id="string",
    rules=[{
        "cloud_provider": "string",
        "description": "string",
        "enabled": False,
        "expression": "string",
        "id": "string",
        "parameters": {
            "host": "string",
        },
    }])
Copy
const cloudConnectorRulesResource = new cloudflare.CloudConnectorRules("cloudConnectorRulesResource", {
    zoneId: "string",
    rules: [{
        cloudProvider: "string",
        description: "string",
        enabled: false,
        expression: "string",
        id: "string",
        parameters: {
            host: "string",
        },
    }],
});
Copy
type: cloudflare:CloudConnectorRules
properties:
    rules:
        - cloudProvider: string
          description: string
          enabled: false
          expression: string
          id: string
          parameters:
            host: string
    zoneId: string
Copy

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

ZoneId This property is required. string
Identifier
Rules List<CloudConnectorRulesRule>
List of Cloud Connector rules
ZoneId This property is required. string
Identifier
Rules []CloudConnectorRulesRuleArgs
List of Cloud Connector rules
zoneId This property is required. String
Identifier
rules List<CloudConnectorRulesRule>
List of Cloud Connector rules
zoneId This property is required. string
Identifier
rules CloudConnectorRulesRule[]
List of Cloud Connector rules
zone_id This property is required. str
Identifier
rules Sequence[CloudConnectorRulesRuleArgs]
List of Cloud Connector rules
zoneId This property is required. String
Identifier
rules List<Property Map>
List of Cloud Connector rules

Outputs

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

CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Id string
The provider-assigned unique ID for this managed resource.
Parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Id string
The provider-assigned unique ID for this managed resource.
Parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
id String
The provider-assigned unique ID for this managed resource.
parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
cloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description string
enabled boolean
expression string
id string
The provider-assigned unique ID for this managed resource.
parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
cloud_provider str
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description str
enabled bool
expression str
id str
The provider-assigned unique ID for this managed resource.
parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
id String
The provider-assigned unique ID for this managed resource.
parameters Property Map
Parameters of Cloud Connector Rule

Look up Existing CloudConnectorRules Resource

Get an existing CloudConnectorRules 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?: CloudConnectorRulesState, opts?: CustomResourceOptions): CloudConnectorRules
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        expression: Optional[str] = None,
        parameters: Optional[CloudConnectorRulesParametersArgs] = None,
        rules: Optional[Sequence[CloudConnectorRulesRuleArgs]] = None,
        zone_id: Optional[str] = None) -> CloudConnectorRules
func GetCloudConnectorRules(ctx *Context, name string, id IDInput, state *CloudConnectorRulesState, opts ...ResourceOption) (*CloudConnectorRules, error)
public static CloudConnectorRules Get(string name, Input<string> id, CloudConnectorRulesState? state, CustomResourceOptions? opts = null)
public static CloudConnectorRules get(String name, Output<String> id, CloudConnectorRulesState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:CloudConnectorRules    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:
CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
Rules List<CloudConnectorRulesRule>
List of Cloud Connector rules
ZoneId string
Identifier
CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Parameters CloudConnectorRulesParametersArgs
Parameters of Cloud Connector Rule
Rules []CloudConnectorRulesRuleArgs
List of Cloud Connector rules
ZoneId string
Identifier
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
rules List<CloudConnectorRulesRule>
List of Cloud Connector rules
zoneId String
Identifier
cloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description string
enabled boolean
expression string
parameters CloudConnectorRulesParameters
Parameters of Cloud Connector Rule
rules CloudConnectorRulesRule[]
List of Cloud Connector rules
zoneId string
Identifier
cloud_provider str
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description str
enabled bool
expression str
parameters CloudConnectorRulesParametersArgs
Parameters of Cloud Connector Rule
rules Sequence[CloudConnectorRulesRuleArgs]
List of Cloud Connector rules
zone_id str
Identifier
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
parameters Property Map
Parameters of Cloud Connector Rule
rules List<Property Map>
List of Cloud Connector rules
zoneId String
Identifier

Supporting Types

CloudConnectorRulesParameters
, CloudConnectorRulesParametersArgs

Host string
Host to perform Cloud Connection to
Host string
Host to perform Cloud Connection to
host String
Host to perform Cloud Connection to
host string
Host to perform Cloud Connection to
host str
Host to perform Cloud Connection to
host String
Host to perform Cloud Connection to

CloudConnectorRulesRule
, CloudConnectorRulesRuleArgs

CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Id string
Parameters CloudConnectorRulesRuleParameters
Parameters of Cloud Connector Rule
CloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
Description string
Enabled bool
Expression string
Id string
Parameters CloudConnectorRulesRuleParameters
Parameters of Cloud Connector Rule
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
id String
parameters CloudConnectorRulesRuleParameters
Parameters of Cloud Connector Rule
cloudProvider string
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description string
enabled boolean
expression string
id string
parameters CloudConnectorRulesRuleParameters
Parameters of Cloud Connector Rule
cloud_provider str
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description str
enabled bool
expression str
id str
parameters CloudConnectorRulesRuleParameters
Parameters of Cloud Connector Rule
cloudProvider String
Cloud Provider type Available values: "awss3", "r2", "gcpstorage", "azure_storage".
description String
enabled Boolean
expression String
id String
parameters Property Map
Parameters of Cloud Connector Rule

CloudConnectorRulesRuleParameters
, CloudConnectorRulesRuleParametersArgs

Host string
Host to perform Cloud Connection to
Host string
Host to perform Cloud Connection to
host String
Host to perform Cloud Connection to
host string
Host to perform Cloud Connection to
host str
Host to perform Cloud Connection to
host String
Host to perform Cloud Connection to

Package Details

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