Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apikeys
  5. apikeys/v2
  6. Key

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apikeys/v2.Key

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is global. Auto-naming is currently not supported for this resource.

    Create Key Resource

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

    Constructor syntax

    new Key(name: string, args?: KeyArgs, opts?: CustomResourceOptions);
    @overload
def Key(resource_name: str,
        args: Optional[KeyArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Key(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        key_id: Optional[str] = None,
        location: Optional[str] = None,
        project: Optional[str] = None,
        restrictions: Optional[V2RestrictionsArgs] = None)
    func NewKey(ctx *Context, name string, args *KeyArgs, opts ...ResourceOption) (*Key, error)
    public Key(string name, KeyArgs? args = null, CustomResourceOptions? opts = null)
    public Key(String name, KeyArgs args)
public Key(String name, KeyArgs args, CustomResourceOptions options)

    type: google-native:apikeys/v2:Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args KeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var keyResource = new GoogleNative.APIKeys.V2.Key("keyResource", new()
{
    Annotations = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    KeyId = "string",
    Location = "string",
    Project = "string",
    Restrictions = new GoogleNative.APIKeys.V2.Inputs.V2RestrictionsArgs
    {
        AndroidKeyRestrictions = new GoogleNative.APIKeys.V2.Inputs.V2AndroidKeyRestrictionsArgs
        {
            AllowedApplications = new[]
            {
                new GoogleNative.APIKeys.V2.Inputs.V2AndroidApplicationArgs
                {
                    PackageName = "string",
                    Sha1Fingerprint = "string",
                },
            },
        },
        ApiTargets = new[]
        {
            new GoogleNative.APIKeys.V2.Inputs.V2ApiTargetArgs
            {
                Methods = new[]
                {
                    "string",
                },
                Service = "string",
            },
        },
        BrowserKeyRestrictions = new GoogleNative.APIKeys.V2.Inputs.V2BrowserKeyRestrictionsArgs
        {
            AllowedReferrers = new[]
            {
                "string",
            },
        },
        IosKeyRestrictions = new GoogleNative.APIKeys.V2.Inputs.V2IosKeyRestrictionsArgs
        {
            AllowedBundleIds = new[]
            {
                "string",
            },
        },
        ServerKeyRestrictions = new GoogleNative.APIKeys.V2.Inputs.V2ServerKeyRestrictionsArgs
        {
            AllowedIps = new[]
            {
                "string",
            },
        },
    },
});

    example, err := apikeys.NewKey(ctx, "keyResource", &apikeys.KeyArgs{
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
KeyId: pulumi.String("string"),
Location: pulumi.String("string"),
Project: pulumi.String("string"),
Restrictions: &apikeys.V2RestrictionsArgs{
AndroidKeyRestrictions: &apikeys.V2AndroidKeyRestrictionsArgs{
AllowedApplications: apikeys.V2AndroidApplicationArray{
&apikeys.V2AndroidApplicationArgs{
PackageName: pulumi.String("string"),
Sha1Fingerprint: pulumi.String("string"),
},
},
},
ApiTargets: apikeys.V2ApiTargetArray{
&apikeys.V2ApiTargetArgs{
Methods: pulumi.StringArray{
pulumi.String("string"),
},
Service: pulumi.String("string"),
},
},
BrowserKeyRestrictions: &apikeys.V2BrowserKeyRestrictionsArgs{
AllowedReferrers: pulumi.StringArray{
pulumi.String("string"),
},
},
IosKeyRestrictions: &apikeys.V2IosKeyRestrictionsArgs{
AllowedBundleIds: pulumi.StringArray{
pulumi.String("string"),
},
},
ServerKeyRestrictions: &apikeys.V2ServerKeyRestrictionsArgs{
AllowedIps: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})

    var keyResource = new Key("keyResource", KeyArgs.builder()        
    .annotations(Map.of("string", "string"))
    .displayName("string")
    .keyId("string")
    .location("string")
    .project("string")
    .restrictions(V2RestrictionsArgs.builder()
        .androidKeyRestrictions(V2AndroidKeyRestrictionsArgs.builder()
            .allowedApplications(V2AndroidApplicationArgs.builder()
                .packageName("string")
                .sha1Fingerprint("string")
                .build())
            .build())
        .apiTargets(V2ApiTargetArgs.builder()
            .methods("string")
            .service("string")
            .build())
        .browserKeyRestrictions(V2BrowserKeyRestrictionsArgs.builder()
            .allowedReferrers("string")
            .build())
        .iosKeyRestrictions(V2IosKeyRestrictionsArgs.builder()
            .allowedBundleIds("string")
            .build())
        .serverKeyRestrictions(V2ServerKeyRestrictionsArgs.builder()
            .allowedIps("string")
            .build())
        .build())
    .build());

    key_resource = google_native.apikeys.v2.Key("keyResource",
    annotations={
        "string": "string",
    },
    display_name="string",
    key_id="string",
    location="string",
    project="string",
    restrictions=google_native.apikeys.v2.V2RestrictionsArgs(
        android_key_restrictions=google_native.apikeys.v2.V2AndroidKeyRestrictionsArgs(
            allowed_applications=[google_native.apikeys.v2.V2AndroidApplicationArgs(
                package_name="string",
                sha1_fingerprint="string",
            )],
        ),
        api_targets=[google_native.apikeys.v2.V2ApiTargetArgs(
            methods=["string"],
            service="string",
        )],
        browser_key_restrictions=google_native.apikeys.v2.V2BrowserKeyRestrictionsArgs(
            allowed_referrers=["string"],
        ),
        ios_key_restrictions=google_native.apikeys.v2.V2IosKeyRestrictionsArgs(
            allowed_bundle_ids=["string"],
        ),
        server_key_restrictions=google_native.apikeys.v2.V2ServerKeyRestrictionsArgs(
            allowed_ips=["string"],
        ),
    ))

    const keyResource = new google_native.apikeys.v2.Key("keyResource", {
    annotations: {
        string: "string",
    },
    displayName: "string",
    keyId: "string",
    location: "string",
    project: "string",
    restrictions: {
        androidKeyRestrictions: {
            allowedApplications: [{
                packageName: "string",
                sha1Fingerprint: "string",
            }],
        },
        apiTargets: [{
            methods: ["string"],
            service: "string",
        }],
        browserKeyRestrictions: {
            allowedReferrers: ["string"],
        },
        iosKeyRestrictions: {
            allowedBundleIds: ["string"],
        },
        serverKeyRestrictions: {
            allowedIps: ["string"],
        },
    },
});

    type: google-native:apikeys/v2:Key
properties:
    annotations:
        string: string
    displayName: string
    keyId: string
    location: string
    project: string
    restrictions:
        androidKeyRestrictions:
            allowedApplications:
                - packageName: string
                  sha1Fingerprint: string
        apiTargets:
            - methods:
                - string
              service: string
        browserKeyRestrictions:
            allowedReferrers:
                - string
        iosKeyRestrictions:
            allowedBundleIds:
                - string
        serverKeyRestrictions:
            allowedIps:
                - string

    Key Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Key resource accepts the following input properties:

    Annotations Dictionary<string, string>
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    DisplayName string
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    KeyId string
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    Location string
    Project string
    Restrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2Restrictions
    Key restrictions.
    Annotations map[string]string
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    DisplayName string
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    KeyId string
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    Location string
    Project string
    Restrictions V2RestrictionsArgs
    Key restrictions.
    annotations Map<String,String>
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    displayName String
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    keyId String
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    location String
    project String
    restrictions V2Restrictions
    Key restrictions.
    annotations {[key: string]: string}
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    displayName string
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    keyId string
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    location string
    project string
    restrictions V2Restrictions
    Key restrictions.
    annotations Mapping[str, str]
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    display_name str
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    key_id str
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    location str
    project str
    restrictions V2RestrictionsArgs
    Key restrictions.
    annotations Map<String>
    Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
    displayName String
    Human-readable display name of this key that you can modify. The maximum length is 63 characters.
    keyId String
    User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
    location String
    project String
    restrictions Property Map
    Key restrictions.

    Outputs

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

    CreateTime string
    A timestamp identifying the time this key was originally created.
    DeleteTime string
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    Etag string
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyString string
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    Name string
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    Uid string
    Unique id in UUID4 format.
    UpdateTime string
    A timestamp identifying the time this key was last updated.
    CreateTime string
    A timestamp identifying the time this key was originally created.
    DeleteTime string
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    Etag string
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyString string
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    Name string
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    Uid string
    Unique id in UUID4 format.
    UpdateTime string
    A timestamp identifying the time this key was last updated.
    createTime String
    A timestamp identifying the time this key was originally created.
    deleteTime String
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    etag String
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    id String
    The provider-assigned unique ID for this managed resource.
    keyString String
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    name String
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    uid String
    Unique id in UUID4 format.
    updateTime String
    A timestamp identifying the time this key was last updated.
    createTime string
    A timestamp identifying the time this key was originally created.
    deleteTime string
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    etag string
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    id string
    The provider-assigned unique ID for this managed resource.
    keyString string
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    name string
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    uid string
    Unique id in UUID4 format.
    updateTime string
    A timestamp identifying the time this key was last updated.
    create_time str
    A timestamp identifying the time this key was originally created.
    delete_time str
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    etag str
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    id str
    The provider-assigned unique ID for this managed resource.
    key_string str
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    name str
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    uid str
    Unique id in UUID4 format.
    update_time str
    A timestamp identifying the time this key was last updated.
    createTime String
    A timestamp identifying the time this key was originally created.
    deleteTime String
    A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
    etag String
    A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
    id String
    The provider-assigned unique ID for this managed resource.
    keyString String
    An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
    name String
    The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.
    uid String
    Unique id in UUID4 format.
    updateTime String
    A timestamp identifying the time this key was last updated.

    Supporting Types

    V2AndroidApplication, V2AndroidApplicationArgs

    PackageName string
    The package name of the application.
    Sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    PackageName string
    The package name of the application.
    Sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName String
    The package name of the application.
    sha1Fingerprint String
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName string
    The package name of the application.
    sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    package_name str
    The package name of the application.
    sha1_fingerprint str
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName String
    The package name of the application.
    sha1Fingerprint String
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.

    V2AndroidApplicationResponse, V2AndroidApplicationResponseArgs

    PackageName string
    The package name of the application.
    Sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    PackageName string
    The package name of the application.
    Sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName String
    The package name of the application.
    sha1Fingerprint String
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName string
    The package name of the application.
    sha1Fingerprint string
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    package_name str
    The package name of the application.
    sha1_fingerprint str
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
    packageName String
    The package name of the application.
    sha1Fingerprint String
    The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.

    V2AndroidKeyRestrictions, V2AndroidKeyRestrictionsArgs

    AllowedApplications List<Pulumi.GoogleNative.APIKeys.V2.Inputs.V2AndroidApplication>
    A list of Android applications that are allowed to make API calls with this key.
    AllowedApplications []V2AndroidApplication
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications List<V2AndroidApplication>
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications V2AndroidApplication[]
    A list of Android applications that are allowed to make API calls with this key.
    allowed_applications Sequence[V2AndroidApplication]
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications List<Property Map>
    A list of Android applications that are allowed to make API calls with this key.

    V2AndroidKeyRestrictionsResponse, V2AndroidKeyRestrictionsResponseArgs

    AllowedApplications List<Pulumi.GoogleNative.APIKeys.V2.Inputs.V2AndroidApplicationResponse>
    A list of Android applications that are allowed to make API calls with this key.
    AllowedApplications []V2AndroidApplicationResponse
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications List<V2AndroidApplicationResponse>
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications V2AndroidApplicationResponse[]
    A list of Android applications that are allowed to make API calls with this key.
    allowed_applications Sequence[V2AndroidApplicationResponse]
    A list of Android applications that are allowed to make API calls with this key.
    allowedApplications List<Property Map>
    A list of Android applications that are allowed to make API calls with this key.

    V2ApiTarget, V2ApiTargetArgs

    Methods List<string>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    Service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    Methods []string
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    Service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods List<String>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service String
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods string[]
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods Sequence[str]
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service str
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods List<String>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service String
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.

    V2ApiTargetResponse, V2ApiTargetResponseArgs

    Methods List<string>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    Service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    Methods []string
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    Service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods List<String>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service String
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods string[]
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service string
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods Sequence[str]
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service str
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    methods List<String>
    Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    service String
    The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.

    V2BrowserKeyRestrictions, V2BrowserKeyRestrictionsArgs

    AllowedReferrers List<string>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    AllowedReferrers []string
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers List<String>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers string[]
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowed_referrers Sequence[str]
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers List<String>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.

    V2BrowserKeyRestrictionsResponse, V2BrowserKeyRestrictionsResponseArgs

    AllowedReferrers List<string>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    AllowedReferrers []string
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers List<String>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers string[]
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowed_referrers Sequence[str]
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    allowedReferrers List<String>
    A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.

    V2IosKeyRestrictions, V2IosKeyRestrictionsArgs

    AllowedBundleIds List<string>
    A list of bundle IDs that are allowed when making API calls with this key.
    AllowedBundleIds []string
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds List<String>
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds string[]
    A list of bundle IDs that are allowed when making API calls with this key.
    allowed_bundle_ids Sequence[str]
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds List<String>
    A list of bundle IDs that are allowed when making API calls with this key.

    V2IosKeyRestrictionsResponse, V2IosKeyRestrictionsResponseArgs

    AllowedBundleIds List<string>
    A list of bundle IDs that are allowed when making API calls with this key.
    AllowedBundleIds []string
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds List<String>
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds string[]
    A list of bundle IDs that are allowed when making API calls with this key.
    allowed_bundle_ids Sequence[str]
    A list of bundle IDs that are allowed when making API calls with this key.
    allowedBundleIds List<String>
    A list of bundle IDs that are allowed when making API calls with this key.

    V2Restrictions, V2RestrictionsArgs

    AndroidKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2AndroidKeyRestrictions
    The Android apps that are allowed to use the key.
    ApiTargets List<Pulumi.GoogleNative.APIKeys.V2.Inputs.V2ApiTarget>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    BrowserKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2BrowserKeyRestrictions
    The HTTP referrers (websites) that are allowed to use the key.
    IosKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2IosKeyRestrictions
    The iOS apps that are allowed to use the key.
    ServerKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2ServerKeyRestrictions
    The IP addresses of callers that are allowed to use the key.
    AndroidKeyRestrictions V2AndroidKeyRestrictions
    The Android apps that are allowed to use the key.
    ApiTargets []V2ApiTarget
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    BrowserKeyRestrictions V2BrowserKeyRestrictions
    The HTTP referrers (websites) that are allowed to use the key.
    IosKeyRestrictions V2IosKeyRestrictions
    The iOS apps that are allowed to use the key.
    ServerKeyRestrictions V2ServerKeyRestrictions
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions V2AndroidKeyRestrictions
    The Android apps that are allowed to use the key.
    apiTargets List<V2ApiTarget>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions V2BrowserKeyRestrictions
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions V2IosKeyRestrictions
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions V2ServerKeyRestrictions
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions V2AndroidKeyRestrictions
    The Android apps that are allowed to use the key.
    apiTargets V2ApiTarget[]
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions V2BrowserKeyRestrictions
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions V2IosKeyRestrictions
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions V2ServerKeyRestrictions
    The IP addresses of callers that are allowed to use the key.
    android_key_restrictions V2AndroidKeyRestrictions
    The Android apps that are allowed to use the key.
    api_targets Sequence[V2ApiTarget]
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browser_key_restrictions V2BrowserKeyRestrictions
    The HTTP referrers (websites) that are allowed to use the key.
    ios_key_restrictions V2IosKeyRestrictions
    The iOS apps that are allowed to use the key.
    server_key_restrictions V2ServerKeyRestrictions
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions Property Map
    The Android apps that are allowed to use the key.
    apiTargets List<Property Map>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions Property Map
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions Property Map
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions Property Map
    The IP addresses of callers that are allowed to use the key.

    V2RestrictionsResponse, V2RestrictionsResponseArgs

    AndroidKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2AndroidKeyRestrictionsResponse
    The Android apps that are allowed to use the key.
    ApiTargets List<Pulumi.GoogleNative.APIKeys.V2.Inputs.V2ApiTargetResponse>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    BrowserKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2BrowserKeyRestrictionsResponse
    The HTTP referrers (websites) that are allowed to use the key.
    IosKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2IosKeyRestrictionsResponse
    The iOS apps that are allowed to use the key.
    ServerKeyRestrictions Pulumi.GoogleNative.APIKeys.V2.Inputs.V2ServerKeyRestrictionsResponse
    The IP addresses of callers that are allowed to use the key.
    AndroidKeyRestrictions V2AndroidKeyRestrictionsResponse
    The Android apps that are allowed to use the key.
    ApiTargets []V2ApiTargetResponse
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    BrowserKeyRestrictions V2BrowserKeyRestrictionsResponse
    The HTTP referrers (websites) that are allowed to use the key.
    IosKeyRestrictions V2IosKeyRestrictionsResponse
    The iOS apps that are allowed to use the key.
    ServerKeyRestrictions V2ServerKeyRestrictionsResponse
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions V2AndroidKeyRestrictionsResponse
    The Android apps that are allowed to use the key.
    apiTargets List<V2ApiTargetResponse>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions V2BrowserKeyRestrictionsResponse
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions V2IosKeyRestrictionsResponse
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions V2ServerKeyRestrictionsResponse
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions V2AndroidKeyRestrictionsResponse
    The Android apps that are allowed to use the key.
    apiTargets V2ApiTargetResponse[]
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions V2BrowserKeyRestrictionsResponse
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions V2IosKeyRestrictionsResponse
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions V2ServerKeyRestrictionsResponse
    The IP addresses of callers that are allowed to use the key.
    android_key_restrictions V2AndroidKeyRestrictionsResponse
    The Android apps that are allowed to use the key.
    api_targets Sequence[V2ApiTargetResponse]
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browser_key_restrictions V2BrowserKeyRestrictionsResponse
    The HTTP referrers (websites) that are allowed to use the key.
    ios_key_restrictions V2IosKeyRestrictionsResponse
    The iOS apps that are allowed to use the key.
    server_key_restrictions V2ServerKeyRestrictionsResponse
    The IP addresses of callers that are allowed to use the key.
    androidKeyRestrictions Property Map
    The Android apps that are allowed to use the key.
    apiTargets List<Property Map>
    A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
    browserKeyRestrictions Property Map
    The HTTP referrers (websites) that are allowed to use the key.
    iosKeyRestrictions Property Map
    The iOS apps that are allowed to use the key.
    serverKeyRestrictions Property Map
    The IP addresses of callers that are allowed to use the key.

    V2ServerKeyRestrictions, V2ServerKeyRestrictionsArgs

    AllowedIps List<string>
    A list of the caller IP addresses that are allowed to make API calls with this key.
    AllowedIps []string
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps List<String>
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps string[]
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowed_ips Sequence[str]
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps List<String>
    A list of the caller IP addresses that are allowed to make API calls with this key.

    V2ServerKeyRestrictionsResponse, V2ServerKeyRestrictionsResponseArgs

    AllowedIps List<string>
    A list of the caller IP addresses that are allowed to make API calls with this key.
    AllowedIps []string
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps List<String>
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps string[]
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowed_ips Sequence[str]
    A list of the caller IP addresses that are allowed to make API calls with this key.
    allowedIps List<String>
    A list of the caller IP addresses that are allowed to make API calls with this key.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native