gcp.discoveryengine.CmekConfig
Explore with Pulumi AI
CmekConfig represents configurations used to enable CMEK data encryption with Cloud KMS keys.
To get more information about CmekConfig, see:
Example Usage
Discoveryengine Cmekconfig Default
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const cryptoKey = new gcp.kms.CryptoKeyIAMMember("crypto_key", {
cryptoKeyId: "kms-key-name",
role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-discoveryengine.iam.gserviceaccount.com`),
});
const _default = new gcp.discoveryengine.CmekConfig("default", {
location: "us",
cmekConfigId: "cmek-config-id",
kmsKey: "kms-key-name",
}, {
dependsOn: [cryptoKey],
});
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
crypto_key = gcp.kms.CryptoKeyIAMMember("crypto_key",
crypto_key_id="kms-key-name",
role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
member=f"serviceAccount:service-{project.number}@gcp-sa-discoveryengine.iam.gserviceaccount.com")
default = gcp.discoveryengine.CmekConfig("default",
location="us",
cmek_config_id="cmek-config-id",
kms_key="kms-key-name",
opts = pulumi.ResourceOptions(depends_on=[crypto_key]))
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
if err != nil {
return err
}
cryptoKey, err := kms.NewCryptoKeyIAMMember(ctx, "crypto_key", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: pulumi.String("kms-key-name"),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
Member: pulumi.Sprintf("serviceAccount:service-%v@gcp-sa-discoveryengine.iam.gserviceaccount.com", project.Number),
})
if err != nil {
return err
}
_, err = discoveryengine.NewCmekConfig(ctx, "default", &discoveryengine.CmekConfigArgs{
Location: pulumi.String("us"),
CmekConfigId: pulumi.String("cmek-config-id"),
KmsKey: pulumi.String("kms-key-name"),
}, pulumi.DependsOn([]pulumi.Resource{
cryptoKey,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = Gcp.Organizations.GetProject.Invoke();
var cryptoKey = new Gcp.Kms.CryptoKeyIAMMember("crypto_key", new()
{
CryptoKeyId = "kms-key-name",
Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
Member = $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-discoveryengine.iam.gserviceaccount.com",
});
var @default = new Gcp.DiscoveryEngine.CmekConfig("default", new()
{
Location = "us",
CmekConfigId = "cmek-config-id",
KmsKey = "kms-key-name",
}, new CustomResourceOptions
{
DependsOn =
{
cryptoKey,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.discoveryengine.CmekConfig;
import com.pulumi.gcp.discoveryengine.CmekConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.build());
var cryptoKey = new CryptoKeyIAMMember("cryptoKey", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId("kms-key-name")
.role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
.member(String.format("serviceAccount:service-%s@gcp-sa-discoveryengine.iam.gserviceaccount.com", project.number()))
.build());
var default_ = new CmekConfig("default", CmekConfigArgs.builder()
.location("us")
.cmekConfigId("cmek-config-id")
.kmsKey("kms-key-name")
.build(), CustomResourceOptions.builder()
.dependsOn(cryptoKey)
.build());
}
}
resources:
default:
type: gcp:discoveryengine:CmekConfig
properties:
location: us
cmekConfigId: cmek-config-id
kmsKey: kms-key-name
options:
dependsOn:
- ${cryptoKey}
cryptoKey:
type: gcp:kms:CryptoKeyIAMMember
name: crypto_key
properties:
cryptoKeyId: kms-key-name
role: roles/cloudkms.cryptoKeyEncrypterDecrypter
member: serviceAccount:service-${project.number}@gcp-sa-discoveryengine.iam.gserviceaccount.com
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
Create CmekConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CmekConfig(name: string, args: CmekConfigArgs, opts?: CustomResourceOptions);
@overload
def CmekConfig(resource_name: str,
args: CmekConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CmekConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
kms_key: Optional[str] = None,
location: Optional[str] = None,
cmek_config_id: Optional[str] = None,
project: Optional[str] = None,
set_default: Optional[bool] = None,
single_region_keys: Optional[Sequence[CmekConfigSingleRegionKeyArgs]] = None)
func NewCmekConfig(ctx *Context, name string, args CmekConfigArgs, opts ...ResourceOption) (*CmekConfig, error)
public CmekConfig(string name, CmekConfigArgs args, CustomResourceOptions? opts = null)
public CmekConfig(String name, CmekConfigArgs args)
public CmekConfig(String name, CmekConfigArgs args, CustomResourceOptions options)
type: gcp:discoveryengine:CmekConfig
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 CmekConfigArgs
- 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 CmekConfigArgs
- 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 CmekConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CmekConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CmekConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cmekConfigResource = new Gcp.DiscoveryEngine.CmekConfig("cmekConfigResource", new()
{
KmsKey = "string",
Location = "string",
CmekConfigId = "string",
Project = "string",
SetDefault = false,
SingleRegionKeys = new[]
{
new Gcp.DiscoveryEngine.Inputs.CmekConfigSingleRegionKeyArgs
{
KmsKey = "string",
},
},
});
example, err := discoveryengine.NewCmekConfig(ctx, "cmekConfigResource", &discoveryengine.CmekConfigArgs{
KmsKey: pulumi.String("string"),
Location: pulumi.String("string"),
CmekConfigId: pulumi.String("string"),
Project: pulumi.String("string"),
SetDefault: pulumi.Bool(false),
SingleRegionKeys: discoveryengine.CmekConfigSingleRegionKeyArray{
&discoveryengine.CmekConfigSingleRegionKeyArgs{
KmsKey: pulumi.String("string"),
},
},
})
var cmekConfigResource = new CmekConfig("cmekConfigResource", CmekConfigArgs.builder()
.kmsKey("string")
.location("string")
.cmekConfigId("string")
.project("string")
.setDefault(false)
.singleRegionKeys(CmekConfigSingleRegionKeyArgs.builder()
.kmsKey("string")
.build())
.build());
cmek_config_resource = gcp.discoveryengine.CmekConfig("cmekConfigResource",
kms_key="string",
location="string",
cmek_config_id="string",
project="string",
set_default=False,
single_region_keys=[{
"kms_key": "string",
}])
const cmekConfigResource = new gcp.discoveryengine.CmekConfig("cmekConfigResource", {
kmsKey: "string",
location: "string",
cmekConfigId: "string",
project: "string",
setDefault: false,
singleRegionKeys: [{
kmsKey: "string",
}],
});
type: gcp:discoveryengine:CmekConfig
properties:
cmekConfigId: string
kmsKey: string
location: string
project: string
setDefault: false
singleRegionKeys:
- kmsKey: string
CmekConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CmekConfig resource accepts the following input properties:
- Kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - Location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- Cmek
Config stringId - The unique id of the cmek config.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Set
Default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- Single
Region List<CmekKeys Config Single Region Key> - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- Kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - Location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- Cmek
Config stringId - The unique id of the cmek config.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Set
Default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- Single
Region []CmekKeys Config Single Region Key Args - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- kms
Key String - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - location String
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- cmek
Config StringId - The unique id of the cmek config.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default Boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region List<CmekKeys Config Single Region Key> - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- cmek
Config stringId - The unique id of the cmek config.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region CmekKeys Config Single Region Key[] - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- kms_
key str - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - location str
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- cmek_
config_ strid - The unique id of the cmek config.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set_
default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single_
region_ Sequence[Cmekkeys Config Single Region Key Args] - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- kms
Key String - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - location String
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- cmek
Config StringId - The unique id of the cmek config.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default Boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region List<Property Map>Keys - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the CmekConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default bool - The default CmekConfig for the Customer.
- Kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - Last
Rotation intTimestamp Micros - The timestamp of the last key rotation.
- Name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- State string
- The state of the CmekConfig.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default bool - The default CmekConfig for the Customer.
- Kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - Last
Rotation intTimestamp Micros - The timestamp of the last key rotation.
- Name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- State string
- The state of the CmekConfig.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default Boolean - The default CmekConfig for the Customer.
- kms
Key StringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation IntegerTimestamp Micros - The timestamp of the last key rotation.
- name String
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State String - Whether the NotebookLM Corpus is ready to be used.
- state String
- The state of the CmekConfig.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Default boolean - The default CmekConfig for the Customer.
- kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation numberTimestamp Micros - The timestamp of the last key rotation.
- name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- state string
- The state of the CmekConfig.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
default bool - The default CmekConfig for the Customer.
- kms_
key_ strversion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last_
rotation_ inttimestamp_ micros - The timestamp of the last key rotation.
- name str
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm_
state str - Whether the NotebookLM Corpus is ready to be used.
- state str
- The state of the CmekConfig.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default Boolean - The default CmekConfig for the Customer.
- kms
Key StringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation NumberTimestamp Micros - The timestamp of the last key rotation.
- name String
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State String - Whether the NotebookLM Corpus is ready to be used.
- state String
- The state of the CmekConfig.
Look up Existing CmekConfig Resource
Get an existing CmekConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CmekConfigState, opts?: CustomResourceOptions): CmekConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cmek_config_id: Optional[str] = None,
is_default: Optional[bool] = None,
kms_key: Optional[str] = None,
kms_key_version: Optional[str] = None,
last_rotation_timestamp_micros: Optional[int] = None,
location: Optional[str] = None,
name: Optional[str] = None,
notebooklm_state: Optional[str] = None,
project: Optional[str] = None,
set_default: Optional[bool] = None,
single_region_keys: Optional[Sequence[CmekConfigSingleRegionKeyArgs]] = None,
state: Optional[str] = None) -> CmekConfig
func GetCmekConfig(ctx *Context, name string, id IDInput, state *CmekConfigState, opts ...ResourceOption) (*CmekConfig, error)
public static CmekConfig Get(string name, Input<string> id, CmekConfigState? state, CustomResourceOptions? opts = null)
public static CmekConfig get(String name, Output<String> id, CmekConfigState state, CustomResourceOptions options)
resources: _: type: gcp:discoveryengine:CmekConfig get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cmek
Config stringId - The unique id of the cmek config.
- Is
Default bool - The default CmekConfig for the Customer.
- Kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - Kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - Last
Rotation intTimestamp Micros - The timestamp of the last key rotation.
- Location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- Name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Set
Default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- Single
Region List<CmekKeys Config Single Region Key> - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- State string
- The state of the CmekConfig.
- Cmek
Config stringId - The unique id of the cmek config.
- Is
Default bool - The default CmekConfig for the Customer.
- Kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - Kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - Last
Rotation intTimestamp Micros - The timestamp of the last key rotation.
- Location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- Name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Set
Default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- Single
Region []CmekKeys Config Single Region Key Args - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- State string
- The state of the CmekConfig.
- cmek
Config StringId - The unique id of the cmek config.
- is
Default Boolean - The default CmekConfig for the Customer.
- kms
Key String - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - kms
Key StringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation IntegerTimestamp Micros - The timestamp of the last key rotation.
- location String
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- name String
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State String - Whether the NotebookLM Corpus is ready to be used.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default Boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region List<CmekKeys Config Single Region Key> - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- state String
- The state of the CmekConfig.
- cmek
Config stringId - The unique id of the cmek config.
- is
Default boolean - The default CmekConfig for the Customer.
- kms
Key string - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - kms
Key stringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation numberTimestamp Micros - The timestamp of the last key rotation.
- location string
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- name string
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State string - Whether the NotebookLM Corpus is ready to be used.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region CmekKeys Config Single Region Key[] - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- state string
- The state of the CmekConfig.
- cmek_
config_ strid - The unique id of the cmek config.
- is_
default bool - The default CmekConfig for the Customer.
- kms_
key str - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - kms_
key_ strversion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last_
rotation_ inttimestamp_ micros - The timestamp of the last key rotation.
- location str
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- name str
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm_
state str - Whether the NotebookLM Corpus is ready to be used.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set_
default bool - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single_
region_ Sequence[Cmekkeys Config Single Region Key Args] - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- state str
- The state of the CmekConfig.
- cmek
Config StringId - The unique id of the cmek config.
- is
Default Boolean - The default CmekConfig for the Customer.
- kms
Key String - KMS key resource name which will be used to encrypt resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
. - kms
Key StringVersion - KMS key version resource name which will be used to encrypt resources
<kms_key>/cryptoKeyVersions/{keyVersion}
. - last
Rotation NumberTimestamp Micros - The timestamp of the last key rotation.
- location String
- The geographic location where the CMEK config should reside. The value can only be one of "us" and "eu".
- name String
- The unique full resource name of the cmek config. Values are of the format
projects/{project}/locations/{location}/cmekConfigs/{cmek_config_id}
. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - notebooklm
State String - Whether the NotebookLM Corpus is ready to be used.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- set
Default Boolean - Set the following CmekConfig as the default to be used for child resources if one is not specified. The default value is true.
- single
Region List<Property Map>Keys - Single-regional CMEKs that are required for some VAIS features. Structure is documented below.
- state String
- The state of the CmekConfig.
Supporting Types
CmekConfigSingleRegionKey, CmekConfigSingleRegionKeyArgs
- Kms
Key string - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
- Kms
Key string - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
- kms
Key String - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
- kms
Key string - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
- kms_
key str - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
- kms
Key String - Single-regional kms key resource name which will be used to encrypt
resources
projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}
.
Import
CmekConfig can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/cmekConfigs/{{cmek_config_id}}
{{project}}/{{location}}/{{cmek_config_id}}
{{location}}/{{cmek_config_id}}
When using the pulumi import
command, CmekConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:discoveryengine/cmekConfig:CmekConfig default projects/{{project}}/locations/{{location}}/cmekConfigs/{{cmek_config_id}}
$ pulumi import gcp:discoveryengine/cmekConfig:CmekConfig default {{project}}/{{location}}/{{cmek_config_id}}
$ pulumi import gcp:discoveryengine/cmekConfig:CmekConfig default {{location}}/{{cmek_config_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.