@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
241 lines • 10.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The resource for managing DataSharingWithGoogle settings for Admin Control.
*
* ## Example Usage
*
* ### Gemini Data Sharing With Google Setting Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.gemini.DataSharingWithGoogleSetting("example", {
* dataSharingWithGoogleSettingId: "ls1-tf",
* location: "global",
* labels: {
* my_key: "my_value",
* },
* enablePreviewDataSharing: true,
* enableDataSharing: true,
* });
* ```
*
* ## Import
*
* DataSharingWithGoogleSetting can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dataSharingWithGoogleSettings/{{data_sharing_with_google_setting_id}}`
* * `{{project}}/{{location}}/{{data_sharing_with_google_setting_id}}`
* * `{{location}}/{{data_sharing_with_google_setting_id}}`
*
* When using the `pulumi import` command, DataSharingWithGoogleSetting can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gemini/dataSharingWithGoogleSetting:DataSharingWithGoogleSetting default projects/{{project}}/locations/{{location}}/dataSharingWithGoogleSettings/{{data_sharing_with_google_setting_id}}
* $ pulumi import gcp:gemini/dataSharingWithGoogleSetting:DataSharingWithGoogleSetting default {{project}}/{{location}}/{{data_sharing_with_google_setting_id}}
* $ pulumi import gcp:gemini/dataSharingWithGoogleSetting:DataSharingWithGoogleSetting default {{location}}/{{data_sharing_with_google_setting_id}}
* ```
*/
export declare class DataSharingWithGoogleSetting extends pulumi.CustomResource {
/**
* Get an existing DataSharingWithGoogleSetting resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataSharingWithGoogleSettingState, opts?: pulumi.CustomResourceOptions): DataSharingWithGoogleSetting;
/**
* Returns true if the given object is an instance of DataSharingWithGoogleSetting. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DataSharingWithGoogleSetting;
/**
* Create time stamp.
*/
readonly createTime: pulumi.Output<string>;
/**
* Id of the Data Sharing With Google Setting.
*/
readonly dataSharingWithGoogleSettingId: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Whether data sharing should be enabled in GA products.
*/
readonly enableDataSharing: pulumi.Output<boolean | undefined>;
/**
* Whether data sharing should be enabled in Preview products.
*/
readonly enablePreviewDataSharing: pulumi.Output<boolean | undefined>;
/**
* Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Identifier. Name of the resource.
* Format:projects/{project}/locations/{location}/dataSharingWithGoogleSettings/{dataSharingWithGoogleSetting}
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Update time stamp.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a DataSharingWithGoogleSetting resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DataSharingWithGoogleSettingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataSharingWithGoogleSetting resources.
*/
export interface DataSharingWithGoogleSettingState {
/**
* Create time stamp.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Id of the Data Sharing With Google Setting.
*/
dataSharingWithGoogleSettingId?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Whether data sharing should be enabled in GA products.
*/
enableDataSharing?: pulumi.Input<boolean | undefined>;
/**
* Whether data sharing should be enabled in Preview products.
*/
enablePreviewDataSharing?: pulumi.Input<boolean | undefined>;
/**
* Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. Name of the resource.
* Format:projects/{project}/locations/{location}/dataSharingWithGoogleSettings/{dataSharingWithGoogleSetting}
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Update time stamp.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DataSharingWithGoogleSetting resource.
*/
export interface DataSharingWithGoogleSettingArgs {
/**
* Id of the Data Sharing With Google Setting.
*/
dataSharingWithGoogleSettingId: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Whether data sharing should be enabled in GA products.
*/
enableDataSharing?: pulumi.Input<boolean | undefined>;
/**
* Whether data sharing should be enabled in Preview products.
*/
enablePreviewDataSharing?: pulumi.Input<boolean | undefined>;
/**
* Labels as key value pairs.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=dataSharingWithGoogleSetting.d.ts.map