Google Native
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:
getKey Result
The following output properties are available:
- Android
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- Create
Time string The timestamp corresponding to the creation of this Key.
- Display
Name string Human-readable display name of this key. Modifiable by user.
- Ios
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1IOSKey Settings Response 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}".
- Testing
Options Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Testing Options Response Options for user acceptance testing.
- Waf
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Waf Settings Response Settings for WAF
- Web
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Web Key Settings Response Settings for keys that can be used by websites.
- Android
Settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- Create
Time string The timestamp corresponding to the creation of this Key.
- Display
Name string Human-readable display name of this key. Modifiable by user.
- Ios
Settings GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 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}".
- Testing
Options GoogleCloud Recaptchaenterprise V1Testing Options Response Options for user acceptance testing.
- Waf
Settings GoogleCloud Recaptchaenterprise V1Waf Settings Response Settings for WAF
- Web
Settings GoogleCloud Recaptchaenterprise V1Web Key Settings Response Settings for keys that can be used by websites.
- android
Settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- create
Time String The timestamp corresponding to the creation of this Key.
- display
Name String Human-readable display name of this key. Modifiable by user.
- ios
Settings GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 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}".
- testing
Options GoogleCloud Recaptchaenterprise V1Testing Options Response Options for user acceptance testing.
- waf
Settings GoogleCloud Recaptchaenterprise V1Waf Settings Response Settings for WAF
- web
Settings GoogleCloud Recaptchaenterprise V1Web Key Settings Response Settings for keys that can be used by websites.
- android
Settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- create
Time string The timestamp corresponding to the creation of this Key.
- display
Name string Human-readable display name of this key. Modifiable by user.
- ios
Settings GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 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}".
- testing
Options GoogleCloud Recaptchaenterprise V1Testing Options Response Options for user acceptance testing.
- waf
Settings GoogleCloud Recaptchaenterprise V1Waf Settings Response Settings for WAF
- web
Settings GoogleCloud Recaptchaenterprise V1Web Key Settings Response Settings for keys that can be used by websites.
- android_
settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response 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 GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 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 GoogleCloud Recaptchaenterprise V1Testing Options Response Options for user acceptance testing.
- waf_
settings GoogleCloud Recaptchaenterprise V1Waf Settings Response Settings for WAF
- web_
settings GoogleCloud Recaptchaenterprise V1Web Key Settings Response Settings for keys that can be used by websites.
- android
Settings Property Map Settings for keys that can be used by Android apps.
- create
Time String The timestamp corresponding to the creation of this Key.
- display
Name String Human-readable display name of this key. Modifiable by user.
- ios
Settings 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}".
- testing
Options Property Map Options for user acceptance testing.
- waf
Settings Property Map Settings for WAF
- web
Settings Property Map Settings for keys that can be used by websites.
Supporting Types
GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
- Allow
All boolPackage Names If set to true, allowed_package_names are not enforced.
- Allowed
Package List<string>Names Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- Allow
All boolPackage Names If set to true, allowed_package_names are not enforced.
- Allowed
Package []stringNames Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- allow
All BooleanPackage Names If set to true, allowed_package_names are not enforced.
- allowed
Package ListNames Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- allow
All booleanPackage Names If set to true, allowed_package_names are not enforced.
- allowed
Package string[]Names Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- allow_
all_ boolpackage_ names If set to true, allowed_package_names are not enforced.
- allowed_
package_ Sequence[str]names Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- allow
All BooleanPackage Names If set to true, allowed_package_names are not enforced.
- allowed
Package ListNames Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
- Allow
All boolBundle Ids If set to true, allowed_bundle_ids are not enforced.
- Allowed
Bundle List<string>Ids iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- Allow
All boolBundle Ids If set to true, allowed_bundle_ids are not enforced.
- Allowed
Bundle []stringIds iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- allow
All BooleanBundle Ids If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle ListIds iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- allow
All booleanBundle Ids If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle string[]Ids iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- allow_
all_ boolbundle_ ids If set to true, allowed_bundle_ids are not enforced.
- allowed_
bundle_ Sequence[str]ids iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- allow
All BooleanBundle Ids If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle ListIds iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
- Testing
Challenge 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.
- Testing
Score double All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- Testing
Challenge 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.
- Testing
Score float64 All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- testing
Challenge 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.
- testing
Score Double All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- testing
Challenge 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.
- testing
Score 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.
- testing
Challenge 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.
- testing
Score Number All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
- Waf
Feature string The WAF feature for which this key is enabled.
- Waf
Service string The WAF service that uses this key.
- Waf
Feature string The WAF feature for which this key is enabled.
- Waf
Service string The WAF service that uses this key.
- waf
Feature String The WAF feature for which this key is enabled.
- waf
Service String The WAF service that uses this key.
- waf
Feature string The WAF feature for which this key is enabled.
- waf
Service 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.
- waf
Feature String The WAF feature for which this key is enabled.
- waf
Service String The WAF service that uses this key.
GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
- Allow
All boolDomains If set to true, it means allowed_domains will not be enforced.
- Allow
Amp boolTraffic 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 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'
- Challenge
Security stringPreference 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 string Describes how this key is integrated with the website.
- Allow
All boolDomains If set to true, it means allowed_domains will not be enforced.
- Allow
Amp boolTraffic 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 []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'
- Challenge
Security stringPreference 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 string Describes how this key is integrated with the website.
- allow
All BooleanDomains If set to true, it means allowed_domains will not be enforced.
- allow
Amp BooleanTraffic 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 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'
- challenge
Security StringPreference 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 String Describes how this key is integrated with the website.
- allow
All booleanDomains If set to true, it means allowed_domains will not be enforced.
- allow
Amp booleanTraffic 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 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'
- challenge
Security stringPreference 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 string Describes how this key is integrated with the website.
- allow_
all_ booldomains If set to true, it means allowed_domains will not be enforced.
- allow_
amp_ booltraffic 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_ strpreference 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.
- allow
All BooleanDomains If set to true, it means allowed_domains will not be enforced.
- allow
Amp BooleanTraffic 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 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'
- challenge
Security StringPreference 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 String Describes how this key is integrated with the website.
Package Details
- Repository
- https://github.com/pulumi/pulumi-google-native
- License
- Apache-2.0