managementdashboard

package
v1.33.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetManagementDashboardsExportArgs 

type GetManagementDashboardsExportArgs struct {
	// List of dashboardIds in plain text. The syntax is '{"dashboardIds":["dashboardId1", "dashboardId2", ...]}'. Escaping is needed when using in Oracle Cloud Infrastructure CLI. For example, "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" .
	ExportDashboardId string `pulumi:"exportDashboardId"`
}

A collection of arguments for invoking getManagementDashboardsExport.

type GetManagementDashboardsExportOutputArgs 

type GetManagementDashboardsExportOutputArgs struct {
	// List of dashboardIds in plain text. The syntax is '{"dashboardIds":["dashboardId1", "dashboardId2", ...]}'. Escaping is needed when using in Oracle Cloud Infrastructure CLI. For example, "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" .
	ExportDashboardId pulumi.StringInput `pulumi:"exportDashboardId"`
}

A collection of arguments for invoking getManagementDashboardsExport.

func (GetManagementDashboardsExportOutputArgs) ElementType 

func (GetManagementDashboardsExportOutputArgs) ElementType() reflect.Type

type GetManagementDashboardsExportResult 

type GetManagementDashboardsExportResult struct {
	ExportDashboardId string `pulumi:"exportDashboardId"`
	// String containing Array of Dashboards exported, check [ManagementDashboardExportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/datatypes/ManagementDashboardExportDetails) for exact contents in the string value. The value of `exportDetails` can be used to pass as `importDetails` (CompartmentIds may have to be changed) in `ManagementDashboard.ManagementDashboardsImport` resource.
	ExportDetails string `pulumi:"exportDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

A collection of values returned by getManagementDashboardsExport.

func GetManagementDashboardsExport 

func GetManagementDashboardsExport(ctx *pulumi.Context, args *GetManagementDashboardsExportArgs, opts ...pulumi.InvokeOption) (*GetManagementDashboardsExportResult, error)

This data source provides details about a specific Management Dashboards Export resource in Oracle Cloud Infrastructure Management Dashboard service.

Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. Here's an example of how you can use CLI to export a dashboard: `$oci management-dashboard dashboard export --query data --export-dashboard-id "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" > dashboards.json`

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-oci/sdk/go/oci/ManagementDashboard"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ManagementDashboard.GetManagementDashboardsExport(ctx, &managementdashboard.GetManagementDashboardsExportArgs{
			ExportDashboardId: testExportDashboard.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetManagementDashboardsExportResultOutput 

type GetManagementDashboardsExportResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getManagementDashboardsExport.

func GetManagementDashboardsExportOutput 

func GetManagementDashboardsExportOutput(ctx *pulumi.Context, args GetManagementDashboardsExportOutputArgs, opts ...pulumi.InvokeOption) GetManagementDashboardsExportResultOutput

func (GetManagementDashboardsExportResultOutput) ElementType 

func (GetManagementDashboardsExportResultOutput) ElementType() reflect.Type

func (GetManagementDashboardsExportResultOutput) ExportDashboardId 

func (o GetManagementDashboardsExportResultOutput) ExportDashboardId() pulumi.StringOutput

func (GetManagementDashboardsExportResultOutput) ExportDetails 

func (o GetManagementDashboardsExportResultOutput) ExportDetails() pulumi.StringOutput

String containing Array of Dashboards exported, check [ManagementDashboardExportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/datatypes/ManagementDashboardExportDetails) for exact contents in the string value. The value of `exportDetails` can be used to pass as `importDetails` (CompartmentIds may have to be changed) in `ManagementDashboard.ManagementDashboardsImport` resource.

func (GetManagementDashboardsExportResultOutput) Id 

func (o GetManagementDashboardsExportResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetManagementDashboardsExportResultOutput) ToGetManagementDashboardsExportResultOutput 

func (o GetManagementDashboardsExportResultOutput) ToGetManagementDashboardsExportResultOutput() GetManagementDashboardsExportResultOutput

func (GetManagementDashboardsExportResultOutput) ToGetManagementDashboardsExportResultOutputWithContext 

func (o GetManagementDashboardsExportResultOutput) ToGetManagementDashboardsExportResultOutputWithContext(ctx context.Context) GetManagementDashboardsExportResultOutput

type ManagementDashboardsImport 

type ManagementDashboardsImport struct {
	pulumi.CustomResourceState

	// Array of Dashboards to import. The `importDetails` is mandatory if `importDetailsPath` is not passed. Value should be stringified JSON of [ManagementDashboardImportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/ManagementDashboardImportDetails/)
	ImportDetails     pulumi.StringPtrOutput `pulumi:"importDetails"`
	ImportDetailsFile pulumi.StringPtrOutput `pulumi:"importDetailsFile"`
}

This resource provides the Management Dashboards Import resource in Oracle Cloud Infrastructure Management Dashboard service.

Imports an array of dashboards and their saved searches. Here's an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: `oci management-dashboard dashboard export --query data --export-dashboard-id "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" > Import.json`. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here's an example of how you can use CLI to import: `oci management-dashboard dashboard import --from-json file://Import.json`

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-oci/sdk/go/oci/ManagementDashboard"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ManagementDashboard.NewManagementDashboardsImport(ctx, "test_management_dashboards_import", &ManagementDashboard.ManagementDashboardsImportArgs{
			ImportDetails:     pulumi.Any(sampleImportDetails),
			ImportDetailsFile: pulumi.Any(sampleImportDetailsFilePath),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

ManagementDashboardsImport can be imported using the `id`, e.g.

```sh $ pulumi import oci:ManagementDashboard/managementDashboardsImport:ManagementDashboardsImport test_management_dashboards_import "id" ```

func GetManagementDashboardsImport 

func GetManagementDashboardsImport(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ManagementDashboardsImportState, opts ...pulumi.ResourceOption) (*ManagementDashboardsImport, error)

GetManagementDashboardsImport gets an existing ManagementDashboardsImport resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewManagementDashboardsImport 

func NewManagementDashboardsImport(ctx *pulumi.Context,
	name string, args *ManagementDashboardsImportArgs, opts ...pulumi.ResourceOption) (*ManagementDashboardsImport, error)

NewManagementDashboardsImport registers a new resource with the given unique name, arguments, and options.

func (*ManagementDashboardsImport) ElementType 

func (*ManagementDashboardsImport) ElementType() reflect.Type

func (*ManagementDashboardsImport) ToManagementDashboardsImportOutput 

func (i *ManagementDashboardsImport) ToManagementDashboardsImportOutput() ManagementDashboardsImportOutput

func (*ManagementDashboardsImport) ToManagementDashboardsImportOutputWithContext 

func (i *ManagementDashboardsImport) ToManagementDashboardsImportOutputWithContext(ctx context.Context) ManagementDashboardsImportOutput

type ManagementDashboardsImportArgs 

type ManagementDashboardsImportArgs struct {
	// Array of Dashboards to import. The `importDetails` is mandatory if `importDetailsPath` is not passed. Value should be stringified JSON of [ManagementDashboardImportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/ManagementDashboardImportDetails/)
	ImportDetails     pulumi.StringPtrInput
	ImportDetailsFile pulumi.StringPtrInput
}

The set of arguments for constructing a ManagementDashboardsImport resource.

func (ManagementDashboardsImportArgs) ElementType 

func (ManagementDashboardsImportArgs) ElementType() reflect.Type

type ManagementDashboardsImportArray 

type ManagementDashboardsImportArray []ManagementDashboardsImportInput

func (ManagementDashboardsImportArray) ElementType 

func (ManagementDashboardsImportArray) ElementType() reflect.Type

func (ManagementDashboardsImportArray) ToManagementDashboardsImportArrayOutput 

func (i ManagementDashboardsImportArray) ToManagementDashboardsImportArrayOutput() ManagementDashboardsImportArrayOutput

func (ManagementDashboardsImportArray) ToManagementDashboardsImportArrayOutputWithContext 

func (i ManagementDashboardsImportArray) ToManagementDashboardsImportArrayOutputWithContext(ctx context.Context) ManagementDashboardsImportArrayOutput

type ManagementDashboardsImportArrayInput 

type ManagementDashboardsImportArrayInput interface {
	pulumi.Input

	ToManagementDashboardsImportArrayOutput() ManagementDashboardsImportArrayOutput
	ToManagementDashboardsImportArrayOutputWithContext(context.Context) ManagementDashboardsImportArrayOutput
}

ManagementDashboardsImportArrayInput is an input type that accepts ManagementDashboardsImportArray and ManagementDashboardsImportArrayOutput values. You can construct a concrete instance of `ManagementDashboardsImportArrayInput` via: 

ManagementDashboardsImportArray{ ManagementDashboardsImportArgs{...} }

type ManagementDashboardsImportArrayOutput 

type ManagementDashboardsImportArrayOutput struct{ *pulumi.OutputState }

func (ManagementDashboardsImportArrayOutput) ElementType 

func (ManagementDashboardsImportArrayOutput) ElementType() reflect.Type

func (ManagementDashboardsImportArrayOutput) Index 

func (o ManagementDashboardsImportArrayOutput) Index(i pulumi.IntInput) ManagementDashboardsImportOutput

func (ManagementDashboardsImportArrayOutput) ToManagementDashboardsImportArrayOutput 

func (o ManagementDashboardsImportArrayOutput) ToManagementDashboardsImportArrayOutput() ManagementDashboardsImportArrayOutput

func (ManagementDashboardsImportArrayOutput) ToManagementDashboardsImportArrayOutputWithContext 

func (o ManagementDashboardsImportArrayOutput) ToManagementDashboardsImportArrayOutputWithContext(ctx context.Context) ManagementDashboardsImportArrayOutput

type ManagementDashboardsImportInput 

type ManagementDashboardsImportInput interface {
	pulumi.Input

	ToManagementDashboardsImportOutput() ManagementDashboardsImportOutput
	ToManagementDashboardsImportOutputWithContext(ctx context.Context) ManagementDashboardsImportOutput
}

type ManagementDashboardsImportMap 

type ManagementDashboardsImportMap map[string]ManagementDashboardsImportInput

func (ManagementDashboardsImportMap) ElementType 

func (ManagementDashboardsImportMap) ElementType() reflect.Type

func (ManagementDashboardsImportMap) ToManagementDashboardsImportMapOutput 

func (i ManagementDashboardsImportMap) ToManagementDashboardsImportMapOutput() ManagementDashboardsImportMapOutput

func (ManagementDashboardsImportMap) ToManagementDashboardsImportMapOutputWithContext 

func (i ManagementDashboardsImportMap) ToManagementDashboardsImportMapOutputWithContext(ctx context.Context) ManagementDashboardsImportMapOutput

type ManagementDashboardsImportMapInput 

type ManagementDashboardsImportMapInput interface {
	pulumi.Input

	ToManagementDashboardsImportMapOutput() ManagementDashboardsImportMapOutput
	ToManagementDashboardsImportMapOutputWithContext(context.Context) ManagementDashboardsImportMapOutput
}

ManagementDashboardsImportMapInput is an input type that accepts ManagementDashboardsImportMap and ManagementDashboardsImportMapOutput values. You can construct a concrete instance of `ManagementDashboardsImportMapInput` via: 

ManagementDashboardsImportMap{ "key": ManagementDashboardsImportArgs{...} }

type ManagementDashboardsImportMapOutput 

type ManagementDashboardsImportMapOutput struct{ *pulumi.OutputState }

func (ManagementDashboardsImportMapOutput) ElementType 

func (ManagementDashboardsImportMapOutput) ElementType() reflect.Type

func (ManagementDashboardsImportMapOutput) MapIndex 

func (o ManagementDashboardsImportMapOutput) MapIndex(k pulumi.StringInput) ManagementDashboardsImportOutput

func (ManagementDashboardsImportMapOutput) ToManagementDashboardsImportMapOutput 

func (o ManagementDashboardsImportMapOutput) ToManagementDashboardsImportMapOutput() ManagementDashboardsImportMapOutput

func (ManagementDashboardsImportMapOutput) ToManagementDashboardsImportMapOutputWithContext 

func (o ManagementDashboardsImportMapOutput) ToManagementDashboardsImportMapOutputWithContext(ctx context.Context) ManagementDashboardsImportMapOutput

type ManagementDashboardsImportOutput 

type ManagementDashboardsImportOutput struct{ *pulumi.OutputState }

func (ManagementDashboardsImportOutput) ElementType 

func (ManagementDashboardsImportOutput) ElementType() reflect.Type

func (ManagementDashboardsImportOutput) ImportDetails added in v0.4.0 

func (o ManagementDashboardsImportOutput) ImportDetails() pulumi.StringPtrOutput

Array of Dashboards to import. The `importDetails` is mandatory if `importDetailsPath` is not passed. Value should be stringified JSON of [ManagementDashboardImportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/ManagementDashboardImportDetails/)

func (ManagementDashboardsImportOutput) ImportDetailsFile added in v0.4.0 

func (o ManagementDashboardsImportOutput) ImportDetailsFile() pulumi.StringPtrOutput

func (ManagementDashboardsImportOutput) ToManagementDashboardsImportOutput 

func (o ManagementDashboardsImportOutput) ToManagementDashboardsImportOutput() ManagementDashboardsImportOutput

func (ManagementDashboardsImportOutput) ToManagementDashboardsImportOutputWithContext 

func (o ManagementDashboardsImportOutput) ToManagementDashboardsImportOutputWithContext(ctx context.Context) ManagementDashboardsImportOutput

type ManagementDashboardsImportState 

type ManagementDashboardsImportState struct {
	// Array of Dashboards to import. The `importDetails` is mandatory if `importDetailsPath` is not passed. Value should be stringified JSON of [ManagementDashboardImportDetails](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/ManagementDashboardImportDetails/)
	ImportDetails     pulumi.StringPtrInput
	ImportDetailsFile pulumi.StringPtrInput
}

func (ManagementDashboardsImportState) ElementType 

func (ManagementDashboardsImportState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.