Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. AccessMutualTlsHostnameSettings
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.AccessMutualTlsHostnameSettings

Explore with Pulumi AI

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

    Provides a Cloudflare Access Mutual TLS Certificate Settings resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.AccessMutualTlsHostnameSettings("example", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    settings: [{
        hostname: "example.com",
        clientCertificateForwarding: true,
        chinaNetwork: false,
    }],
});

    import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.AccessMutualTlsHostnameSettings("example",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    settings=[{
        "hostname": "example.com",
        "client_certificate_forwarding": True,
        "china_network": False,
    }])

    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.NewAccessMutualTlsHostnameSettings(ctx, "example", &cloudflare.AccessMutualTlsHostnameSettingsArgs{
			ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Settings: cloudflare.AccessMutualTlsHostnameSettingsSettingArray{
				&cloudflare.AccessMutualTlsHostnameSettingsSettingArgs{
					Hostname:                    pulumi.String("example.com"),
					ClientCertificateForwarding: pulumi.Bool(true),
					ChinaNetwork:                pulumi.Bool(false),
				},
			},
		})
		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.AccessMutualTlsHostnameSettings("example", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Settings = new[]
        {
            new Cloudflare.Inputs.AccessMutualTlsHostnameSettingsSettingArgs
            {
                Hostname = "example.com",
                ClientCertificateForwarding = true,
                ChinaNetwork = false,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.AccessMutualTlsHostnameSettings;
import com.pulumi.cloudflare.AccessMutualTlsHostnameSettingsArgs;
import com.pulumi.cloudflare.inputs.AccessMutualTlsHostnameSettingsSettingArgs;
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 AccessMutualTlsHostnameSettings("example", AccessMutualTlsHostnameSettingsArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .settings(AccessMutualTlsHostnameSettingsSettingArgs.builder()
                .hostname("example.com")
                .clientCertificateForwarding(true)
                .chinaNetwork(false)
                .build())
            .build());

    }
}

    resources:
  example:
    type: cloudflare:AccessMutualTlsHostnameSettings
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      settings:
        - hostname: example.com
          clientCertificateForwarding: true
          chinaNetwork: false

    Create AccessMutualTlsHostnameSettings Resource

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

    Constructor syntax

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

@overload
def AccessMutualTlsHostnameSettings(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    account_id: Optional[str] = None,
                                    settings: Optional[Sequence[AccessMutualTlsHostnameSettingsSettingArgs]] = None,
                                    zone_id: Optional[str] = None)
    func NewAccessMutualTlsHostnameSettings(ctx *Context, name string, args *AccessMutualTlsHostnameSettingsArgs, opts ...ResourceOption) (*AccessMutualTlsHostnameSettings, error)
    public AccessMutualTlsHostnameSettings(string name, AccessMutualTlsHostnameSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public AccessMutualTlsHostnameSettings(String name, AccessMutualTlsHostnameSettingsArgs args)
public AccessMutualTlsHostnameSettings(String name, AccessMutualTlsHostnameSettingsArgs args, CustomResourceOptions options)

    type: cloudflare:AccessMutualTlsHostnameSettings
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 AccessMutualTlsHostnameSettingsArgs
    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 AccessMutualTlsHostnameSettingsArgs
    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 AccessMutualTlsHostnameSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessMutualTlsHostnameSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessMutualTlsHostnameSettingsArgs
    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 accessMutualTlsHostnameSettingsResource = new Cloudflare.AccessMutualTlsHostnameSettings("accessMutualTlsHostnameSettingsResource", new()
{
    AccountId = "string",
    Settings = new[]
    {
        new Cloudflare.Inputs.AccessMutualTlsHostnameSettingsSettingArgs
        {
            Hostname = "string",
            ChinaNetwork = false,
            ClientCertificateForwarding = false,
        },
    },
    ZoneId = "string",
});

    example, err := cloudflare.NewAccessMutualTlsHostnameSettings(ctx, "accessMutualTlsHostnameSettingsResource", &cloudflare.AccessMutualTlsHostnameSettingsArgs{
	AccountId: pulumi.String("string"),
	Settings: cloudflare.AccessMutualTlsHostnameSettingsSettingArray{
		&cloudflare.AccessMutualTlsHostnameSettingsSettingArgs{
			Hostname:                    pulumi.String("string"),
			ChinaNetwork:                pulumi.Bool(false),
			ClientCertificateForwarding: pulumi.Bool(false),
		},
	},
	ZoneId: pulumi.String("string"),
})

    var accessMutualTlsHostnameSettingsResource = new AccessMutualTlsHostnameSettings("accessMutualTlsHostnameSettingsResource", AccessMutualTlsHostnameSettingsArgs.builder()
    .accountId("string")
    .settings(AccessMutualTlsHostnameSettingsSettingArgs.builder()
        .hostname("string")
        .chinaNetwork(false)
        .clientCertificateForwarding(false)
        .build())
    .zoneId("string")
    .build());

    access_mutual_tls_hostname_settings_resource = cloudflare.AccessMutualTlsHostnameSettings("accessMutualTlsHostnameSettingsResource",
    account_id="string",
    settings=[{
        "hostname": "string",
        "china_network": False,
        "client_certificate_forwarding": False,
    }],
    zone_id="string")

    const accessMutualTlsHostnameSettingsResource = new cloudflare.AccessMutualTlsHostnameSettings("accessMutualTlsHostnameSettingsResource", {
    accountId: "string",
    settings: [{
        hostname: "string",
        chinaNetwork: false,
        clientCertificateForwarding: false,
    }],
    zoneId: "string",
});

    type: cloudflare:AccessMutualTlsHostnameSettings
properties:
    accountId: string
    settings:
        - chinaNetwork: false
          clientCertificateForwarding: false
          hostname: string
    zoneId: string

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

    AccountId string
    The account identifier to target for the resource.
    Settings List<AccessMutualTlsHostnameSettingsSetting>
    ZoneId string
    The zone identifier to target for the resource.
    AccountId string
    The account identifier to target for the resource.
    Settings []AccessMutualTlsHostnameSettingsSettingArgs
    ZoneId string
    The zone identifier to target for the resource.
    accountId String
    The account identifier to target for the resource.
    settings List<AccessMutualTlsHostnameSettingsSetting>
    zoneId String
    The zone identifier to target for the resource.
    accountId string
    The account identifier to target for the resource.
    settings AccessMutualTlsHostnameSettingsSetting[]
    zoneId string
    The zone identifier to target for the resource.
    account_id str
    The account identifier to target for the resource.
    settings Sequence[AccessMutualTlsHostnameSettingsSettingArgs]
    zone_id str
    The zone identifier to target for the resource.
    accountId String
    The account identifier to target for the resource.
    settings List<Property Map>
    zoneId String
    The zone identifier to target for the resource.

    Outputs

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

    Get an existing AccessMutualTlsHostnameSettings 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?: AccessMutualTlsHostnameSettingsState, opts?: CustomResourceOptions): AccessMutualTlsHostnameSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        settings: Optional[Sequence[AccessMutualTlsHostnameSettingsSettingArgs]] = None,
        zone_id: Optional[str] = None) -> AccessMutualTlsHostnameSettings
    func GetAccessMutualTlsHostnameSettings(ctx *Context, name string, id IDInput, state *AccessMutualTlsHostnameSettingsState, opts ...ResourceOption) (*AccessMutualTlsHostnameSettings, error)
    public static AccessMutualTlsHostnameSettings Get(string name, Input<string> id, AccessMutualTlsHostnameSettingsState? state, CustomResourceOptions? opts = null)
    public static AccessMutualTlsHostnameSettings get(String name, Output<String> id, AccessMutualTlsHostnameSettingsState 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:
    AccountId string
    The account identifier to target for the resource.
    Settings List<AccessMutualTlsHostnameSettingsSetting>
    ZoneId string
    The zone identifier to target for the resource.
    AccountId string
    The account identifier to target for the resource.
    Settings []AccessMutualTlsHostnameSettingsSettingArgs
    ZoneId string
    The zone identifier to target for the resource.
    accountId String
    The account identifier to target for the resource.
    settings List<AccessMutualTlsHostnameSettingsSetting>
    zoneId String
    The zone identifier to target for the resource.
    accountId string
    The account identifier to target for the resource.
    settings AccessMutualTlsHostnameSettingsSetting[]
    zoneId string
    The zone identifier to target for the resource.
    account_id str
    The account identifier to target for the resource.
    settings Sequence[AccessMutualTlsHostnameSettingsSettingArgs]
    zone_id str
    The zone identifier to target for the resource.
    accountId String
    The account identifier to target for the resource.
    settings List<Property Map>
    zoneId String
    The zone identifier to target for the resource.

    Supporting Types

    AccessMutualTlsHostnameSettingsSetting, AccessMutualTlsHostnameSettingsSettingArgs

    Hostname string
    The hostname that these settings apply to.
    ChinaNetwork bool
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    ClientCertificateForwarding bool
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
    Hostname string
    The hostname that these settings apply to.
    ChinaNetwork bool
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    ClientCertificateForwarding bool
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
    hostname String
    The hostname that these settings apply to.
    chinaNetwork Boolean
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    clientCertificateForwarding Boolean
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
    hostname string
    The hostname that these settings apply to.
    chinaNetwork boolean
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    clientCertificateForwarding boolean
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
    hostname str
    The hostname that these settings apply to.
    china_network bool
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    client_certificate_forwarding bool
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
    hostname String
    The hostname that these settings apply to.
    chinaNetwork Boolean
    Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
    clientCertificateForwarding Boolean
    Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.

    Import

    Account level mTLS hostname settings import.

    $ pulumi import cloudflare:index/accessMutualTlsHostnameSettings:AccessMutualTlsHostnameSettings example account/<account_id>

    Zone level mTLS hostname settings import.

    $ pulumi import cloudflare:index/accessMutualTlsHostnameSettings:AccessMutualTlsHostnameSettings example zone/<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
    pulumi/pulumi-cloudflare