recaptcha

package
v6.67.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EnterpriseKey

type EnterpriseKey struct {
	pulumi.CustomResourceState

	// Settings for keys that can be used by Android apps.
	AndroidSettings EnterpriseKeyAndroidSettingsPtrOutput `pulumi:"androidSettings"`
	// The timestamp corresponding to the creation of this Key.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// Human-readable display name of this key. Modifiable by user.
	//
	// ***
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Settings for keys that can be used by iOS apps.
	IosSettings EnterpriseKeyIosSettingsPtrOutput `pulumi:"iosSettings"`
	// See [Creating and managing labels](https://cloud.google.com/recaptcha-enterprise/docs/labels).
	Labels pulumi.StringMapOutput `pulumi:"labels"`
	// The resource name for the Key in the format "projects/{project}/keys/{key}".
	Name pulumi.StringOutput `pulumi:"name"`
	// The project for the resource
	Project pulumi.StringOutput `pulumi:"project"`
	// Options for user acceptance testing.
	TestingOptions EnterpriseKeyTestingOptionsPtrOutput `pulumi:"testingOptions"`
	// Settings for keys that can be used by websites.
	WebSettings EnterpriseKeyWebSettingsPtrOutput `pulumi:"webSettings"`
}

The RecaptchaEnterprise Key resource

## Example Usage ### Android_key A basic test of recaptcha enterprise key that can be used by Android apps ```go package main

