Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.ZeroTrustGatewaySettings

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleZeroTrustGatewaySettings:
    type: cloudflare:ZeroTrustGatewaySettings
    name: example_zero_trust_gateway_settings
    properties:
      accountId: 699d98642c564d2e855e9661899b7252
      settings:
        activity_log:
          enabled: true
        antivirus:
          enabledDownloadPhase: false
          enabledUploadPhase: false
          failClosed: false
          notificationSettings:
            enabled: true
            msg: msg
            supportUrl: support_url
        block_page:
          backgroundColor: background_color
          enabled: true
          footerText: --footer--
          headerText: --header--
          includeContext: true
          logoPath: https://logos.com/a.png
          mailtoAddress: admin@example.com
          mailtoSubject: Blocked User Inquiry
          mode: customized_block_page
          name: Cloudflare
          suppressFooter: false
          targetUri: https://example.com
        body_scanning:
          inspectionMode: deep
        browser_isolation:
          nonIdentityEnabled: true
          urlBrowserIsolationEnabled: true
        certificate:
          id: d1b364c5-1311-466e-a194-f0e943e0799f
        custom_certificate:
          enabled: true
          id: d1b364c5-1311-466e-a194-f0e943e0799f
        extended_email_matching:
          enabled: true
        fips:
          tls: true
        protocol_detection:
          enabled: true
        sandbox:
          enabled: true
          fallbackAction: allow
        tls_decrypt:
          enabled: true

Create ZeroTrustGatewaySettings Resource

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

Constructor syntax

new ZeroTrustGatewaySettings(name: string, args: ZeroTrustGatewaySettingsArgs, opts?: CustomResourceOptions);

