@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
276 lines • 10.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Report represents an analytical assessment report summarizing infrastructure size, costs, and target suggestions.
*
* ## Example Usage
*
* ### Migration Center Report Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.migrationcenter.Group("default", {
* location: "us-central1",
* groupId: "group-test",
* });
* const defaultPreferenceSet = new gcp.migrationcenter.PreferenceSet("default", {
* location: "us-central1",
* preferenceSetId: "pref-set-test",
* });
* const defaultReportConfig = new gcp.migrationcenter.ReportConfig("default", {
* location: "us-central1",
* reportConfigId: "report-config-test",
* groupPreferencesetAssignments: [{
* group: _default.id,
* preferenceSet: defaultPreferenceSet.id,
* }],
* });
* const defaultReport = new gcp.migrationcenter.Report("default", {
* location: "us-central1",
* reportId: "report-test",
* reportConfig: defaultReportConfig.reportConfigId,
* type: "TOTAL_COST_OF_OWNERSHIP",
* description: "Terraform integration test description",
* displayName: "Terraform integration test display",
* });
* ```
*
* ## Import
*
* Report can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/reportConfigs/{{report_config}}/reports/{{report_id}}`
* * `{{project}}/{{location}}/{{report_config}}/{{report_id}}`
* * `{{location}}/{{report_config}}/{{report_id}}`
*
* When using the `pulumi import` command, Report can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:migrationcenter/report:Report default projects/{{project}}/locations/{{location}}/reportConfigs/{{report_config}}/reports/{{report_id}}
* $ pulumi import gcp:migrationcenter/report:Report default {{project}}/{{location}}/{{report_config}}/{{report_id}}
* $ pulumi import gcp:migrationcenter/report:Report default {{location}}/{{report_config}}/{{report_id}}
* ```
*/
export declare class Report extends pulumi.CustomResource {
/**
* Get an existing Report 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?: ReportState, opts?: pulumi.CustomResourceOptions): Report;
/**
* Returns true if the given object is an instance of Report. 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 Report;
/**
* Creation timestamp.
*/
readonly createTime: 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>;
/**
* Free-text description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
readonly displayName: pulumi.Output<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>;
/**
* Name of resource.
*/
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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly reportConfig: pulumi.Output<string>;
/**
* User specified id for the report. It will become the last component
* of the report name. The id must be unique within the project, must
* conform with RFC-1034, is restricted to lower-cased letters, and has a
* maximum length of 63 characters. The id must match the regular expression:
* a-z?.
*/
readonly reportId: pulumi.Output<string>;
/**
* Report creation state.
* Possible values:
* PENDING
* SUCCEEDED
* FAILED
*/
readonly state: pulumi.Output<string>;
/**
* Describes the Summary view of a Report, which contains aggregated values
* for all the groups and preference sets included in this Report.
* Structure is documented below.
*/
readonly summaries: pulumi.Output<outputs.migrationcenter.ReportSummary[]>;
/**
* Report type.
* Possible values:
* TOTAL_COST_OF_OWNERSHIP
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Last update timestamp.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Report 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: ReportArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Report resources.
*/
export interface ReportState {
/**
* Creation timestamp.
*/
createTime?: 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>;
/**
* Free-text description.
*/
description?: pulumi.Input<string | undefined>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
displayName?: 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>;
/**
* Name of resource.
*/
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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
reportConfig?: pulumi.Input<string | undefined>;
/**
* User specified id for the report. It will become the last component
* of the report name. The id must be unique within the project, must
* conform with RFC-1034, is restricted to lower-cased letters, and has a
* maximum length of 63 characters. The id must match the regular expression:
* a-z?.
*/
reportId?: pulumi.Input<string | undefined>;
/**
* Report creation state.
* Possible values:
* PENDING
* SUCCEEDED
* FAILED
*/
state?: pulumi.Input<string | undefined>;
/**
* Describes the Summary view of a Report, which contains aggregated values
* for all the groups and preference sets included in this Report.
* Structure is documented below.
*/
summaries?: pulumi.Input<pulumi.Input<inputs.migrationcenter.ReportSummary>[] | undefined>;
/**
* Report type.
* Possible values:
* TOTAL_COST_OF_OWNERSHIP
*/
type?: pulumi.Input<string | undefined>;
/**
* Last update timestamp.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Report resource.
*/
export interface ReportArgs {
/**
* 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>;
/**
* Free-text description.
*/
description?: pulumi.Input<string | undefined>;
/**
* User-friendly display name. Maximum length is 63 characters.
*/
displayName?: 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>;
/**
* 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>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
reportConfig: pulumi.Input<string>;
/**
* User specified id for the report. It will become the last component
* of the report name. The id must be unique within the project, must
* conform with RFC-1034, is restricted to lower-cased letters, and has a
* maximum length of 63 characters. The id must match the regular expression:
* a-z?.
*/
reportId: pulumi.Input<string>;
/**
* Report type.
* Possible values:
* TOTAL_COST_OF_OWNERSHIP
*/
type?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=report.d.ts.map