Oracle Cloud Infrastructure v1.32.0, Apr 18 24

Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

oci.DataSafe.ReportDefinition

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testReportDefinition = new oci.datasafe.ReportDefinition("testReportDefinition", {
    columnFilters: [{
        expressions: _var.report_definition_column_filters_expressions,
        fieldName: _var.report_definition_column_filters_field_name,
        isEnabled: _var.report_definition_column_filters_is_enabled,
        isHidden: _var.report_definition_column_filters_is_hidden,
        operator: _var.report_definition_column_filters_operator,
    }],
    columnInfos: [{
        displayName: _var.report_definition_column_info_display_name,
        displayOrder: _var.report_definition_column_info_display_order,
        fieldName: _var.report_definition_column_info_field_name,
        isHidden: _var.report_definition_column_info_is_hidden,
        dataType: _var.report_definition_column_info_data_type,
    }],
    columnSortings: [{
        fieldName: _var.report_definition_column_sortings_field_name,
        isAscending: _var.report_definition_column_sortings_is_ascending,
        sortingOrder: _var.report_definition_column_sortings_sorting_order,
    }],
    compartmentId: _var.compartment_id,
    displayName: _var.report_definition_display_name,
    parentId: oci_data_safe_parent.test_parent.id,
    summaries: [{
        displayOrder: _var.report_definition_summary_display_order,
        name: _var.report_definition_summary_name,
        countOf: _var.report_definition_summary_count_of,
        groupByFieldName: _var.report_definition_summary_group_by_field_name,
        isHidden: _var.report_definition_summary_is_hidden,
        scimFilter: _var.report_definition_summary_scim_filter,
    }],
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: _var.report_definition_description,
    freeformTags: {
        Department: "Finance",
    },
});

import pulumi
import pulumi_oci as oci