@overload
def ZeroTrustGatewaySettings(resource_name: str,
                             args: ZeroTrustGatewaySettingsArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def ZeroTrustGatewaySettings(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             account_id: Optional[str] = None,
                             settings: Optional[ZeroTrustGatewaySettingsSettingsArgs] = None)

func NewZeroTrustGatewaySettings(ctx *Context, name string, args ZeroTrustGatewaySettingsArgs, opts ...ResourceOption) (*ZeroTrustGatewaySettings, error)

public ZeroTrustGatewaySettings(string name, ZeroTrustGatewaySettingsArgs args, CustomResourceOptions? opts = null)

public ZeroTrustGatewaySettings(String name, ZeroTrustGatewaySettingsArgs args)
public ZeroTrustGatewaySettings(String name, ZeroTrustGatewaySettingsArgs args, CustomResourceOptions options)

type: cloudflare:ZeroTrustGatewaySettings
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 ZeroTrustGatewaySettingsArgs: 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 ZeroTrustGatewaySettingsArgs: 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 ZeroTrustGatewaySettingsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ZeroTrustGatewaySettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ZeroTrustGatewaySettingsArgs: 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 zeroTrustGatewaySettingsResource = new Cloudflare.ZeroTrustGatewaySettings("zeroTrustGatewaySettingsResource", new()
{
    AccountId = "string",
    Settings = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsArgs
    {
        ActivityLog = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsActivityLogArgs
        {
            Enabled = false,
        },
        Antivirus = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsAntivirusArgs
        {
            EnabledDownloadPhase = false,
            EnabledUploadPhase = false,
            FailClosed = false,
            NotificationSettings = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettingsArgs
            {
                Enabled = false,
                Msg = "string",
                SupportUrl = "string",
            },
        },
        BlockPage = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsBlockPageArgs
        {
            BackgroundColor = "string",
            Enabled = false,
            FooterText = "string",
            HeaderText = "string",
            IncludeContext = false,
            LogoPath = "string",
            MailtoAddress = "string",
            MailtoSubject = "string",
            Mode = "string",
            Name = "string",
            SuppressFooter = false,
            TargetUri = "string",
        },
        BodyScanning = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsBodyScanningArgs
        {
            InspectionMode = "string",
        },
        BrowserIsolation = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsBrowserIsolationArgs
        {
            NonIdentityEnabled = false,
            UrlBrowserIsolationEnabled = false,
        },
        Certificate = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsCertificateArgs
        {
            Id = "string",
        },
        ExtendedEmailMatching = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsExtendedEmailMatchingArgs
        {
            Enabled = false,
        },
        Fips = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsFipsArgs
        {
            Tls = false,
        },
        ProtocolDetection = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsProtocolDetectionArgs
        {
            Enabled = false,
        },
        Sandbox = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsSandboxArgs
        {
            Enabled = false,
            FallbackAction = "string",
        },
        TlsDecrypt = new Cloudflare.Inputs.ZeroTrustGatewaySettingsSettingsTlsDecryptArgs
        {
            Enabled = false,
        },
    },
});

example, err := cloudflare.NewZeroTrustGatewaySettings(ctx, "zeroTrustGatewaySettingsResource", &cloudflare.ZeroTrustGatewaySettingsArgs{
	AccountId: pulumi.String("string"),
	Settings: &cloudflare.ZeroTrustGatewaySettingsSettingsArgs{
		ActivityLog: &cloudflare.ZeroTrustGatewaySettingsSettingsActivityLogArgs{
			Enabled: pulumi.Bool(false),
		},
		Antivirus: &cloudflare.ZeroTrustGatewaySettingsSettingsAntivirusArgs{
			EnabledDownloadPhase: pulumi.Bool(false),
			EnabledUploadPhase:   pulumi.Bool(false),
			FailClosed:           pulumi.Bool(false),
			NotificationSettings: &cloudflare.ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettingsArgs{
				Enabled:    pulumi.Bool(false),
				Msg:        pulumi.String("string"),
				SupportUrl: pulumi.String("string"),
			},
		},
		BlockPage: &cloudflare.ZeroTrustGatewaySettingsSettingsBlockPageArgs{
			BackgroundColor: pulumi.String("string"),
			Enabled:         pulumi.Bool(false),
			FooterText:      pulumi.String("string"),
			HeaderText:      pulumi.String("string"),
			IncludeContext:  pulumi.Bool(false),
			LogoPath:        pulumi.String("string"),
			MailtoAddress:   pulumi.String("string"),
			MailtoSubject:   pulumi.String("string"),
			Mode:            pulumi.String("string"),
			Name:            pulumi.String("string"),
			SuppressFooter:  pulumi.Bool(false),
			TargetUri:       pulumi.String("string"),
		},
		BodyScanning: &cloudflare.ZeroTrustGatewaySettingsSettingsBodyScanningArgs{
			InspectionMode: pulumi.String("string"),
		},
		BrowserIsolation: &cloudflare.ZeroTrustGatewaySettingsSettingsBrowserIsolationArgs{
			NonIdentityEnabled:         pulumi.Bool(false),
			UrlBrowserIsolationEnabled: pulumi.Bool(false),
		},
		Certificate: &cloudflare.ZeroTrustGatewaySettingsSettingsCertificateArgs{
			Id: pulumi.String("string"),
		},
		ExtendedEmailMatching: &cloudflare.ZeroTrustGatewaySettingsSettingsExtendedEmailMatchingArgs{
			Enabled: pulumi.Bool(false),
		},
		Fips: &cloudflare.ZeroTrustGatewaySettingsSettingsFipsArgs{
			Tls: pulumi.Bool(false),
		},
		ProtocolDetection: &cloudflare.ZeroTrustGatewaySettingsSettingsProtocolDetectionArgs{
			Enabled: pulumi.Bool(false),
		},
		Sandbox: &cloudflare.ZeroTrustGatewaySettingsSettingsSandboxArgs{
			Enabled:        pulumi.Bool(false),
			FallbackAction: pulumi.String("string"),
		},
		TlsDecrypt: &cloudflare.ZeroTrustGatewaySettingsSettingsTlsDecryptArgs{
			Enabled: pulumi.Bool(false),
		},
	},
})

var zeroTrustGatewaySettingsResource = new ZeroTrustGatewaySettings("zeroTrustGatewaySettingsResource", ZeroTrustGatewaySettingsArgs.builder()
    .accountId("string")
    .settings(ZeroTrustGatewaySettingsSettingsArgs.builder()
        .activityLog(ZeroTrustGatewaySettingsSettingsActivityLogArgs.builder()
            .enabled(false)
            .build())
        .antivirus(ZeroTrustGatewaySettingsSettingsAntivirusArgs.builder()
            .enabledDownloadPhase(false)
            .enabledUploadPhase(false)
            .failClosed(false)
            .notificationSettings(ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettingsArgs.builder()
                .enabled(false)
                .msg("string")
                .supportUrl("string")
                .build())
            .build())
        .blockPage(ZeroTrustGatewaySettingsSettingsBlockPageArgs.builder()
            .backgroundColor("string")
            .enabled(false)
            .footerText("string")
            .headerText("string")
            .includeContext(false)
            .logoPath("string")
            .mailtoAddress("string")
            .mailtoSubject("string")
            .mode("string")
            .name("string")
            .suppressFooter(false)
            .targetUri("string")
            .build())
        .bodyScanning(ZeroTrustGatewaySettingsSettingsBodyScanningArgs.builder()
            .inspectionMode("string")
            .build())
        .browserIsolation(ZeroTrustGatewaySettingsSettingsBrowserIsolationArgs.builder()
            .nonIdentityEnabled(false)
            .urlBrowserIsolationEnabled(false)
            .build())
        .certificate(ZeroTrustGatewaySettingsSettingsCertificateArgs.builder()
            .id("string")
            .build())
        .extendedEmailMatching(ZeroTrustGatewaySettingsSettingsExtendedEmailMatchingArgs.builder()
            .enabled(false)
            .build())
        .fips(ZeroTrustGatewaySettingsSettingsFipsArgs.builder()
            .tls(false)
            .build())
        .protocolDetection(ZeroTrustGatewaySettingsSettingsProtocolDetectionArgs.builder()
            .enabled(false)
            .build())
        .sandbox(ZeroTrustGatewaySettingsSettingsSandboxArgs.builder()
            .enabled(false)
            .fallbackAction("string")
            .build())
        .tlsDecrypt(ZeroTrustGatewaySettingsSettingsTlsDecryptArgs.builder()
            .enabled(false)
            .build())
        .build())
    .build());

zero_trust_gateway_settings_resource = cloudflare.ZeroTrustGatewaySettings("zeroTrustGatewaySettingsResource",
    account_id="string",
    settings={
        "activity_log": {
            "enabled": False,
        },
        "antivirus": {
            "enabled_download_phase": False,
            "enabled_upload_phase": False,
            "fail_closed": False,
            "notification_settings": {
                "enabled": False,
                "msg": "string",
                "support_url": "string",
            },
        },
        "block_page": {
            "background_color": "string",
            "enabled": False,
            "footer_text": "string",
            "header_text": "string",
            "include_context": False,
            "logo_path": "string",
            "mailto_address": "string",
            "mailto_subject": "string",
            "mode": "string",
            "name": "string",
            "suppress_footer": False,
            "target_uri": "string",
        },
        "body_scanning": {
            "inspection_mode": "string",
        },
        "browser_isolation": {
            "non_identity_enabled": False,
            "url_browser_isolation_enabled": False,
        },
        "certificate": {
            "id": "string",
        },
        "extended_email_matching": {
            "enabled": False,
        },
        "fips": {
            "tls": False,
        },
        "protocol_detection": {
            "enabled": False,
        },
        "sandbox": {
            "enabled": False,
            "fallback_action": "string",
        },
        "tls_decrypt": {
            "enabled": False,
        },
    })

const zeroTrustGatewaySettingsResource = new cloudflare.ZeroTrustGatewaySettings("zeroTrustGatewaySettingsResource", {
    accountId: "string",
    settings: {
        activityLog: {
            enabled: false,
        },
        antivirus: {
            enabledDownloadPhase: false,
            enabledUploadPhase: false,
            failClosed: false,
            notificationSettings: {
                enabled: false,
                msg: "string",
                supportUrl: "string",
            },
        },
        blockPage: {
            backgroundColor: "string",
            enabled: false,
            footerText: "string",
            headerText: "string",
            includeContext: false,
            logoPath: "string",
            mailtoAddress: "string",
            mailtoSubject: "string",
            mode: "string",
            name: "string",
            suppressFooter: false,
            targetUri: "string",
        },
        bodyScanning: {
            inspectionMode: "string",
        },
        browserIsolation: {
            nonIdentityEnabled: false,
            urlBrowserIsolationEnabled: false,
        },
        certificate: {
            id: "string",
        },
        extendedEmailMatching: {
            enabled: false,
        },
        fips: {
            tls: false,
        },
        protocolDetection: {
            enabled: false,
        },
        sandbox: {
            enabled: false,
            fallbackAction: "string",
        },
        tlsDecrypt: {
            enabled: false,
        },
    },
});

type: cloudflare:ZeroTrustGatewaySettings
properties:
    accountId: string
    settings:
        activityLog:
            enabled: false
        antivirus:
            enabledDownloadPhase: false
            enabledUploadPhase: false
            failClosed: false
            notificationSettings:
                enabled: false
                msg: string
                supportUrl: string
        blockPage:
            backgroundColor: string
            enabled: false
            footerText: string
            headerText: string
            includeContext: false
            logoPath: string
            mailtoAddress: string
            mailtoSubject: string
            mode: string
            name: string
            suppressFooter: false
            targetUri: string
        bodyScanning:
            inspectionMode: string
        browserIsolation:
            nonIdentityEnabled: false
            urlBrowserIsolationEnabled: false
        certificate:
            id: string
        extendedEmailMatching:
            enabled: false
        fips:
            tls: false
        protocolDetection:
            enabled: false
        sandbox:
            enabled: false
            fallbackAction: string
        tlsDecrypt:
            enabled: false

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

AccountId string
Settings ZeroTrustGatewaySettingsSettings: Account settings

AccountId string
Settings ZeroTrustGatewaySettingsSettingsArgs: Account settings

accountId String
settings ZeroTrustGatewaySettingsSettings: Account settings

accountId string
settings ZeroTrustGatewaySettingsSettings: Account settings

account_id str
settings ZeroTrustGatewaySettingsSettingsArgs: Account settings

accountId String
settings Property Map: Account settings

Outputs

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

CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string

CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string

createdAt String
id String: The provider-assigned unique ID for this managed resource.
updatedAt String

createdAt string
id string: The provider-assigned unique ID for this managed resource.
updatedAt string

created_at str
id str: The provider-assigned unique ID for this managed resource.
updated_at str

createdAt String
id String: The provider-assigned unique ID for this managed resource.
updatedAt String

Look up Existing ZeroTrustGatewaySettings Resource

Get an existing ZeroTrustGatewaySettings 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?: ZeroTrustGatewaySettingsState, opts?: CustomResourceOptions): ZeroTrustGatewaySettings

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        created_at: Optional[str] = None,
        settings: Optional[ZeroTrustGatewaySettingsSettingsArgs] = None,
        updated_at: Optional[str] = None) -> ZeroTrustGatewaySettings

func GetZeroTrustGatewaySettings(ctx *Context, name string, id IDInput, state *ZeroTrustGatewaySettingsState, opts ...ResourceOption) (*ZeroTrustGatewaySettings, error)

public static ZeroTrustGatewaySettings Get(string name, Input<string> id, ZeroTrustGatewaySettingsState? state, CustomResourceOptions? opts = null)

public static ZeroTrustGatewaySettings get(String name, Output<String> id, ZeroTrustGatewaySettingsState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:ZeroTrustGatewaySettings    get:      id: ${id}

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
CreatedAt string
Settings ZeroTrustGatewaySettingsSettings: Account settings
UpdatedAt string

AccountId string
CreatedAt string
Settings ZeroTrustGatewaySettingsSettingsArgs: Account settings
UpdatedAt string

accountId String
createdAt String
settings ZeroTrustGatewaySettingsSettings: Account settings
updatedAt String

accountId string
createdAt string
settings ZeroTrustGatewaySettingsSettings: Account settings
updatedAt string

account_id str
created_at str
settings ZeroTrustGatewaySettingsSettingsArgs: Account settings
updated_at str

accountId String
createdAt String
settings Property Map: Account settings
updatedAt String

Supporting Types

ZeroTrustGatewaySettingsSettings, ZeroTrustGatewaySettingsSettingsArgs

ActivityLog ZeroTrustGatewaySettingsSettingsActivityLog: Activity log settings.
Antivirus ZeroTrustGatewaySettingsSettingsAntivirus: Anti-virus settings.
BlockPage ZeroTrustGatewaySettingsSettingsBlockPage: Block page layout settings.
BodyScanning ZeroTrustGatewaySettingsSettingsBodyScanning: DLP body scanning settings.
BrowserIsolation ZeroTrustGatewaySettingsSettingsBrowserIsolation: Browser isolation settings.
Certificate ZeroTrustGatewaySettingsSettingsCertificate: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
CustomCertificate ZeroTrustGatewaySettingsSettingsCustomCertificate: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
ExtendedEmailMatching ZeroTrustGatewaySettingsSettingsExtendedEmailMatching: Extended e-mail matching settings.
Fips ZeroTrustGatewaySettingsSettingsFips: FIPS settings.
ProtocolDetection ZeroTrustGatewaySettingsSettingsProtocolDetection: Protocol Detection settings.
Sandbox ZeroTrustGatewaySettingsSettingsSandbox: Sandbox settings.
TlsDecrypt ZeroTrustGatewaySettingsSettingsTlsDecrypt: TLS interception settings.

ActivityLog ZeroTrustGatewaySettingsSettingsActivityLog: Activity log settings.
Antivirus ZeroTrustGatewaySettingsSettingsAntivirus: Anti-virus settings.
BlockPage ZeroTrustGatewaySettingsSettingsBlockPage: Block page layout settings.
BodyScanning ZeroTrustGatewaySettingsSettingsBodyScanning: DLP body scanning settings.
BrowserIsolation ZeroTrustGatewaySettingsSettingsBrowserIsolation: Browser isolation settings.
Certificate ZeroTrustGatewaySettingsSettingsCertificate: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
CustomCertificate ZeroTrustGatewaySettingsSettingsCustomCertificate: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
ExtendedEmailMatching ZeroTrustGatewaySettingsSettingsExtendedEmailMatching: Extended e-mail matching settings.
Fips ZeroTrustGatewaySettingsSettingsFips: FIPS settings.
ProtocolDetection ZeroTrustGatewaySettingsSettingsProtocolDetection: Protocol Detection settings.
Sandbox ZeroTrustGatewaySettingsSettingsSandbox: Sandbox settings.
TlsDecrypt ZeroTrustGatewaySettingsSettingsTlsDecrypt: TLS interception settings.

activityLog ZeroTrustGatewaySettingsSettingsActivityLog: Activity log settings.
antivirus ZeroTrustGatewaySettingsSettingsAntivirus: Anti-virus settings.
blockPage ZeroTrustGatewaySettingsSettingsBlockPage: Block page layout settings.
bodyScanning ZeroTrustGatewaySettingsSettingsBodyScanning: DLP body scanning settings.
browserIsolation ZeroTrustGatewaySettingsSettingsBrowserIsolation: Browser isolation settings.
certificate ZeroTrustGatewaySettingsSettingsCertificate: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
customCertificate ZeroTrustGatewaySettingsSettingsCustomCertificate: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
extendedEmailMatching ZeroTrustGatewaySettingsSettingsExtendedEmailMatching: Extended e-mail matching settings.
fips ZeroTrustGatewaySettingsSettingsFips: FIPS settings.
protocolDetection ZeroTrustGatewaySettingsSettingsProtocolDetection: Protocol Detection settings.
sandbox ZeroTrustGatewaySettingsSettingsSandbox: Sandbox settings.
tlsDecrypt ZeroTrustGatewaySettingsSettingsTlsDecrypt: TLS interception settings.

activityLog ZeroTrustGatewaySettingsSettingsActivityLog: Activity log settings.
antivirus ZeroTrustGatewaySettingsSettingsAntivirus: Anti-virus settings.
blockPage ZeroTrustGatewaySettingsSettingsBlockPage: Block page layout settings.
bodyScanning ZeroTrustGatewaySettingsSettingsBodyScanning: DLP body scanning settings.
browserIsolation ZeroTrustGatewaySettingsSettingsBrowserIsolation: Browser isolation settings.
certificate ZeroTrustGatewaySettingsSettingsCertificate: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
customCertificate ZeroTrustGatewaySettingsSettingsCustomCertificate: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
extendedEmailMatching ZeroTrustGatewaySettingsSettingsExtendedEmailMatching: Extended e-mail matching settings.
fips ZeroTrustGatewaySettingsSettingsFips: FIPS settings.
protocolDetection ZeroTrustGatewaySettingsSettingsProtocolDetection: Protocol Detection settings.
sandbox ZeroTrustGatewaySettingsSettingsSandbox: Sandbox settings.
tlsDecrypt ZeroTrustGatewaySettingsSettingsTlsDecrypt: TLS interception settings.

activity_log ZeroTrustGatewaySettingsSettingsActivityLog: Activity log settings.
antivirus ZeroTrustGatewaySettingsSettingsAntivirus: Anti-virus settings.
block_page ZeroTrustGatewaySettingsSettingsBlockPage: Block page layout settings.
body_scanning ZeroTrustGatewaySettingsSettingsBodyScanning: DLP body scanning settings.
browser_isolation ZeroTrustGatewaySettingsSettingsBrowserIsolation: Browser isolation settings.
certificate ZeroTrustGatewaySettingsSettingsCertificate: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
custom_certificate ZeroTrustGatewaySettingsSettingsCustomCertificate: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
extended_email_matching ZeroTrustGatewaySettingsSettingsExtendedEmailMatching: Extended e-mail matching settings.
fips ZeroTrustGatewaySettingsSettingsFips: FIPS settings.
protocol_detection ZeroTrustGatewaySettingsSettingsProtocolDetection: Protocol Detection settings.
sandbox ZeroTrustGatewaySettingsSettingsSandbox: Sandbox settings.
tls_decrypt ZeroTrustGatewaySettingsSettingsTlsDecrypt: TLS interception settings.

activityLog Property Map: Activity log settings.
antivirus Property Map: Anti-virus settings.
blockPage Property Map: Block page layout settings.
bodyScanning Property Map: DLP body scanning settings.
browserIsolation Property Map: Browser isolation settings.
certificate Property Map: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
customCertificate Property Map: Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
Deprecated: This attribute is deprecated.
extendedEmailMatching Property Map: Extended e-mail matching settings.
fips Property Map: FIPS settings.
protocolDetection Property Map: Protocol Detection settings.
sandbox Property Map: Sandbox settings.
tlsDecrypt Property Map: TLS interception settings.

ZeroTrustGatewaySettingsSettingsActivityLog, ZeroTrustGatewaySettingsSettingsActivityLogArgs

Enabled bool: Enable activity logging.

Enabled bool: Enable activity logging.

enabled Boolean: Enable activity logging.

enabled boolean: Enable activity logging.

enabled bool: Enable activity logging.

enabled Boolean: Enable activity logging.

ZeroTrustGatewaySettingsSettingsAntivirus, ZeroTrustGatewaySettingsSettingsAntivirusArgs

EnabledDownloadPhase bool: Enable anti-virus scanning on downloads.
EnabledUploadPhase bool: Enable anti-virus scanning on uploads.
FailClosed bool: Block requests for files that cannot be scanned.
NotificationSettings ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings: Configure a message to display on the user's device when an antivirus search is performed.

EnabledDownloadPhase bool: Enable anti-virus scanning on downloads.
EnabledUploadPhase bool: Enable anti-virus scanning on uploads.
FailClosed bool: Block requests for files that cannot be scanned.
NotificationSettings ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings: Configure a message to display on the user's device when an antivirus search is performed.

enabledDownloadPhase Boolean: Enable anti-virus scanning on downloads.
enabledUploadPhase Boolean: Enable anti-virus scanning on uploads.
failClosed Boolean: Block requests for files that cannot be scanned.
notificationSettings ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings: Configure a message to display on the user's device when an antivirus search is performed.

enabledDownloadPhase boolean: Enable anti-virus scanning on downloads.
enabledUploadPhase boolean: Enable anti-virus scanning on uploads.
failClosed boolean: Block requests for files that cannot be scanned.
notificationSettings ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings: Configure a message to display on the user's device when an antivirus search is performed.

enabled_download_phase bool: Enable anti-virus scanning on downloads.
enabled_upload_phase bool: Enable anti-virus scanning on uploads.
fail_closed bool: Block requests for files that cannot be scanned.
notification_settings ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings: Configure a message to display on the user's device when an antivirus search is performed.

enabledDownloadPhase Boolean: Enable anti-virus scanning on downloads.
enabledUploadPhase Boolean: Enable anti-virus scanning on uploads.
failClosed Boolean: Block requests for files that cannot be scanned.
notificationSettings Property Map: Configure a message to display on the user's device when an antivirus search is performed.

ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings, ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettingsArgs

Enabled bool: Set notification on
Msg string: Customize the message shown in the notification.
SupportUrl string: Optional URL to direct users to additional information. If not set, the notification will open a block page.

Enabled bool: Set notification on
Msg string: Customize the message shown in the notification.
SupportUrl string: Optional URL to direct users to additional information. If not set, the notification will open a block page.

enabled Boolean: Set notification on
msg String: Customize the message shown in the notification.
supportUrl String: Optional URL to direct users to additional information. If not set, the notification will open a block page.

enabled boolean: Set notification on
msg string: Customize the message shown in the notification.
supportUrl string: Optional URL to direct users to additional information. If not set, the notification will open a block page.

enabled bool: Set notification on
msg str: Customize the message shown in the notification.
support_url str: Optional URL to direct users to additional information. If not set, the notification will open a block page.

enabled Boolean: Set notification on
msg String: Customize the message shown in the notification.
supportUrl String: Optional URL to direct users to additional information. If not set, the notification will open a block page.

ZeroTrustGatewaySettingsSettingsBlockPage, ZeroTrustGatewaySettingsSettingsBlockPageArgs

BackgroundColor string: If mode is customizedblockpage: block page background color in #rrggbb format.
Enabled bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
FooterText string: If mode is customizedblockpage: block page footer text.
HeaderText string: If mode is customizedblockpage: block page header text.
IncludeContext bool: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
LogoPath string: If mode is customizedblockpage: full URL to the logo file.
MailtoAddress string: If mode is customizedblockpage: admin email for users to contact.
MailtoSubject string: If mode is customizedblockpage: subject line for emails created from block page.
Mode string: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
Name string: If mode is customizedblockpage: block page title.
SuppressFooter bool: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
TargetUri string: If mode is redirect_uri: URI to which the user should be redirected.

BackgroundColor string: If mode is customizedblockpage: block page background color in #rrggbb format.
Enabled bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
FooterText string: If mode is customizedblockpage: block page footer text.
HeaderText string: If mode is customizedblockpage: block page header text.
IncludeContext bool: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
LogoPath string: If mode is customizedblockpage: full URL to the logo file.
MailtoAddress string: If mode is customizedblockpage: admin email for users to contact.
MailtoSubject string: If mode is customizedblockpage: subject line for emails created from block page.
Mode string: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
Name string: If mode is customizedblockpage: block page title.
SuppressFooter bool: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
TargetUri string: If mode is redirect_uri: URI to which the user should be redirected.

backgroundColor String: If mode is customizedblockpage: block page background color in #rrggbb format.
enabled Boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
footerText String: If mode is customizedblockpage: block page footer text.
headerText String: If mode is customizedblockpage: block page header text.
includeContext Boolean: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
logoPath String: If mode is customizedblockpage: full URL to the logo file.
mailtoAddress String: If mode is customizedblockpage: admin email for users to contact.
mailtoSubject String: If mode is customizedblockpage: subject line for emails created from block page.
mode String: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
name String: If mode is customizedblockpage: block page title.
suppressFooter Boolean: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
targetUri String: If mode is redirect_uri: URI to which the user should be redirected.

backgroundColor string: If mode is customizedblockpage: block page background color in #rrggbb format.
enabled boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
footerText string: If mode is customizedblockpage: block page footer text.
headerText string: If mode is customizedblockpage: block page header text.
includeContext boolean: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
logoPath string: If mode is customizedblockpage: full URL to the logo file.
mailtoAddress string: If mode is customizedblockpage: admin email for users to contact.
mailtoSubject string: If mode is customizedblockpage: subject line for emails created from block page.
mode string: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
name string: If mode is customizedblockpage: block page title.
suppressFooter boolean: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
targetUri string: If mode is redirect_uri: URI to which the user should be redirected.

background_color str: If mode is customizedblockpage: block page background color in #rrggbb format.
enabled bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
footer_text str: If mode is customizedblockpage: block page footer text.
header_text str: If mode is customizedblockpage: block page header text.
include_context bool: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
logo_path str: If mode is customizedblockpage: full URL to the logo file.
mailto_address str: If mode is customizedblockpage: admin email for users to contact.
mailto_subject str: If mode is customizedblockpage: subject line for emails created from block page.
mode str: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
name str: If mode is customizedblockpage: block page title.
suppress_footer bool: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
target_uri str: If mode is redirect_uri: URI to which the user should be redirected.

backgroundColor String: If mode is customizedblockpage: block page background color in #rrggbb format.
enabled Boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
footerText String: If mode is customizedblockpage: block page footer text.
headerText String: If mode is customizedblockpage: block page header text.
includeContext Boolean: If mode is redirecturi: when enabled, context will be appended to targeturi as query parameters.
logoPath String: If mode is customizedblockpage: full URL to the logo file.
mailtoAddress String: If mode is customizedblockpage: admin email for users to contact.
mailtoSubject String: If mode is customizedblockpage: subject line for emails created from block page.
mode String: Controls whether the user is redirected to a Cloudflare-hosted block page or to a customer-provided URI. Available values: "customizedblockpage", "redirect_uri".
name String: If mode is customizedblockpage: block page title.
suppressFooter Boolean: If mode is customizedblockpage: suppress detailed info at the bottom of the block page.
targetUri String: If mode is redirect_uri: URI to which the user should be redirected.

ZeroTrustGatewaySettingsSettingsBodyScanning, ZeroTrustGatewaySettingsSettingsBodyScanningArgs

InspectionMode string: Set the inspection mode to either deep or shallow.

InspectionMode string: Set the inspection mode to either deep or shallow.

inspectionMode String: Set the inspection mode to either deep or shallow.

inspectionMode string: Set the inspection mode to either deep or shallow.

inspection_mode str: Set the inspection mode to either deep or shallow.

inspectionMode String: Set the inspection mode to either deep or shallow.

ZeroTrustGatewaySettingsSettingsBrowserIsolation, ZeroTrustGatewaySettingsSettingsBrowserIsolationArgs

NonIdentityEnabled bool: Enable non-identity onramp support for Browser Isolation.
UrlBrowserIsolationEnabled bool: Enable Clientless Browser Isolation.

NonIdentityEnabled bool: Enable non-identity onramp support for Browser Isolation.
UrlBrowserIsolationEnabled bool: Enable Clientless Browser Isolation.

nonIdentityEnabled Boolean: Enable non-identity onramp support for Browser Isolation.
urlBrowserIsolationEnabled Boolean: Enable Clientless Browser Isolation.

nonIdentityEnabled boolean: Enable non-identity onramp support for Browser Isolation.
urlBrowserIsolationEnabled boolean: Enable Clientless Browser Isolation.

non_identity_enabled bool: Enable non-identity onramp support for Browser Isolation.
url_browser_isolation_enabled bool: Enable Clientless Browser Isolation.

nonIdentityEnabled Boolean: Enable non-identity onramp support for Browser Isolation.
urlBrowserIsolationEnabled Boolean: Enable Clientless Browser Isolation.

ZeroTrustGatewaySettingsSettingsCertificate, ZeroTrustGatewaySettingsSettingsCertificateArgs

Id string: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

Id string: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

id String: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

id string: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

id str: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

id String: UUID of certificate to be used for interception. Certificate must be available (previously called 'active') on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.

ZeroTrustGatewaySettingsSettingsCustomCertificate, ZeroTrustGatewaySettingsSettingsCustomCertificateArgs

Enabled bool: Enable use of custom certificate authority for signing Gateway traffic.
BindingStatus string: Certificate status (internal).
Id string: UUID of certificate (ID from MTLS certificate store).
UpdatedAt string

Enabled bool: Enable use of custom certificate authority for signing Gateway traffic.
BindingStatus string: Certificate status (internal).
Id string: UUID of certificate (ID from MTLS certificate store).
UpdatedAt string

enabled Boolean: Enable use of custom certificate authority for signing Gateway traffic.
bindingStatus String: Certificate status (internal).
id String: UUID of certificate (ID from MTLS certificate store).
updatedAt String

enabled boolean: Enable use of custom certificate authority for signing Gateway traffic.
bindingStatus string: Certificate status (internal).
id string: UUID of certificate (ID from MTLS certificate store).
updatedAt string

enabled bool: Enable use of custom certificate authority for signing Gateway traffic.
binding_status str: Certificate status (internal).
id str: UUID of certificate (ID from MTLS certificate store).
updated_at str

enabled Boolean: Enable use of custom certificate authority for signing Gateway traffic.
bindingStatus String: Certificate status (internal).
id String: UUID of certificate (ID from MTLS certificate store).
updatedAt String

ZeroTrustGatewaySettingsSettingsExtendedEmailMatching, ZeroTrustGatewaySettingsSettingsExtendedEmailMatchingArgs

Enabled bool: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

Enabled bool: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

enabled Boolean: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

enabled boolean: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

enabled bool: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

enabled Boolean: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.

ZeroTrustGatewaySettingsSettingsFips, ZeroTrustGatewaySettingsSettingsFipsArgs

Tls bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

Tls bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

tls Boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

tls boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

tls bool: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

tls Boolean: Enable only cipher suites and TLS versions compliant with FIPS 140-2.

ZeroTrustGatewaySettingsSettingsProtocolDetection, ZeroTrustGatewaySettingsSettingsProtocolDetectionArgs

Enabled bool: Enable detecting protocol on initial bytes of client traffic.

Enabled bool: Enable detecting protocol on initial bytes of client traffic.

enabled Boolean: Enable detecting protocol on initial bytes of client traffic.

enabled boolean: Enable detecting protocol on initial bytes of client traffic.

enabled bool: Enable detecting protocol on initial bytes of client traffic.

enabled Boolean: Enable detecting protocol on initial bytes of client traffic.

ZeroTrustGatewaySettingsSettingsSandbox, ZeroTrustGatewaySettingsSettingsSandboxArgs

Enabled bool: Enable sandbox.
FallbackAction string: Action to take when the file cannot be scanned. Available values: "allow", "block".

Enabled bool: Enable sandbox.
FallbackAction string: Action to take when the file cannot be scanned. Available values: "allow", "block".

enabled Boolean: Enable sandbox.
fallbackAction String: Action to take when the file cannot be scanned. Available values: "allow", "block".

enabled boolean: Enable sandbox.
fallbackAction string: Action to take when the file cannot be scanned. Available values: "allow", "block".

enabled bool: Enable sandbox.
fallback_action str: Action to take when the file cannot be scanned. Available values: "allow", "block".

enabled Boolean: Enable sandbox.
fallbackAction String: Action to take when the file cannot be scanned. Available values: "allow", "block".

ZeroTrustGatewaySettingsSettingsTlsDecrypt, ZeroTrustGatewaySettingsSettingsTlsDecryptArgs

Enabled bool: Enable inspecting encrypted HTTP traffic.

Enabled bool: Enable inspecting encrypted HTTP traffic.

enabled Boolean: Enable inspecting encrypted HTTP traffic.

enabled boolean: Enable inspecting encrypted HTTP traffic.

enabled bool: Enable inspecting encrypted HTTP traffic.

enabled Boolean: Enable inspecting encrypted HTTP traffic.

Import

$ pulumi import cloudflare:index/zeroTrustGatewaySettings:ZeroTrustGatewaySettings example '<account_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 v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.ZeroTrustGatewaySettings

On this page

On this page

Example Usage

Create ZeroTrustGatewaySettings Resource

Constructor syntax

Parameters

Constructor example

ZeroTrustGatewaySettings Resource Properties

Inputs

Outputs

Look up Existing ZeroTrustGatewaySettings Resource

Supporting Types

ZeroTrustGatewaySettingsSettings, ZeroTrustGatewaySettingsSettingsArgs

ZeroTrustGatewaySettingsSettingsActivityLog, ZeroTrustGatewaySettingsSettingsActivityLogArgs

ZeroTrustGatewaySettingsSettingsAntivirus, ZeroTrustGatewaySettingsSettingsAntivirusArgs

ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettings, ZeroTrustGatewaySettingsSettingsAntivirusNotificationSettingsArgs

ZeroTrustGatewaySettingsSettingsBlockPage, ZeroTrustGatewaySettingsSettingsBlockPageArgs

ZeroTrustGatewaySettingsSettingsBodyScanning, ZeroTrustGatewaySettingsSettingsBodyScanningArgs

ZeroTrustGatewaySettingsSettingsBrowserIsolation, ZeroTrustGatewaySettingsSettingsBrowserIsolationArgs

ZeroTrustGatewaySettingsSettingsCertificate, ZeroTrustGatewaySettingsSettingsCertificateArgs

ZeroTrustGatewaySettingsSettingsCustomCertificate, ZeroTrustGatewaySettingsSettingsCustomCertificateArgs

ZeroTrustGatewaySettingsSettingsExtendedEmailMatching, ZeroTrustGatewaySettingsSettingsExtendedEmailMatchingArgs

ZeroTrustGatewaySettingsSettingsFips, ZeroTrustGatewaySettingsSettingsFipsArgs

ZeroTrustGatewaySettingsSettingsProtocolDetection, ZeroTrustGatewaySettingsSettingsProtocolDetectionArgs

ZeroTrustGatewaySettingsSettingsSandbox, ZeroTrustGatewaySettingsSettingsSandboxArgs

ZeroTrustGatewaySettingsSettingsTlsDecrypt, ZeroTrustGatewaySettingsSettingsTlsDecryptArgs

Import

Package Details

On this page

On this page