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

cloudflare.Argo

Explore with Pulumi AI

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

    Cloudflare Argo controls the routing to your origin and tiered caching options to speed up your website browsing experience.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.Argo("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        tieredCaching: "on",
        smartRouting: "on",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.Argo("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        tiered_caching="on",
        smart_routing="on")
    
    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.NewArgo(ctx, "example", &cloudflare.ArgoArgs{
    			ZoneId:        pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			TieredCaching: pulumi.String("on"),
    			SmartRouting:  pulumi.String("on"),
    		})
    		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.Argo("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            TieredCaching = "on",
            SmartRouting = "on",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.Argo;
    import com.pulumi.cloudflare.ArgoArgs;
    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 Argo("example", ArgoArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .tieredCaching("on")
                .smartRouting("on")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:Argo
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          tieredCaching: on
          smartRouting: on
    

    Create Argo Resource

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

    Constructor syntax

    new Argo(name: string, args: ArgoArgs, opts?: CustomResourceOptions);
    @overload
    def Argo(resource_name: str,
             args: ArgoArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Argo(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             zone_id: Optional[str] = None,
             smart_routing: Optional[str] = None,
             tiered_caching: Optional[str] = None)
    func NewArgo(ctx *Context, name string, args ArgoArgs, opts ...ResourceOption) (*Argo, error)
    public Argo(string name, ArgoArgs args, CustomResourceOptions? opts = null)
    public Argo(String name, ArgoArgs args)
    public Argo(String name, ArgoArgs args, CustomResourceOptions options)
    
    type: cloudflare:Argo
    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 ArgoArgs
    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 ArgoArgs
    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 ArgoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ArgoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ArgoArgs
    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 argoResource = new Cloudflare.Argo("argoResource", new()
    {
        ZoneId = "string",
        SmartRouting = "string",
    });
    
    example, err := cloudflare.NewArgo(ctx, "argoResource", &cloudflare.ArgoArgs{
    	ZoneId:       pulumi.String("string"),
    	SmartRouting: pulumi.String("string"),
    })
    
    var argoResource = new Argo("argoResource", ArgoArgs.builder()
        .zoneId("string")
        .smartRouting("string")
        .build());
    
    argo_resource = cloudflare.Argo("argoResource",
        zone_id="string",
        smart_routing="string")
    
    const argoResource = new cloudflare.Argo("argoResource", {
        zoneId: "string",
        smartRouting: "string",
    });
    
    type: cloudflare:Argo
    properties:
        smartRouting: string
        zoneId: string
    

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

    ZoneId string
    The zone identifier to target for the resource.
    SmartRouting string
    Whether smart routing is enabled. Available values: on, off.
    TieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    ZoneId string
    The zone identifier to target for the resource.
    SmartRouting string
    Whether smart routing is enabled. Available values: on, off.
    TieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId String
    The zone identifier to target for the resource.
    smartRouting String
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching String
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId string
    The zone identifier to target for the resource.
    smartRouting string
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zone_id str
    The zone identifier to target for the resource.
    smart_routing str
    Whether smart routing is enabled. Available values: on, off.
    tiered_caching str
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId String
    The zone identifier to target for the resource.
    smartRouting String
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching String
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Argo 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 Argo Resource

    Get an existing Argo 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?: ArgoState, opts?: CustomResourceOptions): Argo
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            smart_routing: Optional[str] = None,
            tiered_caching: Optional[str] = None,
            zone_id: Optional[str] = None) -> Argo
    func GetArgo(ctx *Context, name string, id IDInput, state *ArgoState, opts ...ResourceOption) (*Argo, error)
    public static Argo Get(string name, Input<string> id, ArgoState? state, CustomResourceOptions? opts = null)
    public static Argo get(String name, Output<String> id, ArgoState 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:
    SmartRouting string
    Whether smart routing is enabled. Available values: on, off.
    TieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    ZoneId string
    The zone identifier to target for the resource.
    SmartRouting string
    Whether smart routing is enabled. Available values: on, off.
    TieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    ZoneId string
    The zone identifier to target for the resource.
    smartRouting String
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching String
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId String
    The zone identifier to target for the resource.
    smartRouting string
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching string
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId string
    The zone identifier to target for the resource.
    smart_routing str
    Whether smart routing is enabled. Available values: on, off.
    tiered_caching str
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zone_id str
    The zone identifier to target for the resource.
    smartRouting String
    Whether smart routing is enabled. Available values: on, off.
    tieredCaching String
    Whether tiered caching is enabled. Available values: on, off.

    Deprecated: tiered_caching has been deprecated in favour of using cloudflare.TieredCache resource instead.

    zoneId String
    The zone identifier to target for the resource.

    Import

    $ pulumi import cloudflare:index/argo:Argo example <zone_id>
    

    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