import (

"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/recaptcha"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			AndroidSettings: &recaptcha.EnterpriseKeyAndroidSettingsArgs{
				AllowAllPackageNames: pulumi.Bool(true),
				AllowedPackageNames:  pulumi.StringArray{},
			},
			DisplayName: pulumi.String("display-name-one"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(0.8),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Ios_key A basic test of recaptcha enterprise key that can be used by iOS apps ```go package main

import (

"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/recaptcha"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			IosSettings: &recaptcha.EnterpriseKeyIosSettingsArgs{
				AllowAllBundleIds: pulumi.Bool(true),
				AllowedBundleIds:  pulumi.StringArray{},
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(1),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Minimal_key A minimal test of recaptcha enterprise key ```go package main

import (

"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/recaptcha"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Labels:      nil,
			Project:     pulumi.String("my-project-name"),
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				AllowAllDomains: pulumi.Bool(true),
				IntegrationType: pulumi.String("SCORE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Web_key A basic test of recaptcha enterprise key that can be used by websites ```go package main

import (

"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/recaptcha"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingChallenge: pulumi.String("NOCAPTCHA"),
				TestingScore:     pulumi.Float64(0.5),
			},
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				AllowAllDomains:             pulumi.Bool(true),
				AllowedDomains:              pulumi.StringArray{},
				ChallengeSecurityPreference: pulumi.String("USABILITY"),
				IntegrationType:             pulumi.String("CHECKBOX"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Web_score_key A basic test of recaptcha enterprise key with score integration type that can be used by websites ```go package main

import (

"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/recaptcha"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(0.5),
			},
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				AllowAllDomains: pulumi.Bool(true),
				AllowAmpTraffic: pulumi.Bool(false),
				AllowedDomains:  pulumi.StringArray{},
				IntegrationType: pulumi.String("SCORE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Key can be imported using any of these accepted formats

```sh

$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default projects/{{project}}/keys/{{name}}

```

```sh

$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{project}}/{{name}}

```

```sh

$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{name}}

```

func GetEnterpriseKey

func GetEnterpriseKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EnterpriseKeyState, opts ...pulumi.ResourceOption) (*EnterpriseKey, error)

GetEnterpriseKey gets an existing EnterpriseKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEnterpriseKey

func NewEnterpriseKey(ctx *pulumi.Context,
	name string, args *EnterpriseKeyArgs, opts ...pulumi.ResourceOption) (*EnterpriseKey, error)

NewEnterpriseKey registers a new resource with the given unique name, arguments, and options.

func (*EnterpriseKey) ElementType

func (*EnterpriseKey) ElementType() reflect.Type

func (*EnterpriseKey) ToEnterpriseKeyOutput

func (i *EnterpriseKey) ToEnterpriseKeyOutput() EnterpriseKeyOutput

func (*EnterpriseKey) ToEnterpriseKeyOutputWithContext

func (i *EnterpriseKey) ToEnterpriseKeyOutputWithContext(ctx context.Context) EnterpriseKeyOutput

func (*EnterpriseKey) ToOutput added in v6.65.1

type EnterpriseKeyAndroidSettings

type EnterpriseKeyAndroidSettings struct {
	// If set to true, it means allowedPackageNames will not be enforced.
	AllowAllPackageNames *bool `pulumi:"allowAllPackageNames"`
	// Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
	AllowedPackageNames []string `pulumi:"allowedPackageNames"`
}

type EnterpriseKeyAndroidSettingsArgs

type EnterpriseKeyAndroidSettingsArgs struct {
	// If set to true, it means allowedPackageNames will not be enforced.
	AllowAllPackageNames pulumi.BoolPtrInput `pulumi:"allowAllPackageNames"`
	// Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
	AllowedPackageNames pulumi.StringArrayInput `pulumi:"allowedPackageNames"`
}

func (EnterpriseKeyAndroidSettingsArgs) ElementType

func (EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsOutput

func (i EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsOutput() EnterpriseKeyAndroidSettingsOutput

func (EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsOutputWithContext

func (i EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsOutputWithContext(ctx context.Context) EnterpriseKeyAndroidSettingsOutput

func (EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsPtrOutput

func (i EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsPtrOutput() EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext

func (i EnterpriseKeyAndroidSettingsArgs) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsArgs) ToOutput added in v6.65.1

type EnterpriseKeyAndroidSettingsInput

type EnterpriseKeyAndroidSettingsInput interface {
	pulumi.Input

	ToEnterpriseKeyAndroidSettingsOutput() EnterpriseKeyAndroidSettingsOutput
	ToEnterpriseKeyAndroidSettingsOutputWithContext(context.Context) EnterpriseKeyAndroidSettingsOutput
}

EnterpriseKeyAndroidSettingsInput is an input type that accepts EnterpriseKeyAndroidSettingsArgs and EnterpriseKeyAndroidSettingsOutput values. You can construct a concrete instance of `EnterpriseKeyAndroidSettingsInput` via:

EnterpriseKeyAndroidSettingsArgs{...}

type EnterpriseKeyAndroidSettingsOutput

type EnterpriseKeyAndroidSettingsOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyAndroidSettingsOutput) AllowAllPackageNames

func (o EnterpriseKeyAndroidSettingsOutput) AllowAllPackageNames() pulumi.BoolPtrOutput

If set to true, it means allowedPackageNames will not be enforced.

func (EnterpriseKeyAndroidSettingsOutput) AllowedPackageNames

Android package names of apps allowed to use the key. Example: 'com.companyname.appname'

func (EnterpriseKeyAndroidSettingsOutput) ElementType

func (EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsOutput

func (o EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsOutput() EnterpriseKeyAndroidSettingsOutput

func (EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsOutputWithContext

func (o EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsOutputWithContext(ctx context.Context) EnterpriseKeyAndroidSettingsOutput

func (EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsPtrOutput

func (o EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsPtrOutput() EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext

func (o EnterpriseKeyAndroidSettingsOutput) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsOutput) ToOutput added in v6.65.1

type EnterpriseKeyAndroidSettingsPtrInput

type EnterpriseKeyAndroidSettingsPtrInput interface {
	pulumi.Input

	ToEnterpriseKeyAndroidSettingsPtrOutput() EnterpriseKeyAndroidSettingsPtrOutput
	ToEnterpriseKeyAndroidSettingsPtrOutputWithContext(context.Context) EnterpriseKeyAndroidSettingsPtrOutput
}

EnterpriseKeyAndroidSettingsPtrInput is an input type that accepts EnterpriseKeyAndroidSettingsArgs, EnterpriseKeyAndroidSettingsPtr and EnterpriseKeyAndroidSettingsPtrOutput values. You can construct a concrete instance of `EnterpriseKeyAndroidSettingsPtrInput` via:

        EnterpriseKeyAndroidSettingsArgs{...}

or:

        nil

type EnterpriseKeyAndroidSettingsPtrOutput

type EnterpriseKeyAndroidSettingsPtrOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyAndroidSettingsPtrOutput) AllowAllPackageNames

If set to true, it means allowedPackageNames will not be enforced.

func (EnterpriseKeyAndroidSettingsPtrOutput) AllowedPackageNames

Android package names of apps allowed to use the key. Example: 'com.companyname.appname'

func (EnterpriseKeyAndroidSettingsPtrOutput) Elem

func (EnterpriseKeyAndroidSettingsPtrOutput) ElementType

func (EnterpriseKeyAndroidSettingsPtrOutput) ToEnterpriseKeyAndroidSettingsPtrOutput

func (o EnterpriseKeyAndroidSettingsPtrOutput) ToEnterpriseKeyAndroidSettingsPtrOutput() EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsPtrOutput) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext

func (o EnterpriseKeyAndroidSettingsPtrOutput) ToEnterpriseKeyAndroidSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyAndroidSettingsPtrOutput

func (EnterpriseKeyAndroidSettingsPtrOutput) ToOutput added in v6.65.1

type EnterpriseKeyArgs

type EnterpriseKeyArgs struct {
	// Settings for keys that can be used by Android apps.
	AndroidSettings EnterpriseKeyAndroidSettingsPtrInput
	// Human-readable display name of this key. Modifiable by user.
	//
	// ***
	DisplayName pulumi.StringInput
	// Settings for keys that can be used by iOS apps.
	IosSettings EnterpriseKeyIosSettingsPtrInput
	// See [Creating and managing labels](https://cloud.google.com/recaptcha-enterprise/docs/labels).
	Labels pulumi.StringMapInput
	// The project for the resource
	Project pulumi.StringPtrInput
	// Options for user acceptance testing.
	TestingOptions EnterpriseKeyTestingOptionsPtrInput
	// Settings for keys that can be used by websites.
	WebSettings EnterpriseKeyWebSettingsPtrInput
}

The set of arguments for constructing a EnterpriseKey resource.

func (EnterpriseKeyArgs) ElementType

func (EnterpriseKeyArgs) ElementType() reflect.Type

type EnterpriseKeyArray

type EnterpriseKeyArray []EnterpriseKeyInput

func (EnterpriseKeyArray) ElementType

func (EnterpriseKeyArray) ElementType() reflect.Type

func (EnterpriseKeyArray) ToEnterpriseKeyArrayOutput

func (i EnterpriseKeyArray) ToEnterpriseKeyArrayOutput() EnterpriseKeyArrayOutput

func (EnterpriseKeyArray) ToEnterpriseKeyArrayOutputWithContext

func (i EnterpriseKeyArray) ToEnterpriseKeyArrayOutputWithContext(ctx context.Context) EnterpriseKeyArrayOutput

func (EnterpriseKeyArray) ToOutput added in v6.65.1

type EnterpriseKeyArrayInput

type EnterpriseKeyArrayInput interface {
	pulumi.Input

	ToEnterpriseKeyArrayOutput() EnterpriseKeyArrayOutput
	ToEnterpriseKeyArrayOutputWithContext(context.Context) EnterpriseKeyArrayOutput
}

EnterpriseKeyArrayInput is an input type that accepts EnterpriseKeyArray and EnterpriseKeyArrayOutput values. You can construct a concrete instance of `EnterpriseKeyArrayInput` via:

EnterpriseKeyArray{ EnterpriseKeyArgs{...} }

type EnterpriseKeyArrayOutput

type EnterpriseKeyArrayOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyArrayOutput) ElementType

func (EnterpriseKeyArrayOutput) ElementType() reflect.Type

func (EnterpriseKeyArrayOutput) Index

func (EnterpriseKeyArrayOutput) ToEnterpriseKeyArrayOutput

func (o EnterpriseKeyArrayOutput) ToEnterpriseKeyArrayOutput() EnterpriseKeyArrayOutput

func (EnterpriseKeyArrayOutput) ToEnterpriseKeyArrayOutputWithContext

func (o EnterpriseKeyArrayOutput) ToEnterpriseKeyArrayOutputWithContext(ctx context.Context) EnterpriseKeyArrayOutput

func (EnterpriseKeyArrayOutput) ToOutput added in v6.65.1

type EnterpriseKeyInput

type EnterpriseKeyInput interface {
	pulumi.Input

	ToEnterpriseKeyOutput() EnterpriseKeyOutput
	ToEnterpriseKeyOutputWithContext(ctx context.Context) EnterpriseKeyOutput
}

type EnterpriseKeyIosSettings

type EnterpriseKeyIosSettings struct {
	// If set to true, it means allowedBundleIds will not be enforced.
	AllowAllBundleIds *bool `pulumi:"allowAllBundleIds"`
	// iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
	AllowedBundleIds []string `pulumi:"allowedBundleIds"`
}

type EnterpriseKeyIosSettingsArgs

type EnterpriseKeyIosSettingsArgs struct {
	// If set to true, it means allowedBundleIds will not be enforced.
	AllowAllBundleIds pulumi.BoolPtrInput `pulumi:"allowAllBundleIds"`
	// iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
	AllowedBundleIds pulumi.StringArrayInput `pulumi:"allowedBundleIds"`
}

func (EnterpriseKeyIosSettingsArgs) ElementType

func (EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsOutput

func (i EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsOutput() EnterpriseKeyIosSettingsOutput

func (EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsOutputWithContext

func (i EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsOutputWithContext(ctx context.Context) EnterpriseKeyIosSettingsOutput

func (EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsPtrOutput

func (i EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsPtrOutput() EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsPtrOutputWithContext

func (i EnterpriseKeyIosSettingsArgs) ToEnterpriseKeyIosSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsArgs) ToOutput added in v6.65.1

type EnterpriseKeyIosSettingsInput

type EnterpriseKeyIosSettingsInput interface {
	pulumi.Input

	ToEnterpriseKeyIosSettingsOutput() EnterpriseKeyIosSettingsOutput
	ToEnterpriseKeyIosSettingsOutputWithContext(context.Context) EnterpriseKeyIosSettingsOutput
}

EnterpriseKeyIosSettingsInput is an input type that accepts EnterpriseKeyIosSettingsArgs and EnterpriseKeyIosSettingsOutput values. You can construct a concrete instance of `EnterpriseKeyIosSettingsInput` via:

EnterpriseKeyIosSettingsArgs{...}

type EnterpriseKeyIosSettingsOutput

type EnterpriseKeyIosSettingsOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyIosSettingsOutput) AllowAllBundleIds

func (o EnterpriseKeyIosSettingsOutput) AllowAllBundleIds() pulumi.BoolPtrOutput

If set to true, it means allowedBundleIds will not be enforced.

func (EnterpriseKeyIosSettingsOutput) AllowedBundleIds

iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

func (EnterpriseKeyIosSettingsOutput) ElementType

func (EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsOutput

func (o EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsOutput() EnterpriseKeyIosSettingsOutput

func (EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsOutputWithContext

func (o EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsOutputWithContext(ctx context.Context) EnterpriseKeyIosSettingsOutput

func (EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsPtrOutput

func (o EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsPtrOutput() EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsPtrOutputWithContext

func (o EnterpriseKeyIosSettingsOutput) ToEnterpriseKeyIosSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsOutput) ToOutput added in v6.65.1

type EnterpriseKeyIosSettingsPtrInput

type EnterpriseKeyIosSettingsPtrInput interface {
	pulumi.Input

	ToEnterpriseKeyIosSettingsPtrOutput() EnterpriseKeyIosSettingsPtrOutput
	ToEnterpriseKeyIosSettingsPtrOutputWithContext(context.Context) EnterpriseKeyIosSettingsPtrOutput
}

EnterpriseKeyIosSettingsPtrInput is an input type that accepts EnterpriseKeyIosSettingsArgs, EnterpriseKeyIosSettingsPtr and EnterpriseKeyIosSettingsPtrOutput values. You can construct a concrete instance of `EnterpriseKeyIosSettingsPtrInput` via:

        EnterpriseKeyIosSettingsArgs{...}

or:

        nil

type EnterpriseKeyIosSettingsPtrOutput

type EnterpriseKeyIosSettingsPtrOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyIosSettingsPtrOutput) AllowAllBundleIds

If set to true, it means allowedBundleIds will not be enforced.

func (EnterpriseKeyIosSettingsPtrOutput) AllowedBundleIds

iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

func (EnterpriseKeyIosSettingsPtrOutput) Elem

func (EnterpriseKeyIosSettingsPtrOutput) ElementType

func (EnterpriseKeyIosSettingsPtrOutput) ToEnterpriseKeyIosSettingsPtrOutput

func (o EnterpriseKeyIosSettingsPtrOutput) ToEnterpriseKeyIosSettingsPtrOutput() EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsPtrOutput) ToEnterpriseKeyIosSettingsPtrOutputWithContext

func (o EnterpriseKeyIosSettingsPtrOutput) ToEnterpriseKeyIosSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyIosSettingsPtrOutput

func (EnterpriseKeyIosSettingsPtrOutput) ToOutput added in v6.65.1

type EnterpriseKeyMap

type EnterpriseKeyMap map[string]EnterpriseKeyInput

func (EnterpriseKeyMap) ElementType

func (EnterpriseKeyMap) ElementType() reflect.Type

func (EnterpriseKeyMap) ToEnterpriseKeyMapOutput

func (i EnterpriseKeyMap) ToEnterpriseKeyMapOutput() EnterpriseKeyMapOutput

func (EnterpriseKeyMap) ToEnterpriseKeyMapOutputWithContext

func (i EnterpriseKeyMap) ToEnterpriseKeyMapOutputWithContext(ctx context.Context) EnterpriseKeyMapOutput

func (EnterpriseKeyMap) ToOutput added in v6.65.1

type EnterpriseKeyMapInput

type EnterpriseKeyMapInput interface {
	pulumi.Input

	ToEnterpriseKeyMapOutput() EnterpriseKeyMapOutput
	ToEnterpriseKeyMapOutputWithContext(context.Context) EnterpriseKeyMapOutput
}

EnterpriseKeyMapInput is an input type that accepts EnterpriseKeyMap and EnterpriseKeyMapOutput values. You can construct a concrete instance of `EnterpriseKeyMapInput` via:

EnterpriseKeyMap{ "key": EnterpriseKeyArgs{...} }

type EnterpriseKeyMapOutput

type EnterpriseKeyMapOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyMapOutput) ElementType

func (EnterpriseKeyMapOutput) ElementType() reflect.Type

func (EnterpriseKeyMapOutput) MapIndex

func (EnterpriseKeyMapOutput) ToEnterpriseKeyMapOutput

func (o EnterpriseKeyMapOutput) ToEnterpriseKeyMapOutput() EnterpriseKeyMapOutput

func (EnterpriseKeyMapOutput) ToEnterpriseKeyMapOutputWithContext

func (o EnterpriseKeyMapOutput) ToEnterpriseKeyMapOutputWithContext(ctx context.Context) EnterpriseKeyMapOutput

func (EnterpriseKeyMapOutput) ToOutput added in v6.65.1

type EnterpriseKeyOutput

type EnterpriseKeyOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyOutput) AndroidSettings added in v6.23.0

Settings for keys that can be used by Android apps.

func (EnterpriseKeyOutput) CreateTime added in v6.23.0

func (o EnterpriseKeyOutput) CreateTime() pulumi.StringOutput

The timestamp corresponding to the creation of this Key.

func (EnterpriseKeyOutput) DisplayName added in v6.23.0

func (o EnterpriseKeyOutput) DisplayName() pulumi.StringOutput

Human-readable display name of this key. Modifiable by user.

***

func (EnterpriseKeyOutput) ElementType

func (EnterpriseKeyOutput) ElementType() reflect.Type

func (EnterpriseKeyOutput) IosSettings added in v6.23.0

Settings for keys that can be used by iOS apps.

func (EnterpriseKeyOutput) Labels added in v6.23.0

See [Creating and managing labels](https://cloud.google.com/recaptcha-enterprise/docs/labels).

func (EnterpriseKeyOutput) Name added in v6.23.0

The resource name for the Key in the format "projects/{project}/keys/{key}".

func (EnterpriseKeyOutput) Project added in v6.23.0

The project for the resource

func (EnterpriseKeyOutput) TestingOptions added in v6.23.0

Options for user acceptance testing.

func (EnterpriseKeyOutput) ToEnterpriseKeyOutput

func (o EnterpriseKeyOutput) ToEnterpriseKeyOutput() EnterpriseKeyOutput

func (EnterpriseKeyOutput) ToEnterpriseKeyOutputWithContext

func (o EnterpriseKeyOutput) ToEnterpriseKeyOutputWithContext(ctx context.Context) EnterpriseKeyOutput

func (EnterpriseKeyOutput) ToOutput added in v6.65.1

func (EnterpriseKeyOutput) WebSettings added in v6.23.0

Settings for keys that can be used by websites.

type EnterpriseKeyState

type EnterpriseKeyState struct {
	// Settings for keys that can be used by Android apps.
	AndroidSettings EnterpriseKeyAndroidSettingsPtrInput
	// The timestamp corresponding to the creation of this Key.
	CreateTime pulumi.StringPtrInput
	// Human-readable display name of this key. Modifiable by user.
	//
	// ***
	DisplayName pulumi.StringPtrInput
	// Settings for keys that can be used by iOS apps.
	IosSettings EnterpriseKeyIosSettingsPtrInput
	// See [Creating and managing labels](https://cloud.google.com/recaptcha-enterprise/docs/labels).
	Labels pulumi.StringMapInput
	// The resource name for the Key in the format "projects/{project}/keys/{key}".
	Name pulumi.StringPtrInput
	// The project for the resource
	Project pulumi.StringPtrInput
	// Options for user acceptance testing.
	TestingOptions EnterpriseKeyTestingOptionsPtrInput
	// Settings for keys that can be used by websites.
	WebSettings EnterpriseKeyWebSettingsPtrInput
}

func (EnterpriseKeyState) ElementType

func (EnterpriseKeyState) ElementType() reflect.Type

type EnterpriseKeyTestingOptions

type EnterpriseKeyTestingOptions struct {
	// For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
	TestingChallenge *string `pulumi:"testingChallenge"`
	// All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
	TestingScore *float64 `pulumi:"testingScore"`
}

type EnterpriseKeyTestingOptionsArgs

type EnterpriseKeyTestingOptionsArgs struct {
	// For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
	TestingChallenge pulumi.StringPtrInput `pulumi:"testingChallenge"`
	// All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
	TestingScore pulumi.Float64PtrInput `pulumi:"testingScore"`
}

func (EnterpriseKeyTestingOptionsArgs) ElementType

func (EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsOutput

func (i EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsOutput() EnterpriseKeyTestingOptionsOutput

func (EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsOutputWithContext

func (i EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsOutputWithContext(ctx context.Context) EnterpriseKeyTestingOptionsOutput

func (EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsPtrOutput

func (i EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsPtrOutput() EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsPtrOutputWithContext

func (i EnterpriseKeyTestingOptionsArgs) ToEnterpriseKeyTestingOptionsPtrOutputWithContext(ctx context.Context) EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsArgs) ToOutput added in v6.65.1

type EnterpriseKeyTestingOptionsInput

type EnterpriseKeyTestingOptionsInput interface {
	pulumi.Input

	ToEnterpriseKeyTestingOptionsOutput() EnterpriseKeyTestingOptionsOutput
	ToEnterpriseKeyTestingOptionsOutputWithContext(context.Context) EnterpriseKeyTestingOptionsOutput
}

EnterpriseKeyTestingOptionsInput is an input type that accepts EnterpriseKeyTestingOptionsArgs and EnterpriseKeyTestingOptionsOutput values. You can construct a concrete instance of `EnterpriseKeyTestingOptionsInput` via:

EnterpriseKeyTestingOptionsArgs{...}

type EnterpriseKeyTestingOptionsOutput

type EnterpriseKeyTestingOptionsOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyTestingOptionsOutput) ElementType

func (EnterpriseKeyTestingOptionsOutput) TestingChallenge

For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE

func (EnterpriseKeyTestingOptionsOutput) TestingScore

All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

func (EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsOutput

func (o EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsOutput() EnterpriseKeyTestingOptionsOutput

func (EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsOutputWithContext

func (o EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsOutputWithContext(ctx context.Context) EnterpriseKeyTestingOptionsOutput

func (EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsPtrOutput

func (o EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsPtrOutput() EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsPtrOutputWithContext

func (o EnterpriseKeyTestingOptionsOutput) ToEnterpriseKeyTestingOptionsPtrOutputWithContext(ctx context.Context) EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsOutput) ToOutput added in v6.65.1

type EnterpriseKeyTestingOptionsPtrInput

type EnterpriseKeyTestingOptionsPtrInput interface {
	pulumi.Input

	ToEnterpriseKeyTestingOptionsPtrOutput() EnterpriseKeyTestingOptionsPtrOutput
	ToEnterpriseKeyTestingOptionsPtrOutputWithContext(context.Context) EnterpriseKeyTestingOptionsPtrOutput
}

EnterpriseKeyTestingOptionsPtrInput is an input type that accepts EnterpriseKeyTestingOptionsArgs, EnterpriseKeyTestingOptionsPtr and EnterpriseKeyTestingOptionsPtrOutput values. You can construct a concrete instance of `EnterpriseKeyTestingOptionsPtrInput` via:

        EnterpriseKeyTestingOptionsArgs{...}

or:

        nil

type EnterpriseKeyTestingOptionsPtrOutput

type EnterpriseKeyTestingOptionsPtrOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyTestingOptionsPtrOutput) Elem

func (EnterpriseKeyTestingOptionsPtrOutput) ElementType

func (EnterpriseKeyTestingOptionsPtrOutput) TestingChallenge

For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE

func (EnterpriseKeyTestingOptionsPtrOutput) TestingScore

All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

func (EnterpriseKeyTestingOptionsPtrOutput) ToEnterpriseKeyTestingOptionsPtrOutput

func (o EnterpriseKeyTestingOptionsPtrOutput) ToEnterpriseKeyTestingOptionsPtrOutput() EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsPtrOutput) ToEnterpriseKeyTestingOptionsPtrOutputWithContext

func (o EnterpriseKeyTestingOptionsPtrOutput) ToEnterpriseKeyTestingOptionsPtrOutputWithContext(ctx context.Context) EnterpriseKeyTestingOptionsPtrOutput

func (EnterpriseKeyTestingOptionsPtrOutput) ToOutput added in v6.65.1

type EnterpriseKeyWebSettings

type EnterpriseKeyWebSettings struct {
	// If set to true, it means allowedDomains will not be enforced.
	AllowAllDomains *bool `pulumi:"allowAllDomains"`
	// If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
	AllowAmpTraffic *bool `pulumi:"allowAmpTraffic"`
	// Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
	AllowedDomains []string `pulumi:"allowedDomains"`
	// Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
	ChallengeSecurityPreference *string `pulumi:"challengeSecurityPreference"`
	// Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
	IntegrationType string `pulumi:"integrationType"`
}

type EnterpriseKeyWebSettingsArgs

type EnterpriseKeyWebSettingsArgs struct {
	// If set to true, it means allowedDomains will not be enforced.
	AllowAllDomains pulumi.BoolPtrInput `pulumi:"allowAllDomains"`
	// If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
	AllowAmpTraffic pulumi.BoolPtrInput `pulumi:"allowAmpTraffic"`
	// Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
	AllowedDomains pulumi.StringArrayInput `pulumi:"allowedDomains"`
	// Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
	ChallengeSecurityPreference pulumi.StringPtrInput `pulumi:"challengeSecurityPreference"`
	// Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
	IntegrationType pulumi.StringInput `pulumi:"integrationType"`
}

func (EnterpriseKeyWebSettingsArgs) ElementType

func (EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsOutput

func (i EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsOutput() EnterpriseKeyWebSettingsOutput

func (EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsOutputWithContext

func (i EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsOutputWithContext(ctx context.Context) EnterpriseKeyWebSettingsOutput

func (EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsPtrOutput

func (i EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsPtrOutput() EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsPtrOutputWithContext

func (i EnterpriseKeyWebSettingsArgs) ToEnterpriseKeyWebSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsArgs) ToOutput added in v6.65.1

type EnterpriseKeyWebSettingsInput

type EnterpriseKeyWebSettingsInput interface {
	pulumi.Input

	ToEnterpriseKeyWebSettingsOutput() EnterpriseKeyWebSettingsOutput
	ToEnterpriseKeyWebSettingsOutputWithContext(context.Context) EnterpriseKeyWebSettingsOutput
}

EnterpriseKeyWebSettingsInput is an input type that accepts EnterpriseKeyWebSettingsArgs and EnterpriseKeyWebSettingsOutput values. You can construct a concrete instance of `EnterpriseKeyWebSettingsInput` via:

EnterpriseKeyWebSettingsArgs{...}

type EnterpriseKeyWebSettingsOutput

type EnterpriseKeyWebSettingsOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyWebSettingsOutput) AllowAllDomains

If set to true, it means allowedDomains will not be enforced.

func (EnterpriseKeyWebSettingsOutput) AllowAmpTraffic

If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

func (EnterpriseKeyWebSettingsOutput) AllowedDomains

Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'

func (EnterpriseKeyWebSettingsOutput) ChallengeSecurityPreference

func (o EnterpriseKeyWebSettingsOutput) ChallengeSecurityPreference() pulumi.StringPtrOutput

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY

func (EnterpriseKeyWebSettingsOutput) ElementType

func (EnterpriseKeyWebSettingsOutput) IntegrationType

Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE

func (EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsOutput

func (o EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsOutput() EnterpriseKeyWebSettingsOutput

func (EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsOutputWithContext

func (o EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsOutputWithContext(ctx context.Context) EnterpriseKeyWebSettingsOutput

func (EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsPtrOutput

func (o EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsPtrOutput() EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsPtrOutputWithContext

func (o EnterpriseKeyWebSettingsOutput) ToEnterpriseKeyWebSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsOutput) ToOutput added in v6.65.1

type EnterpriseKeyWebSettingsPtrInput

type EnterpriseKeyWebSettingsPtrInput interface {
	pulumi.Input

	ToEnterpriseKeyWebSettingsPtrOutput() EnterpriseKeyWebSettingsPtrOutput
	ToEnterpriseKeyWebSettingsPtrOutputWithContext(context.Context) EnterpriseKeyWebSettingsPtrOutput
}

EnterpriseKeyWebSettingsPtrInput is an input type that accepts EnterpriseKeyWebSettingsArgs, EnterpriseKeyWebSettingsPtr and EnterpriseKeyWebSettingsPtrOutput values. You can construct a concrete instance of `EnterpriseKeyWebSettingsPtrInput` via:

        EnterpriseKeyWebSettingsArgs{...}

or:

        nil

type EnterpriseKeyWebSettingsPtrOutput

type EnterpriseKeyWebSettingsPtrOutput struct{ *pulumi.OutputState }

func (EnterpriseKeyWebSettingsPtrOutput) AllowAllDomains

If set to true, it means allowedDomains will not be enforced.

func (EnterpriseKeyWebSettingsPtrOutput) AllowAmpTraffic

If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

func (EnterpriseKeyWebSettingsPtrOutput) AllowedDomains

Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'

func (EnterpriseKeyWebSettingsPtrOutput) ChallengeSecurityPreference

func (o EnterpriseKeyWebSettingsPtrOutput) ChallengeSecurityPreference() pulumi.StringPtrOutput

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY

func (EnterpriseKeyWebSettingsPtrOutput) Elem

func (EnterpriseKeyWebSettingsPtrOutput) ElementType

func (EnterpriseKeyWebSettingsPtrOutput) IntegrationType

Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE

func (EnterpriseKeyWebSettingsPtrOutput) ToEnterpriseKeyWebSettingsPtrOutput

func (o EnterpriseKeyWebSettingsPtrOutput) ToEnterpriseKeyWebSettingsPtrOutput() EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsPtrOutput) ToEnterpriseKeyWebSettingsPtrOutputWithContext

func (o EnterpriseKeyWebSettingsPtrOutput) ToEnterpriseKeyWebSettingsPtrOutputWithContext(ctx context.Context) EnterpriseKeyWebSettingsPtrOutput

func (EnterpriseKeyWebSettingsPtrOutput) ToOutput added in v6.65.1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL