1. Packages
  2. Ibm Provider
  3. API Docs
  4. SccScope
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.SccScope

Explore with Pulumi AI

Create, update, and delete scc_scopes with this resource.

Example Usage

To create a scope targeting an account

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

const sccAccountScope = new ibm.SccScope("sccAccountScope", {
    description: "This scope allows a profile attachment to target an IBM account",
    environment: "ibm-cloud",
    instanceId: "b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties: {
        scope_id: "8e042beeccee40748674442960b9eb34",
        scope_type: "account",
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

scc_account_scope = ibm.SccScope("sccAccountScope",
    description="This scope allows a profile attachment to target an IBM account",
    environment="ibm-cloud",
    instance_id="b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties={
        "scope_id": "8e042beeccee40748674442960b9eb34",
        "scope_type": "account",
    })
Copy
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.NewSccScope(ctx, "sccAccountScope", &ibm.SccScopeArgs{
			Description: pulumi.String("This scope allows a profile attachment to target an IBM account"),
			Environment: pulumi.String("ibm-cloud"),
			InstanceId:  pulumi.String("b36c26e9-477a-43a1-9c50-19aff8e5d760"),
			Properties: pulumi.StringMap{
				"scope_id":   pulumi.String("8e042beeccee40748674442960b9eb34"),
				"scope_type": pulumi.String("account"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var sccAccountScope = new Ibm.SccScope("sccAccountScope", new()
    {
        Description = "This scope allows a profile attachment to target an IBM account",
        Environment = "ibm-cloud",
        InstanceId = "b36c26e9-477a-43a1-9c50-19aff8e5d760",
        Properties = 
        {
            { "scope_id", "8e042beeccee40748674442960b9eb34" },
            { "scope_type", "account" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SccScope;
import com.pulumi.ibm.SccScopeArgs;
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 sccAccountScope = new SccScope("sccAccountScope", SccScopeArgs.builder()
            .description("This scope allows a profile attachment to target an IBM account")
            .environment("ibm-cloud")
            .instanceId("b36c26e9-477a-43a1-9c50-19aff8e5d760")
            .properties(Map.ofEntries(
                Map.entry("scope_id", "8e042beeccee40748674442960b9eb34"),
                Map.entry("scope_type", "account")
            ))
            .build());

    }
}
Copy
resources:
  sccAccountScope:
    type: ibm:SccScope
    properties:
      description: This scope allows a profile attachment to target an IBM account
      environment: ibm-cloud
      instanceId: b36c26e9-477a-43a1-9c50-19aff8e5d760
      properties:
        scope_id: 8e042beeccee40748674442960b9eb34
        scope_type: account
Copy

To create a scope targeting an enterprise

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

const sccEnterpriseScope = new ibm.SccScope("sccEnterpriseScope", {
    description: "This scope allows a profile attachment to target an IBM enterprise",
    environment: "ibm-cloud",
    instanceId: "b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties: {
        scope_id: "6a204bd89f3c8348afd5c77c717a097a",
        scope_type: "enterprise",
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

scc_enterprise_scope = ibm.SccScope("sccEnterpriseScope",
    description="This scope allows a profile attachment to target an IBM enterprise",
    environment="ibm-cloud",
    instance_id="b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties={
        "scope_id": "6a204bd89f3c8348afd5c77c717a097a",
        "scope_type": "enterprise",
    })
Copy
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.NewSccScope(ctx, "sccEnterpriseScope", &ibm.SccScopeArgs{
			Description: pulumi.String("This scope allows a profile attachment to target an IBM enterprise"),
			Environment: pulumi.String("ibm-cloud"),
			InstanceId:  pulumi.String("b36c26e9-477a-43a1-9c50-19aff8e5d760"),
			Properties: pulumi.StringMap{
				"scope_id":   pulumi.String("6a204bd89f3c8348afd5c77c717a097a"),
				"scope_type": pulumi.String("enterprise"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var sccEnterpriseScope = new Ibm.SccScope("sccEnterpriseScope", new()
    {
        Description = "This scope allows a profile attachment to target an IBM enterprise",
        Environment = "ibm-cloud",
        InstanceId = "b36c26e9-477a-43a1-9c50-19aff8e5d760",
        Properties = 
        {
            { "scope_id", "6a204bd89f3c8348afd5c77c717a097a" },
            { "scope_type", "enterprise" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SccScope;
import com.pulumi.ibm.SccScopeArgs;
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 sccEnterpriseScope = new SccScope("sccEnterpriseScope", SccScopeArgs.builder()
            .description("This scope allows a profile attachment to target an IBM enterprise")
            .environment("ibm-cloud")
            .instanceId("b36c26e9-477a-43a1-9c50-19aff8e5d760")
            .properties(Map.ofEntries(
                Map.entry("scope_id", "6a204bd89f3c8348afd5c77c717a097a"),
                Map.entry("scope_type", "enterprise")
            ))
            .build());

    }
}
Copy
resources:
  sccEnterpriseScope:
    type: ibm:SccScope
    properties:
      description: This scope allows a profile attachment to target an IBM enterprise
      environment: ibm-cloud
      instanceId: b36c26e9-477a-43a1-9c50-19aff8e5d760
      properties:
        scope_id: 6a204bd89f3c8348afd5c77c717a097a
        scope_type: enterprise
Copy

To create a scope targeting an account with an exclusion of a resource group

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

const sccAccountScope = new ibm.SccScope("sccAccountScope", {
    description: "This scope allows a profile attachment to target an IBM account",
    environment: "ibm-cloud",
    exclusions: [{
        scopeId: "ff6ce35b305abe1f768e3317628c0ba3",
        scopeType: "account.resource_group",
    }],
    instanceId: "b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties: {
        scope_id: "8e042beeccee40748674442960b9eb34",
        scope_type: "account",
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

scc_account_scope = ibm.SccScope("sccAccountScope",
    description="This scope allows a profile attachment to target an IBM account",
    environment="ibm-cloud",
    exclusions=[{
        "scope_id": "ff6ce35b305abe1f768e3317628c0ba3",
        "scope_type": "account.resource_group",
    }],
    instance_id="b36c26e9-477a-43a1-9c50-19aff8e5d760",
    properties={
        "scope_id": "8e042beeccee40748674442960b9eb34",
        "scope_type": "account",
    })
Copy
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.NewSccScope(ctx, "sccAccountScope", &ibm.SccScopeArgs{
			Description: pulumi.String("This scope allows a profile attachment to target an IBM account"),
			Environment: pulumi.String("ibm-cloud"),
			Exclusions: ibm.SccScopeExclusionArray{
				&ibm.SccScopeExclusionArgs{
					ScopeId:   pulumi.String("ff6ce35b305abe1f768e3317628c0ba3"),
					ScopeType: pulumi.String("account.resource_group"),
				},
			},
			InstanceId: pulumi.String("b36c26e9-477a-43a1-9c50-19aff8e5d760"),
			Properties: pulumi.StringMap{
				"scope_id":   pulumi.String("8e042beeccee40748674442960b9eb34"),
				"scope_type": pulumi.String("account"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var sccAccountScope = new Ibm.SccScope("sccAccountScope", new()
    {
        Description = "This scope allows a profile attachment to target an IBM account",
        Environment = "ibm-cloud",
        Exclusions = new[]
        {
            new Ibm.Inputs.SccScopeExclusionArgs
            {
                ScopeId = "ff6ce35b305abe1f768e3317628c0ba3",
                ScopeType = "account.resource_group",
            },
        },
        InstanceId = "b36c26e9-477a-43a1-9c50-19aff8e5d760",
        Properties = 
        {
            { "scope_id", "8e042beeccee40748674442960b9eb34" },
            { "scope_type", "account" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SccScope;
import com.pulumi.ibm.SccScopeArgs;
import com.pulumi.ibm.inputs.SccScopeExclusionArgs;
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 sccAccountScope = new SccScope("sccAccountScope", SccScopeArgs.builder()
            .description("This scope allows a profile attachment to target an IBM account")
            .environment("ibm-cloud")
            .exclusions(SccScopeExclusionArgs.builder()
                .scopeId("ff6ce35b305abe1f768e3317628c0ba3")
                .scopeType("account.resource_group")
                .build())
            .instanceId("b36c26e9-477a-43a1-9c50-19aff8e5d760")
            .properties(Map.ofEntries(
                Map.entry("scope_id", "8e042beeccee40748674442960b9eb34"),
                Map.entry("scope_type", "account")
            ))
            .build());

    }
}
Copy
resources:
  sccAccountScope:
    type: ibm:SccScope
    properties:
      description: This scope allows a profile attachment to target an IBM account
      environment: ibm-cloud
      exclusions:
        - scopeId: ff6ce35b305abe1f768e3317628c0ba3
          scopeType: account.resource_group
      instanceId: b36c26e9-477a-43a1-9c50-19aff8e5d760
      properties:
        scope_id: 8e042beeccee40748674442960b9eb34
        scope_type: account
Copy

Create SccScope Resource

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

Constructor syntax

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

@overload
def SccScope(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             environment: Optional[str] = None,
             instance_id: Optional[str] = None,
             properties: Optional[Mapping[str, str]] = None,
             description: Optional[str] = None,
             exclusions: Optional[Sequence[SccScopeExclusionArgs]] = None,
             name: Optional[str] = None,
             scc_scope_id: Optional[str] = None)
func NewSccScope(ctx *Context, name string, args SccScopeArgs, opts ...ResourceOption) (*SccScope, error)
public SccScope(string name, SccScopeArgs args, CustomResourceOptions? opts = null)
public SccScope(String name, SccScopeArgs args)
public SccScope(String name, SccScopeArgs args, CustomResourceOptions options)
type: ibm:SccScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SccScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SccScopeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SccScopeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SccScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SccScopeArgs
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 sccScopeResource = new Ibm.SccScope("sccScopeResource", new()
{
    Environment = "string",
    InstanceId = "string",
    Properties = 
    {
        { "string", "string" },
    },
    Description = "string",
    Exclusions = new[]
    {
        new Ibm.Inputs.SccScopeExclusionArgs
        {
            ScopeId = "string",
            ScopeType = "string",
        },
    },
    Name = "string",
    SccScopeId = "string",
});
Copy
example, err := ibm.NewSccScope(ctx, "sccScopeResource", &ibm.SccScopeArgs{
Environment: pulumi.String("string"),
InstanceId: pulumi.String("string"),
Properties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Exclusions: .SccScopeExclusionArray{
&.SccScopeExclusionArgs{
ScopeId: pulumi.String("string"),
ScopeType: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
SccScopeId: pulumi.String("string"),
})
Copy
var sccScopeResource = new SccScope("sccScopeResource", SccScopeArgs.builder()
    .environment("string")
    .instanceId("string")
    .properties(Map.of("string", "string"))
    .description("string")
    .exclusions(SccScopeExclusionArgs.builder()
        .scopeId("string")
        .scopeType("string")
        .build())
    .name("string")
    .sccScopeId("string")
    .build());
Copy
scc_scope_resource = ibm.SccScope("sccScopeResource",
    environment="string",
    instance_id="string",
    properties={
        "string": "string",
    },
    description="string",
    exclusions=[{
        "scope_id": "string",
        "scope_type": "string",
    }],
    name="string",
    scc_scope_id="string")
Copy
const sccScopeResource = new ibm.SccScope("sccScopeResource", {
    environment: "string",
    instanceId: "string",
    properties: {
        string: "string",
    },
    description: "string",
    exclusions: [{
        scopeId: "string",
        scopeType: "string",
    }],
    name: "string",
    sccScopeId: "string",
});
Copy
type: ibm:SccScope
properties:
    description: string
    environment: string
    exclusions:
        - scopeId: string
          scopeType: string
    instanceId: string
    name: string
    properties:
        string: string
    sccScopeId: string
Copy

SccScope 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 SccScope resource accepts the following input properties:

Environment This property is required. string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
InstanceId This property is required. string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
Properties This property is required. Dictionary<string, string>

The properties of the scope to target.

Keys accepted in properties:

Description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Exclusions List<SccScopeExclusion>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

Name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
SccScopeId string
The unique identifier of the scc_scope.
Environment This property is required. string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
InstanceId This property is required. string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
Properties This property is required. map[string]string

The properties of the scope to target.

Keys accepted in properties:

Description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Exclusions []SccScopeExclusionArgs

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

Name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
SccScopeId string
The unique identifier of the scc_scope.
environment This property is required. String
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
instanceId This property is required. String
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
properties This property is required. Map<String,String>

The properties of the scope to target.

Keys accepted in properties:

description String
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
exclusions List<SccScopeExclusion>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

name String
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
sccScopeId String
The unique identifier of the scc_scope.
environment This property is required. string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
instanceId This property is required. string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
properties This property is required. {[key: string]: string}

The properties of the scope to target.

Keys accepted in properties:

description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
exclusions SccScopeExclusion[]

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
sccScopeId string
The unique identifier of the scc_scope.
environment This property is required. str
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
instance_id This property is required. str
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
properties This property is required. Mapping[str, str]

The properties of the scope to target.

Keys accepted in properties:

description str
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
exclusions Sequence[SccScopeExclusionArgs]

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

name str
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
scc_scope_id str
The unique identifier of the scc_scope.
environment This property is required. String
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
instanceId This property is required. String
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
properties This property is required. Map<String>

The properties of the scope to target.

Keys accepted in properties:

description String
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
exclusions List<Property Map>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

name String
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
sccScopeId String
The unique identifier of the scc_scope.

Outputs

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

AccountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
AttachmentCount double
(Float) The number of attachments tied to the scope.
CreatedBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
CreatedOn string
(String) The date when the scope was created.
Id string
The provider-assigned unique ID for this managed resource.
ScopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
UpdatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
UpdatedOn string
(String) The date when the scope was updated.
AccountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
AttachmentCount float64
(Float) The number of attachments tied to the scope.
CreatedBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
CreatedOn string
(String) The date when the scope was created.
Id string
The provider-assigned unique ID for this managed resource.
ScopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
UpdatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
UpdatedOn string
(String) The date when the scope was updated.
accountId String
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount Double
(Float) The number of attachments tied to the scope.
createdBy String
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn String
(String) The date when the scope was created.
id String
The provider-assigned unique ID for this managed resource.
scopeId String
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy String
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn String
(String) The date when the scope was updated.
accountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount number
(Float) The number of attachments tied to the scope.
createdBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn string
(String) The date when the scope was created.
id string
The provider-assigned unique ID for this managed resource.
scopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn string
(String) The date when the scope was updated.
account_id str
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachment_count float
(Float) The number of attachments tied to the scope.
created_by str
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
created_on str
(String) The date when the scope was created.
id str
The provider-assigned unique ID for this managed resource.
scope_id str
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updated_by str
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updated_on str
(String) The date when the scope was updated.
accountId String
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount Number
(Float) The number of attachments tied to the scope.
createdBy String
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn String
(String) The date when the scope was created.
id String
The provider-assigned unique ID for this managed resource.
scopeId String
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy String
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn String
(String) The date when the scope was updated.

Look up Existing SccScope Resource

Get an existing SccScope 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?: SccScopeState, opts?: CustomResourceOptions): SccScope
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        attachment_count: Optional[float] = None,
        created_by: Optional[str] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        environment: Optional[str] = None,
        exclusions: Optional[Sequence[SccScopeExclusionArgs]] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        scc_scope_id: Optional[str] = None,
        scope_id: Optional[str] = None,
        updated_by: Optional[str] = None,
        updated_on: Optional[str] = None) -> SccScope
func GetSccScope(ctx *Context, name string, id IDInput, state *SccScopeState, opts ...ResourceOption) (*SccScope, error)
public static SccScope Get(string name, Input<string> id, SccScopeState? state, CustomResourceOptions? opts = null)
public static SccScope get(String name, Output<String> id, SccScopeState state, CustomResourceOptions options)
resources:  _:    type: ibm:SccScope    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
AttachmentCount double
(Float) The number of attachments tied to the scope.
CreatedBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
CreatedOn string
(String) The date when the scope was created.
Description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Environment string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
Exclusions List<SccScopeExclusion>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

InstanceId string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
Name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Properties Dictionary<string, string>

The properties of the scope to target.

Keys accepted in properties:

SccScopeId string
The unique identifier of the scc_scope.
ScopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
UpdatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
UpdatedOn string
(String) The date when the scope was updated.
AccountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
AttachmentCount float64
(Float) The number of attachments tied to the scope.
CreatedBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
CreatedOn string
(String) The date when the scope was created.
Description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Environment string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
Exclusions []SccScopeExclusionArgs

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

InstanceId string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
Name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
Properties map[string]string

The properties of the scope to target.

Keys accepted in properties:

SccScopeId string
The unique identifier of the scc_scope.
ScopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
UpdatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
UpdatedOn string
(String) The date when the scope was updated.
accountId String
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount Double
(Float) The number of attachments tied to the scope.
createdBy String
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn String
(String) The date when the scope was created.
description String
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
environment String
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
exclusions List<SccScopeExclusion>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

instanceId String
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
name String
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
properties Map<String,String>

The properties of the scope to target.

Keys accepted in properties:

sccScopeId String
The unique identifier of the scc_scope.
scopeId String
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy String
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn String
(String) The date when the scope was updated.
accountId string
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount number
(Float) The number of attachments tied to the scope.
createdBy string
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn string
(String) The date when the scope was created.
description string
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
environment string
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
exclusions SccScopeExclusion[]

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

instanceId string
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
name string
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
properties {[key: string]: string}

The properties of the scope to target.

Keys accepted in properties:

sccScopeId string
The unique identifier of the scc_scope.
scopeId string
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy string
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn string
(String) The date when the scope was updated.
account_id str
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachment_count float
(Float) The number of attachments tied to the scope.
created_by str
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
created_on str
(String) The date when the scope was created.
description str
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
environment str
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
exclusions Sequence[SccScopeExclusionArgs]

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

instance_id str
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
name str
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
properties Mapping[str, str]

The properties of the scope to target.

Keys accepted in properties:

scc_scope_id str
The unique identifier of the scc_scope.
scope_id str
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updated_by str
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updated_on str
(String) The date when the scope was updated.
accountId String
(String) The ID of the account associated with the scope.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9_\\-.]*$/.
attachmentCount Number
(Float) The number of attachments tied to the scope.
createdBy String
(String) The identifier of the account or service ID who created the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
createdOn String
(String) The date when the scope was created.
description String
The scope description.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
environment String
The scope environment. This value details what cloud provider the scope targets.

  • Constraints: The maximum length is 128 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
  • Acceptable values are:
  • ibm-cloud
exclusions List<Property Map>

A list of scopes/targets to exclude from a scope.

Nested schema for exclusions:

instanceId String
The ID of the Security and Compliance Center instance.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/.
name String
The scope name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9_,'\\s\\-\\.]*$/.
properties Map<String>

The properties of the scope to target.

Keys accepted in properties:

sccScopeId String
The unique identifier of the scc_scope.
scopeId String
(String) The ID of the scope.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^.*$/.
updatedBy String
(String) The ID of the user or service ID who updated the scope.

  • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9-\\.:,_\\s]*$/.
updatedOn String
(String) The date when the scope was updated.

Supporting Types

SccScopeExclusion
, SccScopeExclusionArgs

ScopeId string
The ID of the target defined in scope_type.
ScopeType string
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.
ScopeId string
The ID of the target defined in scope_type.
ScopeType string
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.
scopeId String
The ID of the target defined in scope_type.
scopeType String
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.
scopeId string
The ID of the target defined in scope_type.
scopeType string
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.
scope_id str
The ID of the target defined in scope_type.
scope_type str
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.
scopeId String
The ID of the target defined in scope_type.
scopeType String
The type of target to exclude from the scope

  • Constraints: Acceptable values are account, account.resource_group, or enterprise.account_group.

Import

You can import the ibm_scc_scope resource by using id.

The id property can be formed from instance_id, and scope_id in the following format:

<instance_id>/<scope_id>

  • instance_id: A string in the format acd7032c-15a3-484f-bf5b-67d41534d940. The ID of the Security and Compliance Center instance.

  • scope_id: A string. The ID of the scope being targeted.

Syntax

$ pulumi import ibm:index/sccScope:SccScope scc_scope <instance_id>/<scope_id>
Copy

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

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.