UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

173 lines 7.18 kB
import * as pulumi from "@pulumi/pulumi"; /** * Settings represents the global or regional settings configuration for a Migration Center project. * * ## Example Usage * * ### Migration Center Settings Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultPreferenceSet = new gcp.migrationcenter.PreferenceSet("default", { * location: "us-central1", * preferenceSetId: "pref-set-test", * description: "Terraform integration test description", * displayName: "Terraform integration test display", * virtualMachinePreferences: { * vmwareEnginePreferences: { * cpuOvercommitRatio: 1.5, * }, * sizingOptimizationStrategy: "SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE", * targetProduct: "COMPUTE_MIGRATION_TARGET_PRODUCT_COMPUTE_ENGINE", * }, * }); * const _default = new gcp.migrationcenter.Settings("default", { * location: "us-central1", * disableCloudLogging: true, * preferenceSet: defaultPreferenceSet.id, * }); * ``` * * ## Import * * Settings can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/settings` * * `{{project}}/{{location}}` * * `{{location}}` * * When using the `pulumi import` command, Settings can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:migrationcenter/settings:Settings default projects/{{project}}/locations/{{location}}/settings * $ pulumi import gcp:migrationcenter/settings:Settings default {{project}}/{{location}} * $ pulumi import gcp:migrationcenter/settings:Settings default {{location}} * ``` */ export declare class Settings extends pulumi.CustomResource { /** * Get an existing Settings 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?: SettingsState, opts?: pulumi.CustomResourceOptions): Settings; /** * Returns true if the given object is an instance of Settings. 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 Settings; /** * 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>; /** * Disable Cloud Logging for the Migration Center API. * Users are billed for the logs. */ readonly disableCloudLogging: pulumi.Output<boolean | 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>; /** * The name of the resource. */ readonly name: pulumi.Output<string>; /** * The preference set used by default for a project. */ readonly preferenceSet: pulumi.Output<string | undefined>; /** * 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>; /** * Create a Settings 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: SettingsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Settings resources. */ export interface SettingsState { /** * 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>; /** * Disable Cloud Logging for the Migration Center API. * Users are billed for the logs. */ disableCloudLogging?: pulumi.Input<boolean | 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 name of the resource. */ name?: pulumi.Input<string | undefined>; /** * The preference set used by default for a project. */ preferenceSet?: 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 set of arguments for constructing a Settings resource. */ export interface SettingsArgs { /** * 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>; /** * Disable Cloud Logging for the Migration Center API. * Users are billed for the logs. */ disableCloudLogging?: pulumi.Input<boolean | 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>; /** * The preference set used by default for a project. */ preferenceSet?: 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=settings.d.ts.map