Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. Report
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.Report

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Report resource in Oracle Cloud Infrastructure Data Safe service.

    Updates the specified report. Only tags can be updated.

    Create Report Resource

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

    Constructor syntax

    new Report(name: string, args: ReportArgs, opts?: CustomResourceOptions);
    @overload
def Report(resource_name: str,
           args: ReportArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Report(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           report_id: Optional[str] = None,
           compartment_id: Optional[str] = None,
           defined_tags: Optional[Mapping[str, str]] = None,
           freeform_tags: Optional[Mapping[str, str]] = None)
    func NewReport(ctx *Context, name string, args ReportArgs, opts ...ResourceOption) (*Report, error)
    public Report(string name, ReportArgs args, CustomResourceOptions? opts = null)
    public Report(String name, ReportArgs args)
public Report(String name, ReportArgs args, CustomResourceOptions options)

    type: oci:DataSafe:Report
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 ReportArgs
    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 ReportArgs
    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 ReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var reportResource = new Oci.DataSafe.Report("reportResource", new()
{
    ReportId = "string",
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := DataSafe.NewReport(ctx, "reportResource", &DataSafe.ReportArgs{
	ReportId:      pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var reportResource = new Report("reportResource", ReportArgs.builder()
    .reportId("string")
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());

    report_resource = oci.data_safe.Report("reportResource",
    report_id="string",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })

    const reportResource = new oci.datasafe.Report("reportResource", {
    reportId: "string",
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});

    type: oci:DataSafe:Report
properties:
    compartmentId: string
    definedTags:
        string: string
    freeformTags:
        string: string
    reportId: string

    Report Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Report resource accepts the following input properties:

    ReportId string

    Unique report identifier

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the report.
    DefinedTags Dictionary<string, string>
    (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"}
    FreeformTags Dictionary<string, string>
    (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"}
    ReportId string

    Unique report identifier

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the report.
    DefinedTags map[string]string
    (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"}
    FreeformTags map[string]string
    (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"}
    reportId String

    Unique report identifier

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the report.
    definedTags Map<String,String>
    (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"}
    freeformTags Map<String,String>
    (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"}
    reportId string

    Unique report identifier

    ** 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

    compartmentId string
    (Updatable) The OCID of the compartment containing the report.
    definedTags {[key: string]: string}
    (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"}
    freeformTags {[key: string]: string}
    (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"}
    report_id str

    Unique report identifier

    ** 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

    compartment_id str
    (Updatable) The OCID of the compartment containing the report.
    defined_tags Mapping[str, str]
    (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"}
    freeform_tags Mapping[str, str]
    (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"}
    reportId String

    Unique report identifier

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the report.
    definedTags Map<String>
    (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"}
    freeformTags Map<String>
    (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 Report resource produces the following output properties:

    Description string
    Specifies a description of the report.
    DisplayName string
    Name of the report.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the report in Data Safe.
    MimeType string
    Specifies the format of report to be .xls or .pdf or .json
    ReportDefinitionId string
    The OCID of the report definition.
    State string
    The current state of the audit report.
    SystemTags Dictionary<string, string>
    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"}
    TimeGenerated string
    Specifies the date and time the report was generated.
    Type string
    The type of the audit report.
    Description string
    Specifies a description of the report.
    DisplayName string
    Name of the report.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Details about the current state of the report in Data Safe.
    MimeType string
    Specifies the format of report to be .xls or .pdf or .json
    ReportDefinitionId string
    The OCID of the report definition.
    State string
    The current state of the audit report.
    SystemTags map[string]string
    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"}
    TimeGenerated string
    Specifies the date and time the report was generated.
    Type string
    The type of the audit report.
    description String
    Specifies a description of the report.
    displayName String
    Name of the report.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the report in Data Safe.
    mimeType String
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId String
    The OCID of the report definition.
    state String
    The current state of the audit report.
    systemTags Map<String,String>
    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"}
    timeGenerated String
    Specifies the date and time the report was generated.
    type String
    The type of the audit report.
    description string
    Specifies a description of the report.
    displayName string
    Name of the report.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Details about the current state of the report in Data Safe.
    mimeType string
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId string
    The OCID of the report definition.
    state string
    The current state of the audit report.
    systemTags {[key: string]: string}
    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"}
    timeGenerated string
    Specifies the date and time the report was generated.
    type string
    The type of the audit report.
    description str
    Specifies a description of the report.
    display_name str
    Name of the report.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Details about the current state of the report in Data Safe.
    mime_type str
    Specifies the format of report to be .xls or .pdf or .json
    report_definition_id str
    The OCID of the report definition.
    state str
    The current state of the audit report.
    system_tags Mapping[str, str]
    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_generated str
    Specifies the date and time the report was generated.
    type str
    The type of the audit report.
    description String
    Specifies a description of the report.
    displayName String
    Name of the report.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Details about the current state of the report in Data Safe.
    mimeType String
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId String
    The OCID of the report definition.
    state String
    The current state of the audit report.
    systemTags Map<String>
    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"}
    timeGenerated String
    Specifies the date and time the report was generated.
    type String
    The type of the audit report.

    Look up Existing Report Resource

    Get an existing Report 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?: ReportState, opts?: CustomResourceOptions): Report
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        mime_type: Optional[str] = None,
        report_definition_id: Optional[str] = None,
        report_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_generated: Optional[str] = None,
        type: Optional[str] = None) -> Report
    func GetReport(ctx *Context, name string, id IDInput, state *ReportState, opts ...ResourceOption) (*Report, error)
    public static Report Get(string name, Input<string> id, ReportState? state, CustomResourceOptions? opts = null)
    public static Report get(String name, Output<String> id, ReportState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the report.
    DefinedTags Dictionary<string, string>
    (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
    Specifies a description of the report.
    DisplayName string
    Name of the report.
    FreeformTags Dictionary<string, string>
    (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"}
    LifecycleDetails string
    Details about the current state of the report in Data Safe.
    MimeType string
    Specifies the format of report to be .xls or .pdf or .json
    ReportDefinitionId string
    The OCID of the report definition.
    ReportId string

    Unique report identifier

    ** 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 audit report.
    SystemTags Dictionary<string, string>
    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"}
    TimeGenerated string
    Specifies the date and time the report was generated.
    Type string
    The type of the audit report.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the report.
    DefinedTags map[string]string
    (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
    Specifies a description of the report.
    DisplayName string
    Name of the report.
    FreeformTags map[string]string
    (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"}
    LifecycleDetails string
    Details about the current state of the report in Data Safe.
    MimeType string
    Specifies the format of report to be .xls or .pdf or .json
    ReportDefinitionId string
    The OCID of the report definition.
    ReportId string

    Unique report identifier

    ** 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 audit report.
    SystemTags map[string]string
    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"}
    TimeGenerated string
    Specifies the date and time the report was generated.
    Type string
    The type of the audit report.
    compartmentId String
    (Updatable) The OCID of the compartment containing the report.
    definedTags Map<String,String>
    (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
    Specifies a description of the report.
    displayName String
    Name of the report.
    freeformTags Map<String,String>
    (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"}
    lifecycleDetails String
    Details about the current state of the report in Data Safe.
    mimeType String
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId String
    The OCID of the report definition.
    reportId String

    Unique report identifier

    ** 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 audit report.
    systemTags Map<String,String>
    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"}
    timeGenerated String
    Specifies the date and time the report was generated.
    type String
    The type of the audit report.
    compartmentId string
    (Updatable) The OCID of the compartment containing the report.
    definedTags {[key: string]: string}
    (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
    Specifies a description of the report.
    displayName string
    Name of the report.
    freeformTags {[key: string]: string}
    (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"}
    lifecycleDetails string
    Details about the current state of the report in Data Safe.
    mimeType string
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId string
    The OCID of the report definition.
    reportId string

    Unique report identifier

    ** 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 audit report.
    systemTags {[key: string]: string}
    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"}
    timeGenerated string
    Specifies the date and time the report was generated.
    type string
    The type of the audit report.
    compartment_id str
    (Updatable) The OCID of the compartment containing the report.
    defined_tags Mapping[str, str]
    (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
    Specifies a description of the report.
    display_name str
    Name of the report.
    freeform_tags Mapping[str, str]
    (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"}
    lifecycle_details str
    Details about the current state of the report in Data Safe.
    mime_type str
    Specifies the format of report to be .xls or .pdf or .json
    report_definition_id str
    The OCID of the report definition.
    report_id str

    Unique report identifier

    ** 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 audit report.
    system_tags Mapping[str, str]
    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_generated str
    Specifies the date and time the report was generated.
    type str
    The type of the audit report.
    compartmentId String
    (Updatable) The OCID of the compartment containing the report.
    definedTags Map<String>
    (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
    Specifies a description of the report.
    displayName String
    Name of the report.
    freeformTags Map<String>
    (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"}
    lifecycleDetails String
    Details about the current state of the report in Data Safe.
    mimeType String
    Specifies the format of report to be .xls or .pdf or .json
    reportDefinitionId String
    The OCID of the report definition.
    reportId String

    Unique report identifier

    ** 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 audit report.
    systemTags Map<String>
    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"}
    timeGenerated String
    Specifies the date and time the report was generated.
    type String
    The type of the audit report.

    Import

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

    $ pulumi import oci:DataSafe/report:Report test_report "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.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci