Report class

Report represents an analytical assessment report summarizing infrastructure size, costs, and target suggestions.

Example Usage

Migration Center Report Basic

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 pulumi
import pulumi_gcp as gcp

default = gcp.migrationcenter.Group("default",
    location="us-central1",
    group_id="group-test")
default_preference_set = gcp.migrationcenter.PreferenceSet("default",
    location="us-central1",
    preference_set_id="pref-set-test")
default_report_config = gcp.migrationcenter.ReportConfig("default",
    location="us-central1",
    report_config_id="report-config-test",
    group_preferenceset_assignments=[{
        "group": default.id,
        "preference_set": default_preference_set.id,
    }])
default_report = gcp.migrationcenter.Report("default",
    location="us-central1",
    report_id="report-test",
    report_config=default_report_config.report_config_id,
    type="TOTAL_COST_OF_OWNERSHIP",
    description="Terraform integration test description",
    display_name="Terraform integration test display")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.MigrationCenter.Group("default", new()
    {
        Location = "us-central1",
        GroupId = "group-test",
    });

    var defaultPreferenceSet = new Gcp.MigrationCenter.PreferenceSet("default", new()
    {
        Location = "us-central1",
        PreferenceSetId = "pref-set-test",
    });

    var defaultReportConfig = new Gcp.MigrationCenter.ReportConfig("default", new()
    {
        Location = "us-central1",
        ReportConfigId = "report-config-test",
        GroupPreferencesetAssignments = new[]
        {
            new Gcp.MigrationCenter.Inputs.ReportConfigGroupPreferencesetAssignmentArgs
            {
                Group = @default.Id,
                PreferenceSet = defaultPreferenceSet.Id,
            },
        },
    });

    var defaultReport = new Gcp.MigrationCenter.Report("default", new()
    {
        Location = "us-central1",
        ReportId = "report-test",
        ReportConfig = defaultReportConfig.ReportConfigId,
        Type = "TOTAL_COST_OF_OWNERSHIP",
        Description = "Terraform integration test description",
        DisplayName = "Terraform integration test display",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/migrationcenter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := migrationcenter.NewGroup(ctx, "default", &migrationcenter.GroupArgs{
			Location: pulumi.String("us-central1"),
			GroupId:  pulumi.String("group-test"),
		})
		if err != nil {
			return err
		}
		defaultPreferenceSet, err := migrationcenter.NewPreferenceSet(ctx, "default", &migrationcenter.PreferenceSetArgs{
			Location:        pulumi.String("us-central1"),
			PreferenceSetId: pulumi.String("pref-set-test"),
		})
		if err != nil {
			return err
		}
		defaultReportConfig, err := migrationcenter.NewReportConfig(ctx, "default", &migrationcenter.ReportConfigArgs{
			Location:       pulumi.String("us-central1"),
			ReportConfigId: pulumi.String("report-config-test"),
			GroupPreferencesetAssignments: migrationcenter.ReportConfigGroupPreferencesetAssignmentArray{
				&migrationcenter.ReportConfigGroupPreferencesetAssignmentArgs{
					Group:         _default.ID().ToIDOutput().ToStringOutput(),
					PreferenceSet: defaultPreferenceSet.ID().ToIDOutput().ToStringOutput(),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = migrationcenter.NewReport(ctx, "default", &migrationcenter.ReportArgs{
			Location:     pulumi.String("us-central1"),
			ReportId:     pulumi.String("report-test"),
			ReportConfig: defaultReportConfig.ReportConfigId,
			Type:         pulumi.String("TOTAL_COST_OF_OWNERSHIP"),
			Description:  pulumi.String("Terraform integration test description"),
			DisplayName:  pulumi.String("Terraform integration test display"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_migrationcenter_group" "default" {
  location = "us-central1"
  group_id = "group-test"
}
resource "gcp_migrationcenter_preferenceset" "default" {
  location          = "us-central1"
  preference_set_id = "pref-set-test"
}
resource "gcp_migrationcenter_reportconfig" "default" {
  location         = "us-central1"
  report_config_id = "report-config-test"
  group_preferenceset_assignments {
    group          = gcp_migrationcenter_group.default.id
    preference_set = gcp_migrationcenter_preferenceset.default.id
  }
}
resource "gcp_migrationcenter_report" "default" {
  location      = "us-central1"
  report_id     = "report-test"
  report_config = gcp_migrationcenter_reportconfig.default.report_config_id
  type          = "TOTAL_COST_OF_OWNERSHIP"
  description   = "Terraform integration test description"
  display_name  = "Terraform integration test display"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.migrationcenter.Group;
import com.pulumi.gcp.migrationcenter.GroupArgs;
import com.pulumi.gcp.migrationcenter.PreferenceSet;
import com.pulumi.gcp.migrationcenter.PreferenceSetArgs;
import com.pulumi.gcp.migrationcenter.ReportConfig;
import com.pulumi.gcp.migrationcenter.ReportConfigArgs;
import com.pulumi.gcp.migrationcenter.inputs.ReportConfigGroupPreferencesetAssignmentArgs;
import com.pulumi.gcp.migrationcenter.Report;
import com.pulumi.gcp.migrationcenter.ReportArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var default_ = new Group("default", GroupArgs.builder()
            .location("us-central1")
            .groupId("group-test")
            .build());

        var defaultPreferenceSet = new PreferenceSet("defaultPreferenceSet", PreferenceSetArgs.builder()
            .location("us-central1")
            .preferenceSetId("pref-set-test")
            .build());

        var defaultReportConfig = new ReportConfig("defaultReportConfig", ReportConfigArgs.builder()
            .location("us-central1")
            .reportConfigId("report-config-test")
            .groupPreferencesetAssignments(ReportConfigGroupPreferencesetAssignmentArgs.builder()
                .group(default_.id())
                .preferenceSet(defaultPreferenceSet.id())
                .build())
            .build());

        var defaultReport = new Report("defaultReport", ReportArgs.builder()
            .location("us-central1")
            .reportId("report-test")
            .reportConfig(defaultReportConfig.reportConfigId())
            .type("TOTAL_COST_OF_OWNERSHIP")
            .description("Terraform integration test description")
            .displayName("Terraform integration test display")
            .build());

    }
}

resources:
  default:
    type: gcp:migrationcenter:Group
    properties:
      location: us-central1
      groupId: group-test
  defaultPreferenceSet:
    type: gcp:migrationcenter:PreferenceSet
    name: default
    properties:
      location: us-central1
      preferenceSetId: pref-set-test
  defaultReportConfig:
    type: gcp:migrationcenter:ReportConfig
    name: default
    properties:
      location: us-central1
      reportConfigId: report-config-test
      groupPreferencesetAssignments:
        - group: ${default.id}
          preferenceSet: ${defaultPreferenceSet.id}
  defaultReport:
    type: gcp:migrationcenter:Report
    name: default
    properties:
      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:

$ 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}}

Constructors

Report(String name, {ReportArgs? args, CustomResourceOptions? options})

Creates a new Report. name The Pulumi resource name. args Arguments used to configure this Report. The set of arguments for Report. options Resource options controlling this resource's behavior.

Report.reference(String urn)

Creates a typed reference to an existing Report resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Creation timestamp.

late, final

deletionPolicy ↔ 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.

late, final

description ↔ Output<String?>

Free-text description.

late, final

displayName ↔ Output<String?>

User-friendly display name. Maximum length is 63 characters.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ 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.

late, final

name ↔ Output<String>

Name of resource.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

reportConfig ↔ 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.

late, final

reportId ↔ 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?.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

Report creation state. Possible values: PENDING SUCCEEDED FAILED

late, final

summaries ↔ Output<List<ReportSummary>>

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.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String?>

Report type. Possible values: TOTAL_COST_OF_OWNERSHIP

late, final

updateTime ↔ Output<String>

Last update timestamp.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ReportState? state, CustomResourceOptions? options}) → Report

Gets an existing Report resource's state with the given name and id.