test_report_definition = oci.data_safe.ReportDefinition("testReportDefinition",
    column_filters=[oci.data_safe.ReportDefinitionColumnFilterArgs(
        expressions=var["report_definition_column_filters_expressions"],
        field_name=var["report_definition_column_filters_field_name"],
        is_enabled=var["report_definition_column_filters_is_enabled"],
        is_hidden=var["report_definition_column_filters_is_hidden"],
        operator=var["report_definition_column_filters_operator"],
    )],
    column_infos=[oci.data_safe.ReportDefinitionColumnInfoArgs(
        display_name=var["report_definition_column_info_display_name"],
        display_order=var["report_definition_column_info_display_order"],
        field_name=var["report_definition_column_info_field_name"],
        is_hidden=var["report_definition_column_info_is_hidden"],
        data_type=var["report_definition_column_info_data_type"],
    )],
    column_sortings=[oci.data_safe.ReportDefinitionColumnSortingArgs(
        field_name=var["report_definition_column_sortings_field_name"],
        is_ascending=var["report_definition_column_sortings_is_ascending"],
        sorting_order=var["report_definition_column_sortings_sorting_order"],
    )],
    compartment_id=var["compartment_id"],
    display_name=var["report_definition_display_name"],
    parent_id=oci_data_safe_parent["test_parent"]["id"],
    summaries=[oci.data_safe.ReportDefinitionSummaryArgs(
        display_order=var["report_definition_summary_display_order"],
        name=var["report_definition_summary_name"],
        count_of=var["report_definition_summary_count_of"],
        group_by_field_name=var["report_definition_summary_group_by_field_name"],
        is_hidden=var["report_definition_summary_is_hidden"],
        scim_filter=var["report_definition_summary_scim_filter"],
    )],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=var["report_definition_description"],
    freeform_tags={
        "Department": "Finance",
    })

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.NewReportDefinition(ctx, "testReportDefinition", &DataSafe.ReportDefinitionArgs{
			ColumnFilters: datasafe.ReportDefinitionColumnFilterArray{
				&datasafe.ReportDefinitionColumnFilterArgs{
					Expressions: pulumi.Any(_var.Report_definition_column_filters_expressions),
					FieldName:   pulumi.Any(_var.Report_definition_column_filters_field_name),
					IsEnabled:   pulumi.Any(_var.Report_definition_column_filters_is_enabled),
					IsHidden:    pulumi.Any(_var.Report_definition_column_filters_is_hidden),
					Operator:    pulumi.Any(_var.Report_definition_column_filters_operator),
				},
			},
			ColumnInfos: datasafe.ReportDefinitionColumnInfoArray{
				&datasafe.ReportDefinitionColumnInfoArgs{
					DisplayName:  pulumi.Any(_var.Report_definition_column_info_display_name),
					DisplayOrder: pulumi.Any(_var.Report_definition_column_info_display_order),
					FieldName:    pulumi.Any(_var.Report_definition_column_info_field_name),
					IsHidden:     pulumi.Any(_var.Report_definition_column_info_is_hidden),
					DataType:     pulumi.Any(_var.Report_definition_column_info_data_type),
				},
			},
			ColumnSortings: datasafe.ReportDefinitionColumnSortingArray{
				&datasafe.ReportDefinitionColumnSortingArgs{
					FieldName:    pulumi.Any(_var.Report_definition_column_sortings_field_name),
					IsAscending:  pulumi.Any(_var.Report_definition_column_sortings_is_ascending),
					SortingOrder: pulumi.Any(_var.Report_definition_column_sortings_sorting_order),
				},
			},
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DisplayName:   pulumi.Any(_var.Report_definition_display_name),
			ParentId:      pulumi.Any(oci_data_safe_parent.Test_parent.Id),
			Summaries: datasafe.ReportDefinitionSummaryArray{
				&datasafe.ReportDefinitionSummaryArgs{
					DisplayOrder:     pulumi.Any(_var.Report_definition_summary_display_order),
					Name:             pulumi.Any(_var.Report_definition_summary_name),
					CountOf:          pulumi.Any(_var.Report_definition_summary_count_of),
					GroupByFieldName: pulumi.Any(_var.Report_definition_summary_group_by_field_name),
					IsHidden:         pulumi.Any(_var.Report_definition_summary_is_hidden),
					ScimFilter:       pulumi.Any(_var.Report_definition_summary_scim_filter),
				},
			},
			DefinedTags: pulumi.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			Description: pulumi.Any(_var.Report_definition_description),
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testReportDefinition = new Oci.DataSafe.ReportDefinition("testReportDefinition", new()
    {
        ColumnFilters = new[]
        {
            new Oci.DataSafe.Inputs.ReportDefinitionColumnFilterArgs
            {
                Expressions = @var.Report_definition_column_filters_expressions,
                FieldName = @var.Report_definition_column_filters_field_name,
                IsEnabled = @var.Report_definition_column_filters_is_enabled,
                IsHidden = @var.Report_definition_column_filters_is_hidden,
                Operator = @var.Report_definition_column_filters_operator,
            },
        },
        ColumnInfos = new[]
        {
            new Oci.DataSafe.Inputs.ReportDefinitionColumnInfoArgs
            {
                DisplayName = @var.Report_definition_column_info_display_name,
                DisplayOrder = @var.Report_definition_column_info_display_order,
                FieldName = @var.Report_definition_column_info_field_name,
                IsHidden = @var.Report_definition_column_info_is_hidden,
                DataType = @var.Report_definition_column_info_data_type,
            },
        },
        ColumnSortings = new[]
        {
            new Oci.DataSafe.Inputs.ReportDefinitionColumnSortingArgs
            {
                FieldName = @var.Report_definition_column_sortings_field_name,
                IsAscending = @var.Report_definition_column_sortings_is_ascending,
                SortingOrder = @var.Report_definition_column_sortings_sorting_order,
            },
        },
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Report_definition_display_name,
        ParentId = oci_data_safe_parent.Test_parent.Id,
        Summaries = new[]
        {
            new Oci.DataSafe.Inputs.ReportDefinitionSummaryArgs
            {
                DisplayOrder = @var.Report_definition_summary_display_order,
                Name = @var.Report_definition_summary_name,
                CountOf = @var.Report_definition_summary_count_of,
                GroupByFieldName = @var.Report_definition_summary_group_by_field_name,
                IsHidden = @var.Report_definition_summary_is_hidden,
                ScimFilter = @var.Report_definition_summary_scim_filter,
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = @var.Report_definition_description,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.ReportDefinition;
import com.pulumi.oci.DataSafe.ReportDefinitionArgs;
import com.pulumi.oci.DataSafe.inputs.ReportDefinitionColumnFilterArgs;
import com.pulumi.oci.DataSafe.inputs.ReportDefinitionColumnInfoArgs;
import com.pulumi.oci.DataSafe.inputs.ReportDefinitionColumnSortingArgs;
import com.pulumi.oci.DataSafe.inputs.ReportDefinitionSummaryArgs;
import java.util.List;
import java.util.ArrayList;
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 testReportDefinition = new ReportDefinition("testReportDefinition", ReportDefinitionArgs.builder()        
            .columnFilters(ReportDefinitionColumnFilterArgs.builder()
                .expressions(var_.report_definition_column_filters_expressions())
                .fieldName(var_.report_definition_column_filters_field_name())
                .isEnabled(var_.report_definition_column_filters_is_enabled())
                .isHidden(var_.report_definition_column_filters_is_hidden())
                .operator(var_.report_definition_column_filters_operator())
                .build())
            .columnInfos(ReportDefinitionColumnInfoArgs.builder()
                .displayName(var_.report_definition_column_info_display_name())
                .displayOrder(var_.report_definition_column_info_display_order())
                .fieldName(var_.report_definition_column_info_field_name())
                .isHidden(var_.report_definition_column_info_is_hidden())
                .dataType(var_.report_definition_column_info_data_type())
                .build())
            .columnSortings(ReportDefinitionColumnSortingArgs.builder()
                .fieldName(var_.report_definition_column_sortings_field_name())
                .isAscending(var_.report_definition_column_sortings_is_ascending())
                .sortingOrder(var_.report_definition_column_sortings_sorting_order())
                .build())
            .compartmentId(var_.compartment_id())
            .displayName(var_.report_definition_display_name())
            .parentId(oci_data_safe_parent.test_parent().id())
            .summaries(ReportDefinitionSummaryArgs.builder()
                .displayOrder(var_.report_definition_summary_display_order())
                .name(var_.report_definition_summary_name())
                .countOf(var_.report_definition_summary_count_of())
                .groupByFieldName(var_.report_definition_summary_group_by_field_name())
                .isHidden(var_.report_definition_summary_is_hidden())
                .scimFilter(var_.report_definition_summary_scim_filter())
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(var_.report_definition_description())
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

resources:
  testReportDefinition:
    type: oci:DataSafe:ReportDefinition
    properties:
      #Required
      columnFilters:
        - expressions: ${var.report_definition_column_filters_expressions}
          fieldName: ${var.report_definition_column_filters_field_name}
          isEnabled: ${var.report_definition_column_filters_is_enabled}
          isHidden: ${var.report_definition_column_filters_is_hidden}
          operator: ${var.report_definition_column_filters_operator}
      columnInfos:
        - displayName: ${var.report_definition_column_info_display_name}
          displayOrder: ${var.report_definition_column_info_display_order}
          fieldName: ${var.report_definition_column_info_field_name}
          isHidden: ${var.report_definition_column_info_is_hidden}
          dataType: ${var.report_definition_column_info_data_type}
      columnSortings:
        - fieldName: ${var.report_definition_column_sortings_field_name}
          isAscending: ${var.report_definition_column_sortings_is_ascending}
          sortingOrder: ${var.report_definition_column_sortings_sorting_order}
      compartmentId: ${var.compartment_id}
      displayName: ${var.report_definition_display_name}
      parentId: ${oci_data_safe_parent.test_parent.id}
      summaries:
        - displayOrder: ${var.report_definition_summary_display_order}
          name: ${var.report_definition_summary_name}
          countOf: ${var.report_definition_summary_count_of}
          groupByFieldName: ${var.report_definition_summary_group_by_field_name}
          isHidden: ${var.report_definition_summary_is_hidden}
          scimFilter: ${var.report_definition_summary_scim_filter}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      description: ${var.report_definition_description}
      freeformTags:
        Department: Finance

Create ReportDefinition Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ReportDefinition(name: string, args: ReportDefinitionArgs, opts?: CustomResourceOptions);

@overload
def ReportDefinition(resource_name: str,
                     args: ReportDefinitionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ReportDefinition(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     column_filters: Optional[Sequence[_datasafe.ReportDefinitionColumnFilterArgs]] = None,
                     column_infos: Optional[Sequence[_datasafe.ReportDefinitionColumnInfoArgs]] = None,
                     column_sortings: Optional[Sequence[_datasafe.ReportDefinitionColumnSortingArgs]] = None,
                     compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     parent_id: Optional[str] = None,
                     summaries: Optional[Sequence[_datasafe.ReportDefinitionSummaryArgs]] = None,
                     defined_tags: Optional[Mapping[str, Any]] = None,
                     description: Optional[str] = None,
                     freeform_tags: Optional[Mapping[str, Any]] = None)

func NewReportDefinition(ctx *Context, name string, args ReportDefinitionArgs, opts ...ResourceOption) (*ReportDefinition, error)

public ReportDefinition(string name, ReportDefinitionArgs args, CustomResourceOptions? opts = null)

public ReportDefinition(String name, ReportDefinitionArgs args)
public ReportDefinition(String name, ReportDefinitionArgs args, CustomResourceOptions options)

type: oci:DataSafe:ReportDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ReportDefinitionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ReportDefinitionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ReportDefinitionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ReportDefinitionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ReportDefinitionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var reportDefinitionResource = new Oci.DataSafe.ReportDefinition("reportDefinitionResource", new()
{
    ColumnFilters = new[]
    {
        new Oci.DataSafe.Inputs.ReportDefinitionColumnFilterArgs
        {
            Expressions = new[]
            {
                "string",
            },
            FieldName = "string",
            IsEnabled = false,
            IsHidden = false,
            Operator = "string",
        },
    },
    ColumnInfos = new[]
    {
        new Oci.DataSafe.Inputs.ReportDefinitionColumnInfoArgs
        {
            DisplayName = "string",
            DisplayOrder = 0,
            FieldName = "string",
            IsHidden = false,
            DataType = "string",
        },
    },
    ColumnSortings = new[]
    {
        new Oci.DataSafe.Inputs.ReportDefinitionColumnSortingArgs
        {
            FieldName = "string",
            IsAscending = false,
            SortingOrder = 0,
        },
    },
    CompartmentId = "string",
    DisplayName = "string",
    ParentId = "string",
    Summaries = new[]
    {
        new Oci.DataSafe.Inputs.ReportDefinitionSummaryArgs
        {
            DisplayOrder = 0,
            Name = "string",
            CountOf = "string",
            GroupByFieldName = "string",
            IsHidden = false,
            ScimFilter = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "any" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
});

example, err := DataSafe.NewReportDefinition(ctx, "reportDefinitionResource", &DataSafe.ReportDefinitionArgs{
	ColumnFilters: datasafe.ReportDefinitionColumnFilterArray{
		&datasafe.ReportDefinitionColumnFilterArgs{
			Expressions: pulumi.StringArray{
				pulumi.String("string"),
			},
			FieldName: pulumi.String("string"),
			IsEnabled: pulumi.Bool(false),
			IsHidden:  pulumi.Bool(false),
			Operator:  pulumi.String("string"),
		},
	},
	ColumnInfos: datasafe.ReportDefinitionColumnInfoArray{
		&datasafe.ReportDefinitionColumnInfoArgs{
			DisplayName:  pulumi.String("string"),
			DisplayOrder: pulumi.Int(0),
			FieldName:    pulumi.String("string"),
			IsHidden:     pulumi.Bool(false),
			DataType:     pulumi.String("string"),
		},
	},
	ColumnSortings: datasafe.ReportDefinitionColumnSortingArray{
		&datasafe.ReportDefinitionColumnSortingArgs{
			FieldName:    pulumi.String("string"),
			IsAscending:  pulumi.Bool(false),
			SortingOrder: pulumi.Int(0),
		},
	},
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	ParentId:      pulumi.String("string"),
	Summaries: datasafe.ReportDefinitionSummaryArray{
		&datasafe.ReportDefinitionSummaryArgs{
			DisplayOrder:     pulumi.Int(0),
			Name:             pulumi.String("string"),
			CountOf:          pulumi.String("string"),
			GroupByFieldName: pulumi.String("string"),
			IsHidden:         pulumi.Bool(false),
			ScimFilter:       pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

var reportDefinitionResource = new ReportDefinition("reportDefinitionResource", ReportDefinitionArgs.builder()        
    .columnFilters(ReportDefinitionColumnFilterArgs.builder()
        .expressions("string")
        .fieldName("string")
        .isEnabled(false)
        .isHidden(false)
        .operator("string")
        .build())
    .columnInfos(ReportDefinitionColumnInfoArgs.builder()
        .displayName("string")
        .displayOrder(0)
        .fieldName("string")
        .isHidden(false)
        .dataType("string")
        .build())
    .columnSortings(ReportDefinitionColumnSortingArgs.builder()
        .fieldName("string")
        .isAscending(false)
        .sortingOrder(0)
        .build())
    .compartmentId("string")
    .displayName("string")
    .parentId("string")
    .summaries(ReportDefinitionSummaryArgs.builder()
        .displayOrder(0)
        .name("string")
        .countOf("string")
        .groupByFieldName("string")
        .isHidden(false)
        .scimFilter("string")
        .build())
    .definedTags(Map.of("string", "any"))
    .description("string")
    .freeformTags(Map.of("string", "any"))
    .build());

report_definition_resource = oci.data_safe.ReportDefinition("reportDefinitionResource",
    column_filters=[oci.data_safe.ReportDefinitionColumnFilterArgs(
        expressions=["string"],
        field_name="string",
        is_enabled=False,
        is_hidden=False,
        operator="string",
    )],
    column_infos=[oci.data_safe.ReportDefinitionColumnInfoArgs(
        display_name="string",
        display_order=0,
        field_name="string",
        is_hidden=False,
        data_type="string",
    )],
    column_sortings=[oci.data_safe.ReportDefinitionColumnSortingArgs(
        field_name="string",
        is_ascending=False,
        sorting_order=0,
    )],
    compartment_id="string",
    display_name="string",
    parent_id="string",
    summaries=[oci.data_safe.ReportDefinitionSummaryArgs(
        display_order=0,
        name="string",
        count_of="string",
        group_by_field_name="string",
        is_hidden=False,
        scim_filter="string",
    )],
    defined_tags={
        "string": "any",
    },
    description="string",
    freeform_tags={
        "string": "any",
    })

const reportDefinitionResource = new oci.datasafe.ReportDefinition("reportDefinitionResource", {
    columnFilters: [{
        expressions: ["string"],
        fieldName: "string",
        isEnabled: false,
        isHidden: false,
        operator: "string",
    }],
    columnInfos: [{
        displayName: "string",
        displayOrder: 0,
        fieldName: "string",
        isHidden: false,
        dataType: "string",
    }],
    columnSortings: [{
        fieldName: "string",
        isAscending: false,
        sortingOrder: 0,
    }],
    compartmentId: "string",
    displayName: "string",
    parentId: "string",
    summaries: [{
        displayOrder: 0,
        name: "string",
        countOf: "string",
        groupByFieldName: "string",
        isHidden: false,
        scimFilter: "string",
    }],
    definedTags: {
        string: "any",
    },
    description: "string",
    freeformTags: {
        string: "any",
    },
});

type: oci:DataSafe:ReportDefinition
properties:
    columnFilters:
        - expressions:
            - string
          fieldName: string
          isEnabled: false
          isHidden: false
          operator: string
    columnInfos:
        - dataType: string
          displayName: string
          displayOrder: 0
          fieldName: string
          isHidden: false
    columnSortings:
        - fieldName: string
          isAscending: false
          sortingOrder: 0
    compartmentId: string
    definedTags:
        string: any
    description: string
    displayName: string
    freeformTags:
        string: any
    parentId: string
    summaries:
        - countOf: string
          displayOrder: 0
          groupByFieldName: string
          isHidden: false
          name: string
          scimFilter: string

ReportDefinition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ReportDefinition resource accepts the following input properties:

ColumnFilters List<ReportDefinitionColumnFilter>: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
ColumnInfos List<ReportDefinitionColumnInfo>: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
ColumnSortings List<ReportDefinitionColumnSorting>: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
CompartmentId string: (Updatable) The OCID of the compartment containing the report definition.
DisplayName string: (Updatable) Specifies the name of the report definition.
ParentId string: The OCID of the parent report definition.
Summaries List<ReportDefinitionSummary>: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
DefinedTags Dictionary<string, object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: (Updatable) The description of the report definition.
FreeformTags Dictionary<string, object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

ColumnFilters []ReportDefinitionColumnFilterArgs: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
ColumnInfos []ReportDefinitionColumnInfoArgs: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
ColumnSortings []ReportDefinitionColumnSortingArgs: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
CompartmentId string: (Updatable) The OCID of the compartment containing the report definition.
DisplayName string: (Updatable) Specifies the name of the report definition.
ParentId string: The OCID of the parent report definition.
Summaries []ReportDefinitionSummaryArgs: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
DefinedTags map[string]interface{}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: (Updatable) The description of the report definition.
FreeformTags map[string]interface{}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

columnFilters List<ReportDefinitionColumnFilter>: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos List<ReportDefinitionColumnInfo>: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings List<ReportDefinitionColumnSorting>: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId String: (Updatable) The OCID of the compartment containing the report definition.
displayName String: (Updatable) Specifies the name of the report definition.
parentId String: The OCID of the parent report definition.
summaries List<ReportDefinitionSummary>: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
definedTags Map<String,Object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: (Updatable) The description of the report definition.
freeformTags Map<String,Object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

columnFilters ReportDefinitionColumnFilter[]: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos ReportDefinitionColumnInfo[]: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings ReportDefinitionColumnSorting[]: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId string: (Updatable) The OCID of the compartment containing the report definition.
displayName string: (Updatable) Specifies the name of the report definition.
parentId string: The OCID of the parent report definition.
summaries ReportDefinitionSummary[]: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
definedTags {[key: string]: any}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description string: (Updatable) The description of the report definition.
freeformTags {[key: string]: any}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

column_filters Sequence[datasafe.ReportDefinitionColumnFilterArgs]: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
column_infos Sequence[datasafe.ReportDefinitionColumnInfoArgs]: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
column_sortings Sequence[datasafe.ReportDefinitionColumnSortingArgs]: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartment_id str: (Updatable) The OCID of the compartment containing the report definition.
display_name str: (Updatable) Specifies the name of the report definition.
parent_id str: The OCID of the parent report definition.
summaries Sequence[datasafe.ReportDefinitionSummaryArgs]: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
defined_tags Mapping[str, Any]: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description str: (Updatable) The description of the report definition.
freeform_tags Mapping[str, Any]: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

columnFilters List<Property Map>: (Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos List<Property Map>: (Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings List<Property Map>: (Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId String: (Updatable) The OCID of the compartment containing the report definition.
displayName String: (Updatable) Specifies the name of the report definition.
parentId String: The OCID of the parent report definition.
summaries List<Property Map>: (Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
definedTags Map<Any>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: (Updatable) The description of the report definition.
freeformTags Map<Any>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

Outputs

All input properties are implicitly available as output properties. Additionally, the ReportDefinition resource produces the following output properties:

Category string

Specifies the name of the category that this report belongs to.

ComplianceStandards List<string>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

DataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

Id string

The provider-assigned unique ID for this managed resource.

IsSeeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

RecordTimeSpan string

The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)

Schedule string

The schedule to generate the report periodically in the specified format: ;

ScheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

ScheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

ScheduledReportName string

The name of the report to be scheduled.

ScheduledReportRowLimit int

Specifies the limit on the number of rows in the report.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string

The current state of the report.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Specifies the date and time the report definition was created.

TimeUpdated string

The date and time the report definition was updated.

Category string

Specifies the name of the category that this report belongs to.

ComplianceStandards []string

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

DataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

Id string

The provider-assigned unique ID for this managed resource.

IsSeeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

RecordTimeSpan string

Schedule string

The schedule to generate the report periodically in the specified format: ;

ScheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

ScheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

ScheduledReportName string

The name of the report to be scheduled.

ScheduledReportRowLimit int

Specifies the limit on the number of rows in the report.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string

The current state of the report.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Specifies the date and time the report definition was created.

TimeUpdated string

The date and time the report definition was updated.

category String

Specifies the name of the category that this report belongs to.

complianceStandards List<String>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource String

Specifies the name of a resource that provides data for the report. For example alerts, events.

displayOrder Integer

(Updatable) Specifies the order in which the summary must be displayed.

id String

The provider-assigned unique ID for this managed resource.

isSeeded Boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

recordTimeSpan String

schedule String

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId String

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType String

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName String

The name of the report to be scheduled.

scheduledReportRowLimit Integer

Specifies the limit on the number of rows in the report.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String

The current state of the report.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Specifies the date and time the report definition was created.

timeUpdated String

The date and time the report definition was updated.

category string

Specifies the name of the category that this report belongs to.

complianceStandards string[]

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

displayOrder number

(Updatable) Specifies the order in which the summary must be displayed.

id string

The provider-assigned unique ID for this managed resource.

isSeeded boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

recordTimeSpan string

schedule string

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName string

The name of the report to be scheduled.

scheduledReportRowLimit number

Specifies the limit on the number of rows in the report.

scimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state string

The current state of the report.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

Specifies the date and time the report definition was created.

timeUpdated string

The date and time the report definition was updated.

category str

Specifies the name of the category that this report belongs to.

compliance_standards Sequence[str]

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

data_source str

Specifies the name of a resource that provides data for the report. For example alerts, events.

display_order int

(Updatable) Specifies the order in which the summary must be displayed.

id str

The provider-assigned unique ID for this managed resource.

is_seeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

record_time_span str

schedule str

The schedule to generate the report periodically in the specified format: ;

scheduled_report_compartment_id str

The OCID of the compartment in which the scheduled resource will be created.

scheduled_report_mime_type str

Specifies the format of the report ( either .xls or .pdf )

scheduled_report_name str

The name of the report to be scheduled.

scheduled_report_row_limit int

Specifies the limit on the number of rows in the report.

scim_filter str

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state str

The current state of the report.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

Specifies the date and time the report definition was created.

time_updated str

The date and time the report definition was updated.

category String

Specifies the name of the category that this report belongs to.

complianceStandards List<String>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource String

Specifies the name of a resource that provides data for the report. For example alerts, events.

displayOrder Number

(Updatable) Specifies the order in which the summary must be displayed.

id String

The provider-assigned unique ID for this managed resource.

isSeeded Boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

recordTimeSpan String

schedule String

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId String

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType String

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName String

The name of the report to be scheduled.

scheduledReportRowLimit Number

Specifies the limit on the number of rows in the report.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String

The current state of the report.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Specifies the date and time the report definition was created.

timeUpdated String

The date and time the report definition was updated.

Look up Existing ReportDefinition Resource

Get an existing ReportDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ReportDefinitionState, opts?: CustomResourceOptions): ReportDefinition

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        column_filters: Optional[Sequence[_datasafe.ReportDefinitionColumnFilterArgs]] = None,
        column_infos: Optional[Sequence[_datasafe.ReportDefinitionColumnInfoArgs]] = None,
        column_sortings: Optional[Sequence[_datasafe.ReportDefinitionColumnSortingArgs]] = None,
        compartment_id: Optional[str] = None,
        compliance_standards: Optional[Sequence[str]] = None,
        data_source: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        display_order: Optional[int] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_seeded: Optional[bool] = None,
        parent_id: Optional[str] = None,
        record_time_span: Optional[str] = None,
        schedule: Optional[str] = None,
        scheduled_report_compartment_id: Optional[str] = None,
        scheduled_report_mime_type: Optional[str] = None,
        scheduled_report_name: Optional[str] = None,
        scheduled_report_row_limit: Optional[int] = None,
        scim_filter: Optional[str] = None,
        state: Optional[str] = None,
        summaries: Optional[Sequence[_datasafe.ReportDefinitionSummaryArgs]] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ReportDefinition

func GetReportDefinition(ctx *Context, name string, id IDInput, state *ReportDefinitionState, opts ...ResourceOption) (*ReportDefinition, error)

public static ReportDefinition Get(string name, Input<string> id, ReportDefinitionState? state, CustomResourceOptions? opts = null)

public static ReportDefinition get(String name, Output<String> id, ReportDefinitionState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Category string

Specifies the name of the category that this report belongs to.

ColumnFilters List<ReportDefinitionColumnFilter>

(Updatable) An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.

ColumnInfos List<ReportDefinitionColumnInfo>

(Updatable) An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).

ColumnSortings List<ReportDefinitionColumnSorting>

(Updatable) An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.

CompartmentId string

(Updatable) The OCID of the compartment containing the report definition.

ComplianceStandards List<string>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

DataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

Description string

(Updatable) The description of the report definition.

DisplayName string

(Updatable) Specifies the name of the report definition.

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

IsSeeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

ParentId string

The OCID of the parent report definition.

RecordTimeSpan string

Schedule string

The schedule to generate the report periodically in the specified format: ;

ScheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

ScheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

ScheduledReportName string

The name of the report to be scheduled.

ScheduledReportRowLimit int

Specifies the limit on the number of rows in the report.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string

The current state of the report.

Summaries List<ReportDefinitionSummary>

(Updatable) An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Specifies the date and time the report definition was created.

TimeUpdated string

The date and time the report definition was updated.

Category string

Specifies the name of the category that this report belongs to.

ColumnFilters []ReportDefinitionColumnFilterArgs

ColumnInfos []ReportDefinitionColumnInfoArgs

ColumnSortings []ReportDefinitionColumnSortingArgs

CompartmentId string

(Updatable) The OCID of the compartment containing the report definition.

ComplianceStandards []string

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

DataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

Description string

(Updatable) The description of the report definition.

DisplayName string

(Updatable) Specifies the name of the report definition.

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

FreeformTags map[string]interface{}

IsSeeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

ParentId string

The OCID of the parent report definition.

RecordTimeSpan string

Schedule string

The schedule to generate the report periodically in the specified format: ;

ScheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

ScheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

ScheduledReportName string

The name of the report to be scheduled.

ScheduledReportRowLimit int

Specifies the limit on the number of rows in the report.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string

The current state of the report.

Summaries []ReportDefinitionSummaryArgs

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Specifies the date and time the report definition was created.

TimeUpdated string

The date and time the report definition was updated.

category String

Specifies the name of the category that this report belongs to.

columnFilters List<ReportDefinitionColumnFilter>

columnInfos List<ReportDefinitionColumnInfo>

columnSortings List<ReportDefinitionColumnSorting>

compartmentId String

(Updatable) The OCID of the compartment containing the report definition.

complianceStandards List<String>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource String

Specifies the name of a resource that provides data for the report. For example alerts, events.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description String

(Updatable) The description of the report definition.

displayName String

(Updatable) Specifies the name of the report definition.

displayOrder Integer

(Updatable) Specifies the order in which the summary must be displayed.

freeformTags Map<String,Object>

isSeeded Boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

parentId String

The OCID of the parent report definition.

recordTimeSpan String

schedule String

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId String

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType String

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName String

The name of the report to be scheduled.

scheduledReportRowLimit Integer

Specifies the limit on the number of rows in the report.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String

The current state of the report.

summaries List<ReportDefinitionSummary>

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Specifies the date and time the report definition was created.

timeUpdated String

The date and time the report definition was updated.

category string

Specifies the name of the category that this report belongs to.

columnFilters ReportDefinitionColumnFilter[]

columnInfos ReportDefinitionColumnInfo[]

columnSortings ReportDefinitionColumnSorting[]

compartmentId string

(Updatable) The OCID of the compartment containing the report definition.

complianceStandards string[]

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource string

Specifies the name of a resource that provides data for the report. For example alerts, events.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description string

(Updatable) The description of the report definition.

displayName string

(Updatable) Specifies the name of the report definition.

displayOrder number

(Updatable) Specifies the order in which the summary must be displayed.

freeformTags {[key: string]: any}

isSeeded boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

parentId string

The OCID of the parent report definition.

recordTimeSpan string

schedule string

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId string

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType string

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName string

The name of the report to be scheduled.

scheduledReportRowLimit number

Specifies the limit on the number of rows in the report.

scimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state string

The current state of the report.

summaries ReportDefinitionSummary[]

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

Specifies the date and time the report definition was created.

timeUpdated string

The date and time the report definition was updated.

category str

Specifies the name of the category that this report belongs to.

column_filters Sequence[datasafe.ReportDefinitionColumnFilterArgs]

column_infos Sequence[datasafe.ReportDefinitionColumnInfoArgs]

column_sortings Sequence[datasafe.ReportDefinitionColumnSortingArgs]

compartment_id str

(Updatable) The OCID of the compartment containing the report definition.

compliance_standards Sequence[str]

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

data_source str

Specifies the name of a resource that provides data for the report. For example alerts, events.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description str

(Updatable) The description of the report definition.

display_name str

(Updatable) Specifies the name of the report definition.

display_order int

(Updatable) Specifies the order in which the summary must be displayed.

freeform_tags Mapping[str, Any]

is_seeded bool

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

parent_id str

The OCID of the parent report definition.

record_time_span str

schedule str

The schedule to generate the report periodically in the specified format: ;

scheduled_report_compartment_id str

The OCID of the compartment in which the scheduled resource will be created.

scheduled_report_mime_type str

Specifies the format of the report ( either .xls or .pdf )

scheduled_report_name str

The name of the report to be scheduled.

scheduled_report_row_limit int

Specifies the limit on the number of rows in the report.

scim_filter str

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state str

The current state of the report.

summaries Sequence[datasafe.ReportDefinitionSummaryArgs]

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

Specifies the date and time the report definition was created.

time_updated str

The date and time the report definition was updated.

category String

Specifies the name of the category that this report belongs to.

columnFilters List<Property Map>

columnInfos List<Property Map>

columnSortings List<Property Map>

compartmentId String

(Updatable) The OCID of the compartment containing the report definition.

complianceStandards List<String>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

dataSource String

Specifies the name of a resource that provides data for the report. For example alerts, events.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description String

(Updatable) The description of the report definition.

displayName String

(Updatable) Specifies the name of the report definition.

displayOrder Number

(Updatable) Specifies the order in which the summary must be displayed.

freeformTags Map<Any>

isSeeded Boolean

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

parentId String

The OCID of the parent report definition.

recordTimeSpan String

schedule String

The schedule to generate the report periodically in the specified format: ;

scheduledReportCompartmentId String

The OCID of the compartment in which the scheduled resource will be created.

scheduledReportMimeType String

Specifies the format of the report ( either .xls or .pdf )

scheduledReportName String

The name of the report to be scheduled.

scheduledReportRowLimit Number

Specifies the limit on the number of rows in the report.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String

The current state of the report.

summaries List<Property Map>

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Specifies the date and time the report definition was created.

timeUpdated String

The date and time the report definition was updated.

Supporting Types

ReportDefinitionColumnFilter, ReportDefinitionColumnFilterArgs

Expressions List<string>: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
FieldName string: (Updatable) Name of the column that must be sorted.
IsEnabled bool: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
IsHidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Operator string: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

Expressions []string: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
FieldName string: (Updatable) Name of the column that must be sorted.
IsEnabled bool: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
IsHidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Operator string: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

expressions List<String>: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName String: (Updatable) Name of the column that must be sorted.
isEnabled Boolean: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden Boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator String: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

expressions string[]: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName string: (Updatable) Name of the column that must be sorted.
isEnabled boolean: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator string: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

expressions Sequence[str]: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
field_name str: (Updatable) Name of the column that must be sorted.
is_enabled bool: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
is_hidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator str: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

expressions List<String>: (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName String: (Updatable) Name of the column that must be sorted.
isEnabled Boolean: (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden Boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator String: (Updatable) Specifies the type of operator that must be applied for example in, eq etc.

ReportDefinitionColumnInfo, ReportDefinitionColumnInfoArgs

DisplayName string: (Updatable) Specifies the name of the report definition.
DisplayOrder int: (Updatable) Specifies the order in which the summary must be displayed.
FieldName string: (Updatable) Name of the column that must be sorted.
IsHidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
DataType string: (Updatable) Specifies the data type of the column.

DisplayName string: (Updatable) Specifies the name of the report definition.
DisplayOrder int: (Updatable) Specifies the order in which the summary must be displayed.
FieldName string: (Updatable) Name of the column that must be sorted.
IsHidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
DataType string: (Updatable) Specifies the data type of the column.

displayName String: (Updatable) Specifies the name of the report definition.
displayOrder Integer: (Updatable) Specifies the order in which the summary must be displayed.
fieldName String: (Updatable) Name of the column that must be sorted.
isHidden Boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
dataType String: (Updatable) Specifies the data type of the column.

displayName string: (Updatable) Specifies the name of the report definition.
displayOrder number: (Updatable) Specifies the order in which the summary must be displayed.
fieldName string: (Updatable) Name of the column that must be sorted.
isHidden boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
dataType string: (Updatable) Specifies the data type of the column.

display_name str: (Updatable) Specifies the name of the report definition.
display_order int: (Updatable) Specifies the order in which the summary must be displayed.
field_name str: (Updatable) Name of the column that must be sorted.
is_hidden bool: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
data_type str: (Updatable) Specifies the data type of the column.

displayName String: (Updatable) Specifies the name of the report definition.
displayOrder Number: (Updatable) Specifies the order in which the summary must be displayed.
fieldName String: (Updatable) Name of the column that must be sorted.
isHidden Boolean: (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.
dataType String: (Updatable) Specifies the data type of the column.

ReportDefinitionColumnSorting, ReportDefinitionColumnSortingArgs

FieldName string: (Updatable) Name of the column that must be sorted.
IsAscending bool: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
SortingOrder int: (Updatable) Indicates the order at which column must be sorted.

FieldName string: (Updatable) Name of the column that must be sorted.
IsAscending bool: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
SortingOrder int: (Updatable) Indicates the order at which column must be sorted.

fieldName String: (Updatable) Name of the column that must be sorted.
isAscending Boolean: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder Integer: (Updatable) Indicates the order at which column must be sorted.

fieldName string: (Updatable) Name of the column that must be sorted.
isAscending boolean: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder number: (Updatable) Indicates the order at which column must be sorted.

field_name str: (Updatable) Name of the column that must be sorted.
is_ascending bool: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sorting_order int: (Updatable) Indicates the order at which column must be sorted.

fieldName String: (Updatable) Name of the column that must be sorted.
isAscending Boolean: (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder Number: (Updatable) Indicates the order at which column must be sorted.

ReportDefinitionSummary, ReportDefinitionSummaryArgs

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

Name string

(Updatable) Name of the report summary.

CountOf string

(Updatable) Name of the key or count of object.

GroupByFieldName string

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

IsHidden bool

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DisplayOrder int

(Updatable) Specifies the order in which the summary must be displayed.

Name string

(Updatable) Name of the report summary.

CountOf string

(Updatable) Name of the key or count of object.

GroupByFieldName string

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

IsHidden bool

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

ScimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

displayOrder Integer

(Updatable) Specifies the order in which the summary must be displayed.

name String

(Updatable) Name of the report summary.

countOf String

(Updatable) Name of the key or count of object.

groupByFieldName String

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

isHidden Boolean

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

displayOrder number

(Updatable) Specifies the order in which the summary must be displayed.

name string

(Updatable) Name of the report summary.

countOf string

(Updatable) Name of the key or count of object.

groupByFieldName string

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

isHidden boolean

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

scimFilter string

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

display_order int

(Updatable) Specifies the order in which the summary must be displayed.

name str

(Updatable) Name of the report summary.

count_of str

(Updatable) Name of the key or count of object.

group_by_field_name str

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

is_hidden bool

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

scim_filter str

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

displayOrder Number

(Updatable) Specifies the order in which the summary must be displayed.

name String

(Updatable) Name of the report summary.

countOf String

(Updatable) Name of the key or count of object.

groupByFieldName String

(Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.

isHidden Boolean

(Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'.

scimFilter String

(Updatable) Additional scim filters used to get the specific summary.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Import

ReportDefinitions can be imported using the id, e.g.

$ pulumi import oci:DataSafe/reportDefinition:ReportDefinition test_report_definition "id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

pulumi/pulumi-oci

oci.DataSafe.ReportDefinition

On this page

On this page

Example Usage

Create ReportDefinition Resource

Constructor syntax

Parameters

Example

ReportDefinition Resource Properties

Inputs

Outputs

Look up Existing ReportDefinition Resource

Supporting Types

ReportDefinitionColumnFilter, ReportDefinitionColumnFilterArgs

ReportDefinitionColumnInfo, ReportDefinitionColumnInfoArgs

ReportDefinitionColumnSorting, ReportDefinitionColumnSortingArgs

ReportDefinitionSummary, ReportDefinitionSummaryArgs

Import

Package Details

On this page

On this page