Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.1 published on Tuesday, May 24, 2022 by Pulumi

DataSource

Creates a datasource. Note: This API requires an admin account to execute.

Create a DataSource Resource

new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
@overload
def DataSource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               disable_modifications: Optional[bool] = None,
               disable_serving: Optional[bool] = None,
               display_name: Optional[str] = None,
               indexing_service_accounts: Optional[Sequence[str]] = None,
               items_visibility: Optional[Sequence[GSuitePrincipalArgs]] = None,
               name: Optional[str] = None,
               operation_ids: Optional[Sequence[str]] = None,
               return_thumbnail_urls: Optional[bool] = None,
               short_name: Optional[str] = None)
@overload
def DataSource(resource_name: str,
               args: DataSourceArgs,
               opts: Optional[ResourceOptions] = None)
func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
public DataSource(String name, DataSourceArgs args)
public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
type: google-native:cloudsearch/v1:DataSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DataSourceArgs
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 DataSourceArgs
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 DataSourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DataSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DataSourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DataSource 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 DataSource resource accepts the following input properties:

DisplayName string

Display name of the datasource The maximum length is 300 characters.

DisableModifications bool

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

DisableServing bool

Disable serving any search or assist results.

IndexingServiceAccounts List<string>

List of service accounts that have indexing access.

ItemsVisibility List<Pulumi.GoogleNative.CloudSearch.V1.Inputs.GSuitePrincipalArgs>

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

Name string

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

OperationIds List<string>

IDs of the Long Running Operations (LROs) currently running for this schema.

ReturnThumbnailUrls bool

Can a user request to get thumbnail URI for Items indexed in this data source.

ShortName string

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

DisplayName string

Display name of the datasource The maximum length is 300 characters.

DisableModifications bool

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

DisableServing bool

Disable serving any search or assist results.

IndexingServiceAccounts []string

List of service accounts that have indexing access.

ItemsVisibility []GSuitePrincipalArgs

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

Name string

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

OperationIds []string

IDs of the Long Running Operations (LROs) currently running for this schema.

ReturnThumbnailUrls bool

Can a user request to get thumbnail URI for Items indexed in this data source.

ShortName string

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

displayName String

Display name of the datasource The maximum length is 300 characters.

disableModifications Boolean

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

disableServing Boolean

Disable serving any search or assist results.

indexingServiceAccounts List

List of service accounts that have indexing access.

itemsVisibility ListPrincipalArgs>

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

name String

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

operationIds List

IDs of the Long Running Operations (LROs) currently running for this schema.

returnThumbnailUrls Boolean

Can a user request to get thumbnail URI for Items indexed in this data source.

shortName String

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

displayName string

Display name of the datasource The maximum length is 300 characters.

disableModifications boolean

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

disableServing boolean

Disable serving any search or assist results.

indexingServiceAccounts string[]

List of service accounts that have indexing access.

itemsVisibility GSuitePrincipalArgs[]

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

name string

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

operationIds string[]

IDs of the Long Running Operations (LROs) currently running for this schema.

returnThumbnailUrls boolean

Can a user request to get thumbnail URI for Items indexed in this data source.

shortName string

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

display_name str

Display name of the datasource The maximum length is 300 characters.

disable_modifications bool

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

disable_serving bool

Disable serving any search or assist results.

indexing_service_accounts Sequence[str]

List of service accounts that have indexing access.

items_visibility Sequence[GSuitePrincipalArgs]

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

name str

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

operation_ids Sequence[str]

IDs of the Long Running Operations (LROs) currently running for this schema.

return_thumbnail_urls bool

Can a user request to get thumbnail URI for Items indexed in this data source.

short_name str

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

displayName String

Display name of the datasource The maximum length is 300 characters.

disableModifications Boolean

If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.

disableServing Boolean

Disable serving any search or assist results.

indexingServiceAccounts List

List of service accounts that have indexing access.

itemsVisibility List

This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.

name String

Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.

operationIds List

IDs of the Long Running Operations (LROs) currently running for this schema.

returnThumbnailUrls Boolean

Can a user request to get thumbnail URI for Items indexed in this data source.

shortName String

A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is then queries like source: will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.

Outputs

All input properties are implicitly available as output properties. Additionally, the DataSource 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.

Supporting Types

GSuitePrincipal

GsuiteDomain bool

This principal represents all users of the G Suite domain of the customer.

GsuiteGroupEmail string

This principal references a G Suite group account

GsuiteUserEmail string

This principal references a G Suite user account

GsuiteDomain bool

This principal represents all users of the G Suite domain of the customer.

GsuiteGroupEmail string

This principal references a G Suite group account

GsuiteUserEmail string

This principal references a G Suite user account

gsuiteDomain Boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail String

This principal references a G Suite group account

gsuiteUserEmail String

This principal references a G Suite user account

gsuiteDomain boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail string

This principal references a G Suite group account

gsuiteUserEmail string

This principal references a G Suite user account

gsuite_domain bool

This principal represents all users of the G Suite domain of the customer.

gsuite_group_email str

This principal references a G Suite group account

gsuite_user_email str

This principal references a G Suite user account

gsuiteDomain Boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail String

This principal references a G Suite group account

gsuiteUserEmail String

This principal references a G Suite user account

GSuitePrincipalResponse

GsuiteDomain bool

This principal represents all users of the G Suite domain of the customer.

GsuiteGroupEmail string

This principal references a G Suite group account

GsuiteUserEmail string

This principal references a G Suite user account

GsuiteDomain bool

This principal represents all users of the G Suite domain of the customer.

GsuiteGroupEmail string

This principal references a G Suite group account

GsuiteUserEmail string

This principal references a G Suite user account

gsuiteDomain Boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail String

This principal references a G Suite group account

gsuiteUserEmail String

This principal references a G Suite user account

gsuiteDomain boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail string

This principal references a G Suite group account

gsuiteUserEmail string

This principal references a G Suite user account

gsuite_domain bool

This principal represents all users of the G Suite domain of the customer.

gsuite_group_email str

This principal references a G Suite group account

gsuite_user_email str

This principal references a G Suite user account

gsuiteDomain Boolean

This principal represents all users of the G Suite domain of the customer.

gsuiteGroupEmail String

This principal references a G Suite group account

gsuiteUserEmail String

This principal references a G Suite user account

Package Details

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