Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. CloudConnectorRules
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.CloudConnectorRules

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-cloudflare

    The Cloud Connector Rules resource allows you to create and manage cloud connector rules for a zone.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudConnectorRules;
import com.pulumi.cloudflare.CloudConnectorRulesArgs;
import com.pulumi.cloudflare.inputs.CloudConnectorRulesRuleArgs;
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 CloudConnectorRules("example", CloudConnectorRulesArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .rules(CloudConnectorRulesRuleArgs.builder()
                .description("connect aws bucket")
                .enabled(true)
                .expression("http.uri")
                .provider("aws_s3")
                .parameters(CloudConnectorRulesRuleParametersArgs.builder()
                    .host("mystorage.s3.ams.amazonaws.com")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: cloudflare:CloudConnectorRules
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      rules:
        - description: connect aws bucket
          enabled: true
          expression: http.uri
          provider: aws_s3
          parameters:
            - host: mystorage.s3.ams.amazonaws.com

    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 string
    The unique name of the resource.
    args CloudConnectorRulesArgs
    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 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 string
    The unique name of the resource.
    args CloudConnectorRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudConnectorRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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
        {
            Expression = "string",
            Provider = "string",
            Description = "string",
            Enabled = false,
            Parameters = new Cloudflare.Inputs.CloudConnectorRulesRuleParametersArgs
            {
                Host = "string",
            },
        },
    },
});

    example, err := cloudflare.NewCloudConnectorRules(ctx, "cloudConnectorRulesResource", &cloudflare.CloudConnectorRulesArgs{
	ZoneId: pulumi.String("string"),
	Rules: cloudflare.CloudConnectorRulesRuleArray{
		&cloudflare.CloudConnectorRulesRuleArgs{
			Expression:  pulumi.String("string"),
			Provider:    pulumi.String("string"),
			Description: pulumi.String("string"),
			Enabled:     pulumi.Bool(false),
			Parameters: &cloudflare.CloudConnectorRulesRuleParametersArgs{
				Host: pulumi.String("string"),
			},
		},
	},
})

    var cloudConnectorRulesResource = new CloudConnectorRules("cloudConnectorRulesResource", CloudConnectorRulesArgs.builder()
    .zoneId("string")
    .rules(CloudConnectorRulesRuleArgs.builder()
        .expression("string")
        .provider("string")
        .description("string")
        .enabled(false)
        .parameters(CloudConnectorRulesRuleParametersArgs.builder()
            .host("string")
            .build())
        .build())
    .build());

    cloud_connector_rules_resource = cloudflare.CloudConnectorRules("cloudConnectorRulesResource",
    zone_id="string",
    rules=[cloudflare.CloudConnectorRulesRuleArgs(
        expression="string",
        provider="string",
        description="string",
        enabled=False,
        parameters=cloudflare.CloudConnectorRulesRuleParametersArgs(
            host="string",
        ),
    )])

    const cloudConnectorRulesResource = new cloudflare.CloudConnectorRules("cloudConnectorRulesResource", {
    zoneId: "string",
    rules: [{
        expression: "string",
        provider: "string",
        description: "string",
        enabled: false,
        parameters: {
            host: "string",
        },
    }],
});

    type: cloudflare:CloudConnectorRules
properties:
    rules:
        - description: string
          enabled: false
          expression: string
          parameters:
            host: string
          provider: string
    zoneId: string

    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

    The CloudConnectorRules resource accepts the following input properties:

    ZoneId string
    The zone identifier to target for the resource.
    Rules List<CloudConnectorRulesRule>
    List of Cloud Connector Rules
    ZoneId string
    The zone identifier to target for the resource.
    Rules []CloudConnectorRulesRuleArgs
    List of Cloud Connector Rules
    zoneId String
    The zone identifier to target for the resource.
    rules List<CloudConnectorRulesRule>
    List of Cloud Connector Rules
    zoneId string
    The zone identifier to target for the resource.
    rules CloudConnectorRulesRule[]
    List of Cloud Connector Rules
    zone_id str
    The zone identifier to target for the resource.
    rules Sequence[CloudConnectorRulesRuleArgs]
    List of Cloud Connector Rules
    zoneId String
    The zone identifier to target for the resource.
    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:

    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 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,
        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)
    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:
    Rules List<CloudConnectorRulesRule>
    List of Cloud Connector Rules
    ZoneId string
    The zone identifier to target for the resource.
    Rules []CloudConnectorRulesRuleArgs
    List of Cloud Connector Rules
    ZoneId string
    The zone identifier to target for the resource.
    rules List<CloudConnectorRulesRule>
    List of Cloud Connector Rules
    zoneId String
    The zone identifier to target for the resource.
    rules CloudConnectorRulesRule[]
    List of Cloud Connector Rules
    zoneId string
    The zone identifier to target for the resource.
    rules Sequence[CloudConnectorRulesRuleArgs]
    List of Cloud Connector Rules
    zone_id str
    The zone identifier to target for the resource.
    rules List<Property Map>
    List of Cloud Connector Rules
    zoneId String
    The zone identifier to target for the resource.

    Supporting Types

    CloudConnectorRulesRule, CloudConnectorRulesRuleArgs

    Expression string
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    Provider string
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    Description string
    Brief summary of the cloud connector rule and its intended use.
    Enabled bool
    Whether the headers rule is active.
    Parameters CloudConnectorRulesRuleParameters
    Cloud Connector Rule Parameters
    Expression string
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    Provider string
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    Description string
    Brief summary of the cloud connector rule and its intended use.
    Enabled bool
    Whether the headers rule is active.
    Parameters CloudConnectorRulesRuleParameters
    Cloud Connector Rule Parameters
    expression String
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    provider String
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    description String
    Brief summary of the cloud connector rule and its intended use.
    enabled Boolean
    Whether the headers rule is active.
    parameters CloudConnectorRulesRuleParameters
    Cloud Connector Rule Parameters
    expression string
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    provider string
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    description string
    Brief summary of the cloud connector rule and its intended use.
    enabled boolean
    Whether the headers rule is active.
    parameters CloudConnectorRulesRuleParameters
    Cloud Connector Rule Parameters
    expression str
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    provider str
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    description str
    Brief summary of the cloud connector rule and its intended use.
    enabled bool
    Whether the headers rule is active.
    parameters CloudConnectorRulesRuleParameters
    Cloud Connector Rule Parameters
    expression String
    Criteria for an HTTP request to trigger the cloud connector rule. Uses the Firewall Rules expression language based on Wireshark display filters.
    provider String
    Type of provider. Available values: aws_s3, cloudflare_r2, azure_storage, gcp_storage
    description String
    Brief summary of the cloud connector rule and its intended use.
    enabled Boolean
    Whether the headers rule is active.
    parameters Property Map
    Cloud Connector Rule Parameters

    CloudConnectorRulesRuleParameters, CloudConnectorRulesRuleParametersArgs

    Host string
    Host parameter for cloud connector rule
    Host string
    Host parameter for cloud connector rule
    host String
    Host parameter for cloud connector rule
    host string
    Host parameter for cloud connector rule
    host str
    Host parameter for cloud connector rule
    host String
    Host parameter for cloud connector rule

    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.39.1 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-cloudflare