gcp.essentialcontacts.DocumentAiWarehouseLocation
Explore with Pulumi AI
A location is used to initialize a project.
To get more information about Location, see:
- API documentation
- How-to Guides
Example Usage
Document Ai Warehouse Location
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const example = new gcp.essentialcontacts.DocumentAiWarehouseLocation("example", {
location: "us",
projectNumber: project.then(project => project.number),
accessControlMode: "ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI",
databaseType: "DB_INFRA_SPANNER",
kmsKey: "dummy_key",
documentCreatorDefaultRole: "DOCUMENT_ADMIN",
});
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
example = gcp.essentialcontacts.DocumentAiWarehouseLocation("example",
location="us",
project_number=project.number,
access_control_mode="ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI",
database_type="DB_INFRA_SPANNER",
kms_key="dummy_key",
document_creator_default_role="DOCUMENT_ADMIN")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/essentialcontacts"
"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
}
_, err = essentialcontacts.NewDocumentAiWarehouseLocation(ctx, "example", &essentialcontacts.DocumentAiWarehouseLocationArgs{
Location: pulumi.String("us"),
ProjectNumber: pulumi.String(project.Number),
AccessControlMode: pulumi.String("ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI"),
DatabaseType: pulumi.String("DB_INFRA_SPANNER"),
KmsKey: pulumi.String("dummy_key"),
DocumentCreatorDefaultRole: pulumi.String("DOCUMENT_ADMIN"),
})
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 example = new Gcp.EssentialContacts.DocumentAiWarehouseLocation("example", new()
{
Location = "us",
ProjectNumber = project.Apply(getProjectResult => getProjectResult.Number),
AccessControlMode = "ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI",
DatabaseType = "DB_INFRA_SPANNER",
KmsKey = "dummy_key",
DocumentCreatorDefaultRole = "DOCUMENT_ADMIN",
});
});
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.essentialcontacts.DocumentAiWarehouseLocation;
import com.pulumi.gcp.essentialcontacts.DocumentAiWarehouseLocationArgs;
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();
var example = new DocumentAiWarehouseLocation("example", DocumentAiWarehouseLocationArgs.builder()
.location("us")
.projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
.accessControlMode("ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI")
.databaseType("DB_INFRA_SPANNER")
.kmsKey("dummy_key")
.documentCreatorDefaultRole("DOCUMENT_ADMIN")
.build());
}
}
resources:
example:
type: gcp:essentialcontacts:DocumentAiWarehouseLocation
properties:
location: us
projectNumber: ${project.number}
accessControlMode: ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
databaseType: DB_INFRA_SPANNER
kmsKey: dummy_key
documentCreatorDefaultRole: DOCUMENT_ADMIN
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
Create DocumentAiWarehouseLocation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DocumentAiWarehouseLocation(name: string, args: DocumentAiWarehouseLocationArgs, opts?: CustomResourceOptions);
@overload
def DocumentAiWarehouseLocation(resource_name: str,
args: DocumentAiWarehouseLocationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DocumentAiWarehouseLocation(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_control_mode: Optional[str] = None,
database_type: Optional[str] = None,
location: Optional[str] = None,
project_number: Optional[str] = None,
document_creator_default_role: Optional[str] = None,
kms_key: Optional[str] = None)
func NewDocumentAiWarehouseLocation(ctx *Context, name string, args DocumentAiWarehouseLocationArgs, opts ...ResourceOption) (*DocumentAiWarehouseLocation, error)
public DocumentAiWarehouseLocation(string name, DocumentAiWarehouseLocationArgs args, CustomResourceOptions? opts = null)
public DocumentAiWarehouseLocation(String name, DocumentAiWarehouseLocationArgs args)
public DocumentAiWarehouseLocation(String name, DocumentAiWarehouseLocationArgs args, CustomResourceOptions options)
type: gcp:essentialcontacts:DocumentAiWarehouseLocation
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 DocumentAiWarehouseLocationArgs
- 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 DocumentAiWarehouseLocationArgs
- 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 DocumentAiWarehouseLocationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DocumentAiWarehouseLocationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DocumentAiWarehouseLocationArgs
- 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 documentAiWarehouseLocationResource = new Gcp.EssentialContacts.DocumentAiWarehouseLocation("documentAiWarehouseLocationResource", new()
{
AccessControlMode = "string",
DatabaseType = "string",
Location = "string",
ProjectNumber = "string",
DocumentCreatorDefaultRole = "string",
KmsKey = "string",
});
example, err := essentialcontacts.NewDocumentAiWarehouseLocation(ctx, "documentAiWarehouseLocationResource", &essentialcontacts.DocumentAiWarehouseLocationArgs{
AccessControlMode: pulumi.String("string"),
DatabaseType: pulumi.String("string"),
Location: pulumi.String("string"),
ProjectNumber: pulumi.String("string"),
DocumentCreatorDefaultRole: pulumi.String("string"),
KmsKey: pulumi.String("string"),
})
var documentAiWarehouseLocationResource = new DocumentAiWarehouseLocation("documentAiWarehouseLocationResource", DocumentAiWarehouseLocationArgs.builder()
.accessControlMode("string")
.databaseType("string")
.location("string")
.projectNumber("string")
.documentCreatorDefaultRole("string")
.kmsKey("string")
.build());
document_ai_warehouse_location_resource = gcp.essentialcontacts.DocumentAiWarehouseLocation("documentAiWarehouseLocationResource",
access_control_mode="string",
database_type="string",
location="string",
project_number="string",
document_creator_default_role="string",
kms_key="string")
const documentAiWarehouseLocationResource = new gcp.essentialcontacts.DocumentAiWarehouseLocation("documentAiWarehouseLocationResource", {
accessControlMode: "string",
databaseType: "string",
location: "string",
projectNumber: "string",
documentCreatorDefaultRole: "string",
kmsKey: "string",
});
type: gcp:essentialcontacts:DocumentAiWarehouseLocation
properties:
accessControlMode: string
databaseType: string
documentCreatorDefaultRole: string
kmsKey: string
location: string
projectNumber: string
DocumentAiWarehouseLocation 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 DocumentAiWarehouseLocation resource accepts the following input properties:
- Access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - Database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - Location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- Project
Number string - The unique identifier of the project.
- Document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - Kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- Access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - Database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - Location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- Project
Number string - The unique identifier of the project.
- Document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - Kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- access
Control StringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type String - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - location String
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number String - The unique identifier of the project.
- document
Creator StringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key String - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number string - The unique identifier of the project.
- document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- access_
control_ strmode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database_
type str - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - location str
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project_
number str - The unique identifier of the project.
- document_
creator_ strdefault_ role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms_
key str - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- access
Control StringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type String - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - location String
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number String - The unique identifier of the project.
- document
Creator StringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key String - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
Outputs
All input properties are implicitly available as output properties. Additionally, the DocumentAiWarehouseLocation resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DocumentAiWarehouseLocation Resource
Get an existing DocumentAiWarehouseLocation 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?: DocumentAiWarehouseLocationState, opts?: CustomResourceOptions): DocumentAiWarehouseLocation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_control_mode: Optional[str] = None,
database_type: Optional[str] = None,
document_creator_default_role: Optional[str] = None,
kms_key: Optional[str] = None,
location: Optional[str] = None,
project_number: Optional[str] = None) -> DocumentAiWarehouseLocation
func GetDocumentAiWarehouseLocation(ctx *Context, name string, id IDInput, state *DocumentAiWarehouseLocationState, opts ...ResourceOption) (*DocumentAiWarehouseLocation, error)
public static DocumentAiWarehouseLocation Get(string name, Input<string> id, DocumentAiWarehouseLocationState? state, CustomResourceOptions? opts = null)
public static DocumentAiWarehouseLocation get(String name, Output<String> id, DocumentAiWarehouseLocationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - Database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - Document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - Kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- Location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- Project
Number string - The unique identifier of the project.
- Access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - Database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - Document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - Kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- Location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- Project
Number string - The unique identifier of the project.
- access
Control StringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type String - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - document
Creator StringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key String - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- location String
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number String - The unique identifier of the project.
- access
Control stringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type string - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - document
Creator stringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key string - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- location string
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number string - The unique identifier of the project.
- access_
control_ strmode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database_
type str - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - document_
creator_ strdefault_ role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms_
key str - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- location str
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project_
number str - The unique identifier of the project.
- access
Control StringMode - The access control mode for accessing the customer data.
Possible values are:
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI
,ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID
,ACL_MODE_UNIVERSAL_ACCESS
. - database
Type String - The type of database used to store customer data.
Possible values are:
DB_INFRA_SPANNER
,DB_CLOUD_SQL_POSTGRES
. - document
Creator StringDefault Role - The default role for the person who create a document.
Possible values are:
DOCUMENT_ADMIN
,DOCUMENT_EDITOR
,DOCUMENT_VIEWER
. - kms
Key String - The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.
- location String
- The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}.
- project
Number String - The unique identifier of the project.
Import
This resource does not support import.
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.