Google Native

Pulumi Official
Package maintained by Pulumi
v0.18.2 published on Monday, May 2, 2022 by Pulumi

getKey

Returns the specified key.

Using getKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>
def get_key(key_id: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_id: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]
func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

> Note: This function is named LookupKey in the Go SDK.

public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:recaptchaenterprise/v1:getKey
  Arguments:
    # Arguments dictionary

The following arguments are supported:

KeyId string
Project string
KeyId string
Project string
keyId String
project String
keyId string
project string
keyId String
project String

getKey Result

The following output properties are available:

AndroidSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

Settings for keys that can be used by Android apps.

CreateTime string

The timestamp corresponding to the creation of this Key.

DisplayName string

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

IosSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

Settings for keys that can be used by iOS apps.

Labels Dictionary<string, string>

See Creating and managing labels.

Name string

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

TestingOptions Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

Options for user acceptance testing.

WafSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

Settings for WAF

WebSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

Settings for keys that can be used by websites.

AndroidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

Settings for keys that can be used by Android apps.

CreateTime string

The timestamp corresponding to the creation of this Key.

DisplayName string

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

IosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

Settings for keys that can be used by iOS apps.

Labels map[string]string

See Creating and managing labels.

Name string

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

TestingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

Options for user acceptance testing.

WafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

Settings for WAF

WebSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

Settings for keys that can be used by websites.

androidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

Settings for keys that can be used by Android apps.

createTime String

The timestamp corresponding to the creation of this Key.

displayName String

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

iosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

Settings for keys that can be used by iOS apps.

labels Map

See Creating and managing labels.

name String

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

testingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

Options for user acceptance testing.

wafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

Settings for WAF

webSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

Settings for keys that can be used by websites.

androidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

Settings for keys that can be used by Android apps.

createTime string

The timestamp corresponding to the creation of this Key.

displayName string

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

iosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

Settings for keys that can be used by iOS apps.

labels {[key: string]: string}

See Creating and managing labels.

name string

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

testingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

Options for user acceptance testing.

wafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

Settings for WAF

webSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

Settings for keys that can be used by websites.

android_settings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

Settings for keys that can be used by Android apps.

create_time str

The timestamp corresponding to the creation of this Key.

display_name str

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

ios_settings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

Settings for keys that can be used by iOS apps.

labels Mapping[str, str]

See Creating and managing labels.

name str

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

testing_options GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

Options for user acceptance testing.

waf_settings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

Settings for WAF

web_settings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

Settings for keys that can be used by websites.

androidSettings Property Map

Settings for keys that can be used by Android apps.

createTime String

The timestamp corresponding to the creation of this Key.

displayName String

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

iosSettings Property Map

Settings for keys that can be used by iOS apps.

labels Map

See Creating and managing labels.

name String

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

testingOptions Property Map

Options for user acceptance testing.

wafSettings Property Map

Settings for WAF

webSettings Property Map

Settings for keys that can be used by websites.

Supporting Types

GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

AllowAllPackageNames bool

If set to true, allowed_package_names are not enforced.

AllowedPackageNames List<string>

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

AllowAllPackageNames bool

If set to true, allowed_package_names are not enforced.

AllowedPackageNames []string

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

allowAllPackageNames Boolean

If set to true, allowed_package_names are not enforced.

allowedPackageNames List

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

allowAllPackageNames boolean

If set to true, allowed_package_names are not enforced.

allowedPackageNames string[]

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

allow_all_package_names bool

If set to true, allowed_package_names are not enforced.

allowed_package_names Sequence[str]

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

allowAllPackageNames Boolean

If set to true, allowed_package_names are not enforced.

allowedPackageNames List

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

GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

AllowAllBundleIds bool

If set to true, allowed_bundle_ids are not enforced.

AllowedBundleIds List<string>

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

AllowAllBundleIds bool

If set to true, allowed_bundle_ids are not enforced.

AllowedBundleIds []string

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

allowAllBundleIds Boolean

If set to true, allowed_bundle_ids are not enforced.

allowedBundleIds List

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

allowAllBundleIds boolean

If set to true, allowed_bundle_ids are not enforced.

allowedBundleIds string[]

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

allow_all_bundle_ids bool

If set to true, allowed_bundle_ids are not enforced.

allowed_bundle_ids Sequence[str]

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

allowAllBundleIds Boolean

If set to true, allowed_bundle_ids are not enforced.

allowedBundleIds List

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

GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

TestingChallenge string

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

TestingScore double

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

TestingChallenge string

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

TestingScore float64

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

testingChallenge String

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

testingScore Double

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

testingChallenge string

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

testingScore number

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

testing_challenge str

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

testing_score float

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

testingChallenge String

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

testingScore Number

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

GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

WafFeature string

The WAF feature for which this key is enabled.

WafService string

The WAF service that uses this key.

WafFeature string

The WAF feature for which this key is enabled.

WafService string

The WAF service that uses this key.

wafFeature String

The WAF feature for which this key is enabled.

wafService String

The WAF service that uses this key.

wafFeature string

The WAF feature for which this key is enabled.

wafService string

The WAF service that uses this key.

waf_feature str

The WAF feature for which this key is enabled.

waf_service str

The WAF service that uses this key.

wafFeature String

The WAF feature for which this key is enabled.

wafService String

The WAF service that uses this key.

GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

AllowAllDomains bool

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

AllowAmpTraffic bool

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

AllowedDomains List<string>

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'

ChallengeSecurityPreference string

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

IntegrationType string

Describes how this key is integrated with the website.

AllowAllDomains bool

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

AllowAmpTraffic bool

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

AllowedDomains []string

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'

ChallengeSecurityPreference string

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

IntegrationType string

Describes how this key is integrated with the website.

allowAllDomains Boolean

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

allowAmpTraffic Boolean

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

allowedDomains List

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'

challengeSecurityPreference String

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

integrationType String

Describes how this key is integrated with the website.

allowAllDomains boolean

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

allowAmpTraffic boolean

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

allowedDomains string[]

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'

challengeSecurityPreference string

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

integrationType string

Describes how this key is integrated with the website.

allow_all_domains bool

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

allow_amp_traffic bool

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

allowed_domains Sequence[str]

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'

challenge_security_preference str

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

integration_type str

Describes how this key is integrated with the website.

allowAllDomains Boolean

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

allowAmpTraffic Boolean

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

allowedDomains List

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'

challengeSecurityPreference String

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

integrationType String

Describes how this key is integrated with the website.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0