1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSccReport
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getSccReport

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve information about a report from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute region to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const sccReport = ibm.getSccReport({
        instanceId: "00000000-1111-2222-3333-444444444444",
        reportId: "report_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    scc_report = ibm.get_scc_report(instance_id="00000000-1111-2222-3333-444444444444",
        report_id="report_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetSccReport(ctx, &ibm.GetSccReportArgs{
    			InstanceId: "00000000-1111-2222-3333-444444444444",
    			ReportId:   "report_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var sccReport = Ibm.GetSccReport.Invoke(new()
        {
            InstanceId = "00000000-1111-2222-3333-444444444444",
            ReportId = "report_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetSccReportArgs;
    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) {
            final var sccReport = IbmFunctions.getSccReport(GetSccReportArgs.builder()
                .instanceId("00000000-1111-2222-3333-444444444444")
                .reportId("report_id")
                .build());
    
        }
    }
    
    variables:
      sccReport:
        fn::invoke:
          function: ibm:getSccReport
          arguments:
            instanceId: 00000000-1111-2222-3333-444444444444
            reportId: report_id
    

    Using getSccReport

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSccReport(args: GetSccReportArgs, opts?: InvokeOptions): Promise<GetSccReportResult>
    function getSccReportOutput(args: GetSccReportOutputArgs, opts?: InvokeOptions): Output<GetSccReportResult>
    def get_scc_report(instance_id: Optional[str] = None,
                       report_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSccReportResult
    def get_scc_report_output(instance_id: Optional[pulumi.Input[str]] = None,
                       report_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSccReportResult]
    func GetSccReport(ctx *Context, args *GetSccReportArgs, opts ...InvokeOption) (*GetSccReportResult, error)
    func GetSccReportOutput(ctx *Context, args *GetSccReportOutputArgs, opts ...InvokeOption) GetSccReportResultOutput

    > Note: This function is named GetSccReport in the Go SDK.

    public static class GetSccReport 
    {
        public static Task<GetSccReportResult> InvokeAsync(GetSccReportArgs args, InvokeOptions? opts = null)
        public static Output<GetSccReportResult> Invoke(GetSccReportInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSccReportResult> getSccReport(GetSccReportArgs args, InvokeOptions options)
    public static Output<GetSccReportResult> getSccReport(GetSccReportArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSccReport:getSccReport
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The ID of the SCC instance in a particular region.
    ReportId string
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.
    InstanceId string
    The ID of the SCC instance in a particular region.
    ReportId string
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.
    instanceId String
    The ID of the SCC instance in a particular region.
    reportId String
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.
    instanceId string
    The ID of the SCC instance in a particular region.
    reportId string
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.
    instance_id str
    The ID of the SCC instance in a particular region.
    report_id str
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.
    instanceId String
    The ID of the SCC instance in a particular region.
    reportId String
    The ID of the scan that is associated with a report.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\\-]+$/.

    getSccReport Result

    The following output properties are available:

    Accounts List<GetSccReportAccount>
    (List) The account that is associated with a report. Nested schema for account:
    Attachments List<GetSccReportAttachment>
    (List) The attachment that is associated with a report. Nested schema for attachment:
    CosObject string
    (String) The Cloud Object Storage object that is associated with the report.
    CreatedOn string
    (String) The date when the report was created.
    GroupId string
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    Id string
    (String) The profile ID.
    InstanceId string
    (String) Instance ID.
    Profiles List<GetSccReportProfile>
    (List) The profile information. Nested schema for profile:
    ReportId string
    ScanTime string
    (String) The date when the scan was run.
    Type string
    (String) The type of the scan.
    Accounts []GetSccReportAccount
    (List) The account that is associated with a report. Nested schema for account:
    Attachments []GetSccReportAttachment
    (List) The attachment that is associated with a report. Nested schema for attachment:
    CosObject string
    (String) The Cloud Object Storage object that is associated with the report.
    CreatedOn string
    (String) The date when the report was created.
    GroupId string
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    Id string
    (String) The profile ID.
    InstanceId string
    (String) Instance ID.
    Profiles []GetSccReportProfile
    (List) The profile information. Nested schema for profile:
    ReportId string
    ScanTime string
    (String) The date when the scan was run.
    Type string
    (String) The type of the scan.
    accounts List<GetSccReportAccount>
    (List) The account that is associated with a report. Nested schema for account:
    attachments List<GetSccReportAttachment>
    (List) The attachment that is associated with a report. Nested schema for attachment:
    cosObject String
    (String) The Cloud Object Storage object that is associated with the report.
    createdOn String
    (String) The date when the report was created.
    groupId String
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    id String
    (String) The profile ID.
    instanceId String
    (String) Instance ID.
    profiles List<GetSccReportProfile>
    (List) The profile information. Nested schema for profile:
    reportId String
    scanTime String
    (String) The date when the scan was run.
    type String
    (String) The type of the scan.
    accounts GetSccReportAccount[]
    (List) The account that is associated with a report. Nested schema for account:
    attachments GetSccReportAttachment[]
    (List) The attachment that is associated with a report. Nested schema for attachment:
    cosObject string
    (String) The Cloud Object Storage object that is associated with the report.
    createdOn string
    (String) The date when the report was created.
    groupId string
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    id string
    (String) The profile ID.
    instanceId string
    (String) Instance ID.
    profiles GetSccReportProfile[]
    (List) The profile information. Nested schema for profile:
    reportId string
    scanTime string
    (String) The date when the scan was run.
    type string
    (String) The type of the scan.
    accounts Sequence[GetSccReportAccount]
    (List) The account that is associated with a report. Nested schema for account:
    attachments Sequence[GetSccReportAttachment]
    (List) The attachment that is associated with a report. Nested schema for attachment:
    cos_object str
    (String) The Cloud Object Storage object that is associated with the report.
    created_on str
    (String) The date when the report was created.
    group_id str
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    id str
    (String) The profile ID.
    instance_id str
    (String) Instance ID.
    profiles Sequence[GetSccReportProfile]
    (List) The profile information. Nested schema for profile:
    report_id str
    scan_time str
    (String) The date when the scan was run.
    type str
    (String) The type of the scan.
    accounts List<Property Map>
    (List) The account that is associated with a report. Nested schema for account:
    attachments List<Property Map>
    (List) The attachment that is associated with a report. Nested schema for attachment:
    cosObject String
    (String) The Cloud Object Storage object that is associated with the report.
    createdOn String
    (String) The date when the report was created.
    groupId String
    (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs.
    id String
    (String) The profile ID.
    instanceId String
    (String) Instance ID.
    profiles List<Property Map>
    (List) The profile information. Nested schema for profile:
    reportId String
    scanTime String
    (String) The date when the scan was run.
    type String
    (String) The type of the scan.

    Supporting Types

    GetSccReportAccount

    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Type string
    (String) The type of the scan.
    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Type string
    (String) The type of the scan.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    type String
    (String) The type of the scan.
    id string
    (String) The profile ID.
    name string
    (String) The profile name.
    type string
    (String) The type of the scan.
    id str
    (String) The profile ID.
    name str
    (String) The profile name.
    type str
    (String) The type of the scan.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    type String
    (String) The type of the scan.

    GetSccReportAttachment

    Description string
    (String) The description of the attachment.
    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Schedule string
    (String) The attachment schedule.
    Scopes List<GetSccReportAttachmentScope>
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:
    Description string
    (String) The description of the attachment.
    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Schedule string
    (String) The attachment schedule.
    Scopes []GetSccReportAttachmentScope
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:
    description String
    (String) The description of the attachment.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    schedule String
    (String) The attachment schedule.
    scopes List<GetSccReportAttachmentScope>
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:
    description string
    (String) The description of the attachment.
    id string
    (String) The profile ID.
    name string
    (String) The profile name.
    schedule string
    (String) The attachment schedule.
    scopes GetSccReportAttachmentScope[]
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:
    description str
    (String) The description of the attachment.
    id str
    (String) The profile ID.
    name str
    (String) The profile name.
    schedule str
    (String) The attachment schedule.
    scopes Sequence[GetSccReportAttachmentScope]
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:
    description String
    (String) The description of the attachment.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    schedule String
    (String) The attachment schedule.
    scopes List<Property Map>
    (List) The scope of the attachment.

    • Constraints: The maximum length is 8 items. The minimum length is 0 items. Nested schema for scope:

    GetSccReportAttachmentScope

    Environment string
    (String) The environment that relates to this scope.
    Id string
    (String) The profile ID.
    Properties List<GetSccReportAttachmentScopeProperty>
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:
    Environment string
    (String) The environment that relates to this scope.
    Id string
    (String) The profile ID.
    Properties []GetSccReportAttachmentScopeProperty
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:
    environment String
    (String) The environment that relates to this scope.
    id String
    (String) The profile ID.
    properties List<GetSccReportAttachmentScopeProperty>
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:
    environment string
    (String) The environment that relates to this scope.
    id string
    (String) The profile ID.
    properties GetSccReportAttachmentScopeProperty[]
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:
    environment str
    (String) The environment that relates to this scope.
    id str
    (String) The profile ID.
    properties Sequence[GetSccReportAttachmentScopeProperty]
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:
    environment String
    (String) The environment that relates to this scope.
    id String
    (String) The profile ID.
    properties List<Property Map>
    (List) The properties that are supported for scoping by this environment.

    • Constraints: The maximum length is 99999 items. The minimum length is 0 items. Nested schema for properties:

    GetSccReportAttachmentScopeProperty

    Name string
    (String) The profile name.
    Value string
    (String) The property value.
    Name string
    (String) The profile name.
    Value string
    (String) The property value.
    name String
    (String) The profile name.
    value String
    (String) The property value.
    name string
    (String) The profile name.
    value string
    (String) The property value.
    name str
    (String) The profile name.
    value str
    (String) The property value.
    name String
    (String) The profile name.
    value String
    (String) The property value.

    GetSccReportProfile

    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Version string
    (String) The profile version.
    Id string
    (String) The profile ID.
    Name string
    (String) The profile name.
    Version string
    (String) The profile version.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    version String
    (String) The profile version.
    id string
    (String) The profile ID.
    name string
    (String) The profile name.
    version string
    (String) The profile version.
    id str
    (String) The profile ID.
    name str
    (String) The profile name.
    version str
    (String) The profile version.
    id String
    (String) The profile ID.
    name String
    (String) The profile name.
    version String
    (String) The profile version.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud