Floorsetting class

Model Armor floor settings define rules that dictate minimum requirements for all Model Armor templates created at a specific point in the Google Cloud resource hierarchy (that is, at an organization, folder, or project level). If there are multiple floor settings that conflict with each other, the settings lower in the resource hierarchy take precedence For more information, checkout https://cloud.google.com/security-command-center/docs/model_armor_floor_settings

Example Usage

Modelarmor Floorsetting Basic

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

const floorsetting_basic = new gcp.modelarmor.Floorsetting("floorsetting-basic", {
    parent: "projects/my-project-name",
    location: "global",
    filterConfig: {},
});

import pulumi
import pulumi_gcp as gcp

floorsetting_basic = gcp.modelarmor.Floorsetting("floorsetting-basic",
    parent="projects/my-project-name",
    location="global",
    filter_config={})

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var floorsetting_basic = new Gcp.ModelArmor.Floorsetting("floorsetting-basic", new()
    {
        Parent = "projects/my-project-name",
        Location = "global",
        FilterConfig = new() { },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/modelarmor"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := modelarmor.NewFloorsetting(ctx, "floorsetting-basic", &modelarmor.FloorsettingArgs{
			Parent:       pulumi.String("projects/my-project-name"),
			Location:     pulumi.String("global"),
			FilterConfig: &modelarmor.FloorsettingFilterConfigArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_modelarmor_floorsetting" "floorsetting-basic" {
  parent        = "projects/my-project-name"
  location      = "global"
  filter_config = {}
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.modelarmor.Floorsetting;
import com.pulumi.gcp.modelarmor.FloorsettingArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 floorsetting_basic = new Floorsetting("floorsetting-basic", FloorsettingArgs.builder()
            .parent("projects/my-project-name")
            .location("global")
            .filterConfig(FloorsettingFilterConfigArgs.builder()
                .build())
            .build());

    }
}

resources:
  floorsetting-basic:
    type: gcp:modelarmor:Floorsetting
    properties:
      parent: projects/my-project-name
      location: global
      filterConfig: {}

Modelarmor Floorsetting Filter Config

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

const floorsetting_filter_config = new gcp.modelarmor.Floorsetting("floorsetting-filter-config", {
    location: "global",
    parent: "project/my-project-name",
    filterConfig: {
        raiSettings: {
            raiFilters: [{
                filterType: "DANGEROUS",
                confidenceLevel: "MEDIUM_AND_ABOVE",
            }],
        },
        sdpSettings: {
            basicConfig: {
                filterEnforcement: "ENABLED",
            },
        },
        piAndJailbreakFilterSettings: {
            filterEnforcement: "ENABLED",
            confidenceLevel: "HIGH",
        },
        maliciousUriFilterSettings: {
            filterEnforcement: "ENABLED",
        },
    },
    enableFloorSettingEnforcement: true,
});

import pulumi
import pulumi_gcp as gcp

floorsetting_filter_config = gcp.modelarmor.Floorsetting("floorsetting-filter-config",
    location="global",
    parent="project/my-project-name",
    filter_config={
        "rai_settings": {
            "rai_filters": [{
                "filter_type": "DANGEROUS",
                "confidence_level": "MEDIUM_AND_ABOVE",
            }],
        },
        "sdp_settings": {
            "basic_config": {
                "filter_enforcement": "ENABLED",
            },
        },
        "pi_and_jailbreak_filter_settings": {
            "filter_enforcement": "ENABLED",
            "confidence_level": "HIGH",
        },
        "malicious_uri_filter_settings": {
            "filter_enforcement": "ENABLED",
        },
    },
    enable_floor_setting_enforcement=True)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var floorsetting_filter_config = new Gcp.ModelArmor.Floorsetting("floorsetting-filter-config", new()
    {
        Location = "global",
        Parent = "project/my-project-name",
        FilterConfig = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigArgs
        {
            RaiSettings = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigRaiSettingsArgs
            {
                RaiFilters = new[]
                {
                    new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigRaiSettingsRaiFilterArgs
                    {
                        FilterType = "DANGEROUS",
                        ConfidenceLevel = "MEDIUM_AND_ABOVE",
                    },
                },
            },
            SdpSettings = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigSdpSettingsArgs
            {
                BasicConfig = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigSdpSettingsBasicConfigArgs
                {
                    FilterEnforcement = "ENABLED",
                },
            },
            PiAndJailbreakFilterSettings = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigPiAndJailbreakFilterSettingsArgs
            {
                FilterEnforcement = "ENABLED",
                ConfidenceLevel = "HIGH",
            },
            MaliciousUriFilterSettings = new Gcp.ModelArmor.Inputs.FloorsettingFilterConfigMaliciousUriFilterSettingsArgs
            {
                FilterEnforcement = "ENABLED",
            },
        },
        EnableFloorSettingEnforcement = true,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/modelarmor"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := modelarmor.NewFloorsetting(ctx, "floorsetting-filter-config", &modelarmor.FloorsettingArgs{
			Location: pulumi.String("global"),
			Parent:   pulumi.String("project/my-project-name"),
			FilterConfig: &modelarmor.FloorsettingFilterConfigArgs{
				RaiSettings: &modelarmor.FloorsettingFilterConfigRaiSettingsArgs{
					RaiFilters: modelarmor.FloorsettingFilterConfigRaiSettingsRaiFilterArray{
						&modelarmor.FloorsettingFilterConfigRaiSettingsRaiFilterArgs{
							FilterType:      pulumi.String("DANGEROUS"),
							ConfidenceLevel: pulumi.String("MEDIUM_AND_ABOVE"),
						},
					},
				},
				SdpSettings: &modelarmor.FloorsettingFilterConfigSdpSettingsArgs{
					BasicConfig: &modelarmor.FloorsettingFilterConfigSdpSettingsBasicConfigArgs{
						FilterEnforcement: pulumi.String("ENABLED"),
					},
				},
				PiAndJailbreakFilterSettings: &modelarmor.FloorsettingFilterConfigPiAndJailbreakFilterSettingsArgs{
					FilterEnforcement: pulumi.String("ENABLED"),
					ConfidenceLevel:   pulumi.String("HIGH"),
				},
				MaliciousUriFilterSettings: &modelarmor.FloorsettingFilterConfigMaliciousUriFilterSettingsArgs{
					FilterEnforcement: pulumi.String("ENABLED"),
				},
			},
			EnableFloorSettingEnforcement: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_modelarmor_floorsetting" "floorsetting-filter-config" {
  location = "global"
  parent   = "project/my-project-name"
  filter_config = {
    rai_settings = {
      rai_filters = [{
        "filterType"      = "DANGEROUS"
        "confidenceLevel" = "MEDIUM_AND_ABOVE"
      }]
    }
    sdp_settings = {
      basic_config = {
        filter_enforcement = "ENABLED"
      }
    }
    pi_and_jailbreak_filter_settings = {
      filter_enforcement = "ENABLED"
      confidence_level   = "HIGH"
    }
    malicious_uri_filter_settings = {
      filter_enforcement = "ENABLED"
    }
  }
  enable_floor_setting_enforcement = true
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.modelarmor.Floorsetting;
import com.pulumi.gcp.modelarmor.FloorsettingArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigRaiSettingsArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigRaiSettingsRaiFilterArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigSdpSettingsArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigSdpSettingsBasicConfigArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigPiAndJailbreakFilterSettingsArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigMaliciousUriFilterSettingsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 floorsetting_filter_config = new Floorsetting("floorsetting-filter-config", FloorsettingArgs.builder()
            .location("global")
            .parent("project/my-project-name")
            .filterConfig(FloorsettingFilterConfigArgs.builder()
                .raiSettings(FloorsettingFilterConfigRaiSettingsArgs.builder()
                    .raiFilters(FloorsettingFilterConfigRaiSettingsRaiFilterArgs.builder()
                        .filterType("DANGEROUS")
                        .confidenceLevel("MEDIUM_AND_ABOVE")
                        .build())
                    .build())
                .sdpSettings(FloorsettingFilterConfigSdpSettingsArgs.builder()
                    .basicConfig(FloorsettingFilterConfigSdpSettingsBasicConfigArgs.builder()
                        .filterEnforcement("ENABLED")
                        .build())
                    .build())
                .piAndJailbreakFilterSettings(FloorsettingFilterConfigPiAndJailbreakFilterSettingsArgs.builder()
                    .filterEnforcement("ENABLED")
                    .confidenceLevel("HIGH")
                    .build())
                .maliciousUriFilterSettings(FloorsettingFilterConfigMaliciousUriFilterSettingsArgs.builder()
                    .filterEnforcement("ENABLED")
                    .build())
                .build())
            .enableFloorSettingEnforcement(true)
            .build());

    }
}

resources:
  floorsetting-filter-config:
    type: gcp:modelarmor:Floorsetting
    properties:
      location: global
      parent: project/my-project-name
      filterConfig:
        raiSettings:
          raiFilters:
            - filterType: DANGEROUS
              confidenceLevel: MEDIUM_AND_ABOVE
        sdpSettings:
          basicConfig:
            filterEnforcement: ENABLED
        piAndJailbreakFilterSettings:
          filterEnforcement: ENABLED
          confidenceLevel: HIGH
        maliciousUriFilterSettings:
          filterEnforcement: ENABLED
      enableFloorSettingEnforcement: true

Modelarmor Floorsetting Ai Platform Metadata

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

const floorsetting_integrated_metadata = new gcp.modelarmor.Floorsetting("floorsetting-integrated-metadata", {
    location: "global",
    parent: "projects/my-project-name",
    filterConfig: {},
    enableFloorSettingEnforcement: false,
    aiPlatformFloorSetting: {
        inspectOnly: true,
        enableCloudLogging: true,
    },
    floorSettingMetadata: {
        multiLanguageDetection: {
            enableMultiLanguageDetection: false,
        },
    },
});

import pulumi
import pulumi_gcp as gcp

floorsetting_integrated_metadata = gcp.modelarmor.Floorsetting("floorsetting-integrated-metadata",
    location="global",
    parent="projects/my-project-name",
    filter_config={},
    enable_floor_setting_enforcement=False,
    ai_platform_floor_setting={
        "inspect_only": True,
        "enable_cloud_logging": True,
    },
    floor_setting_metadata={
        "multi_language_detection": {
            "enable_multi_language_detection": False,
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var floorsetting_integrated_metadata = new Gcp.ModelArmor.Floorsetting("floorsetting-integrated-metadata", new()
    {
        Location = "global",
        Parent = "projects/my-project-name",
        FilterConfig = new() { },
        EnableFloorSettingEnforcement = false,
        AiPlatformFloorSetting = new Gcp.ModelArmor.Inputs.FloorsettingAiPlatformFloorSettingArgs
        {
            InspectOnly = true,
            EnableCloudLogging = true,
        },
        FloorSettingMetadata = new Gcp.ModelArmor.Inputs.FloorsettingFloorSettingMetadataArgs
        {
            MultiLanguageDetection = new Gcp.ModelArmor.Inputs.FloorsettingFloorSettingMetadataMultiLanguageDetectionArgs
            {
                EnableMultiLanguageDetection = false,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/modelarmor"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := modelarmor.NewFloorsetting(ctx, "floorsetting-integrated-metadata", &modelarmor.FloorsettingArgs{
			Location:                      pulumi.String("global"),
			Parent:                        pulumi.String("projects/my-project-name"),
			FilterConfig:                  &modelarmor.FloorsettingFilterConfigArgs{},
			EnableFloorSettingEnforcement: pulumi.Bool(false),
			AiPlatformFloorSetting: &modelarmor.FloorsettingAiPlatformFloorSettingArgs{
				InspectOnly:        pulumi.Bool(true),
				EnableCloudLogging: pulumi.Bool(true),
			},
			FloorSettingMetadata: &modelarmor.FloorsettingFloorSettingMetadataArgs{
				MultiLanguageDetection: &modelarmor.FloorsettingFloorSettingMetadataMultiLanguageDetectionArgs{
					EnableMultiLanguageDetection: pulumi.Bool(false),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_modelarmor_floorsetting" "floorsetting-integrated-metadata" {
  location                         = "global"
  parent                           = "projects/my-project-name"
  filter_config                    = {}
  enable_floor_setting_enforcement = false
  ai_platform_floor_setting = {
    inspect_only         = true
    enable_cloud_logging = true
  }
  floor_setting_metadata = {
    multi_language_detection = {
      enable_multi_language_detection = false
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.modelarmor.Floorsetting;
import com.pulumi.gcp.modelarmor.FloorsettingArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFilterConfigArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingAiPlatformFloorSettingArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFloorSettingMetadataArgs;
import com.pulumi.gcp.modelarmor.inputs.FloorsettingFloorSettingMetadataMultiLanguageDetectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 floorsetting_integrated_metadata = new Floorsetting("floorsetting-integrated-metadata", FloorsettingArgs.builder()
            .location("global")
            .parent("projects/my-project-name")
            .filterConfig(FloorsettingFilterConfigArgs.builder()
                .build())
            .enableFloorSettingEnforcement(false)
            .aiPlatformFloorSetting(FloorsettingAiPlatformFloorSettingArgs.builder()
                .inspectOnly(true)
                .enableCloudLogging(true)
                .build())
            .floorSettingMetadata(FloorsettingFloorSettingMetadataArgs.builder()
                .multiLanguageDetection(FloorsettingFloorSettingMetadataMultiLanguageDetectionArgs.builder()
                    .enableMultiLanguageDetection(false)
                    .build())
                .build())
            .build());

    }
}

resources:
  floorsetting-integrated-metadata:
    type: gcp:modelarmor:Floorsetting
    properties:
      location: global
      parent: projects/my-project-name
      filterConfig: {}
      enableFloorSettingEnforcement: false
      aiPlatformFloorSetting:
        inspectOnly: true
        enableCloudLogging: true
      floorSettingMetadata:
        multiLanguageDetection:
          enableMultiLanguageDetection: false

Import

Floorsetting can be imported using any of these accepted formats:

{{parent}}/locations/{{location}}/floorSetting
{{parent}}/{{location}}

When using the pulumi import command, Floorsetting can be imported using one of the formats above. For example:

$ pulumi import gcp:modelarmor/floorsetting:Floorsetting default {{parent}}/locations/{{location}}/floorSetting
$ pulumi import gcp:modelarmor/floorsetting:Floorsetting default {{parent}}/{{location}}

Constructors

Floorsetting(String name, {FloorsettingArgs? args, CustomResourceOptions? options}): Creates a new Floorsetting. name The Pulumi resource name. args Arguments used to configure this Floorsetting. The set of arguments for Floorsetting. options Resource options controlling this resource's behavior.
Floorsetting.reference(String urn): Creates a typed reference to an existing Floorsetting resource.

Properties

aiPlatformFloorSetting ↔ Output<FloorsettingAiPlatformFloorSetting?>: AI Platform floor setting. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Output only Create timestamp
latefinal
enableFloorSettingEnforcement ↔ Output<bool?>: Floor Settings enforcement status.
latefinal
filterConfig ↔ Output<FloorsettingFilterConfig>: Filters configuration. Structure is documented below.
latefinal
floorSettingMetadata ↔ Output<FloorsettingFloorSettingMetadata?>: Metadata to enable multi language detection via floor setting. Structure is documented below.
latefinal
googleMcpServerFloorSetting ↔ Output<FloorsettingGoogleMcpServerFloorSetting?>: Google MCP Server floor setting. Structure is documented below.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
integratedServices ↔ Output<List<String>?>: List of integrated services for which the floor setting is applicable.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
latefinal
name ↔ Output<String>: Identifier. The resource name.
latefinal
parent ↔ Output<String>: Will be any one of these:
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>: Output only Update timestamp
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FloorsettingState? state, CustomResourceOptions? options}) → Floorsetting: Gets an existing Floorsetting resource's state with the given name and id.