1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. TotalTls
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi

cloudflare.TotalTls

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi

    Provides a resource which manages Total TLS for a zone.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.TotalTls("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        enabled: true,
        certificateAuthority: "lets_encrypt",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.TotalTls("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        enabled=True,
        certificate_authority="lets_encrypt")
    
    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.NewTotalTls(ctx, "example", &cloudflare.TotalTlsArgs{
    			ZoneId:               pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			Enabled:              pulumi.Bool(true),
    			CertificateAuthority: pulumi.String("lets_encrypt"),
    		})
    		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.TotalTls("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            Enabled = true,
            CertificateAuthority = "lets_encrypt",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.TotalTls;
    import com.pulumi.cloudflare.TotalTlsArgs;
    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 TotalTls("example", TotalTlsArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .enabled(true)
                .certificateAuthority("lets_encrypt")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:TotalTls
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          enabled: true
          certificateAuthority: lets_encrypt
    

    Create TotalTls Resource

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

    Constructor syntax

    new TotalTls(name: string, args: TotalTlsArgs, opts?: CustomResourceOptions);
    @overload
    def TotalTls(resource_name: str,
                 args: TotalTlsArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def TotalTls(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 enabled: Optional[bool] = None,
                 zone_id: Optional[str] = None,
                 certificate_authority: Optional[str] = None)
    func NewTotalTls(ctx *Context, name string, args TotalTlsArgs, opts ...ResourceOption) (*TotalTls, error)
    public TotalTls(string name, TotalTlsArgs args, CustomResourceOptions? opts = null)
    public TotalTls(String name, TotalTlsArgs args)
    public TotalTls(String name, TotalTlsArgs args, CustomResourceOptions options)
    
    type: cloudflare:TotalTls
    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 TotalTlsArgs
    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 TotalTlsArgs
    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 TotalTlsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TotalTlsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TotalTlsArgs
    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 totalTlsResource = new Cloudflare.TotalTls("totalTlsResource", new()
    {
        Enabled = false,
        ZoneId = "string",
        CertificateAuthority = "string",
    });
    
    example, err := cloudflare.NewTotalTls(ctx, "totalTlsResource", &cloudflare.TotalTlsArgs{
    	Enabled:              pulumi.Bool(false),
    	ZoneId:               pulumi.String("string"),
    	CertificateAuthority: pulumi.String("string"),
    })
    
    var totalTlsResource = new TotalTls("totalTlsResource", TotalTlsArgs.builder()
        .enabled(false)
        .zoneId("string")
        .certificateAuthority("string")
        .build());
    
    total_tls_resource = cloudflare.TotalTls("totalTlsResource",
        enabled=False,
        zone_id="string",
        certificate_authority="string")
    
    const totalTlsResource = new cloudflare.TotalTls("totalTlsResource", {
        enabled: false,
        zoneId: "string",
        certificateAuthority: "string",
    });
    
    type: cloudflare:TotalTls
    properties:
        certificateAuthority: string
        enabled: false
        zoneId: string
    

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

    Enabled bool
    Enable Total TLS for the zone.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CertificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    Enabled bool
    Enable Total TLS for the zone.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CertificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled Boolean
    Enable Total TLS for the zone.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority String
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled boolean
    Enable Total TLS for the zone.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled bool
    Enable Total TLS for the zone.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificate_authority str
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled Boolean
    Enable Total TLS for the zone.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority String
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.

    Outputs

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

    Get an existing TotalTls 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?: TotalTlsState, opts?: CustomResourceOptions): TotalTls
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_authority: Optional[str] = None,
            enabled: Optional[bool] = None,
            zone_id: Optional[str] = None) -> TotalTls
    func GetTotalTls(ctx *Context, name string, id IDInput, state *TotalTlsState, opts ...ResourceOption) (*TotalTls, error)
    public static TotalTls Get(string name, Input<string> id, TotalTlsState? state, CustomResourceOptions? opts = null)
    public static TotalTls get(String name, Output<String> id, TotalTlsState 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:
    CertificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    Enabled bool
    Enable Total TLS for the zone.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CertificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    Enabled bool
    Enable Total TLS for the zone.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority String
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled Boolean
    Enable Total TLS for the zone.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority string
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled boolean
    Enable Total TLS for the zone.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificate_authority str
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled bool
    Enable Total TLS for the zone.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    certificateAuthority String
    The Certificate Authority that Total TLS certificates will be issued through. Available values: google, lets_encrypt.
    enabled Boolean
    Enable Total TLS for the zone.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

    Import

    $ pulumi import cloudflare:index/totalTls:TotalTls 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.43.0 published on Wednesday, Nov 13, 2024 by Pulumi