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

ibm.getSccProviderType

Explore with Pulumi AI

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

    Retrieve information about a provider type 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 sccProviderType = ibm.getSccProviderType({
        providerTypeId: "provider_type_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    scc_provider_type = ibm.get_scc_provider_type(provider_type_id="provider_type_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.GetSccProviderType(ctx, &ibm.GetSccProviderTypeArgs{
    			ProviderTypeId: "provider_type_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 sccProviderType = Ibm.GetSccProviderType.Invoke(new()
        {
            ProviderTypeId = "provider_type_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.GetSccProviderTypeArgs;
    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 sccProviderType = IbmFunctions.getSccProviderType(GetSccProviderTypeArgs.builder()
                .providerTypeId("provider_type_id")
                .build());
    
        }
    }
    
    variables:
      sccProviderType:
        fn::invoke:
          function: ibm:getSccProviderType
          arguments:
            providerTypeId: provider_type_id
    

    Using getSccProviderType

    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 getSccProviderType(args: GetSccProviderTypeArgs, opts?: InvokeOptions): Promise<GetSccProviderTypeResult>
    function getSccProviderTypeOutput(args: GetSccProviderTypeOutputArgs, opts?: InvokeOptions): Output<GetSccProviderTypeResult>
    def get_scc_provider_type(instance_id: Optional[str] = None,
                              provider_type_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSccProviderTypeResult
    def get_scc_provider_type_output(instance_id: Optional[pulumi.Input[str]] = None,
                              provider_type_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSccProviderTypeResult]
    func GetSccProviderType(ctx *Context, args *GetSccProviderTypeArgs, opts ...InvokeOption) (*GetSccProviderTypeResult, error)
    func GetSccProviderTypeOutput(ctx *Context, args *GetSccProviderTypeOutputArgs, opts ...InvokeOption) GetSccProviderTypeResultOutput

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

    public static class GetSccProviderType 
    {
        public static Task<GetSccProviderTypeResult> InvokeAsync(GetSccProviderTypeArgs args, InvokeOptions? opts = null)
        public static Output<GetSccProviderTypeResult> Invoke(GetSccProviderTypeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSccProviderTypeResult> getSccProviderType(GetSccProviderTypeArgs args, InvokeOptions options)
    public static Output<GetSccProviderTypeResult> getSccProviderType(GetSccProviderTypeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSccProviderType:getSccProviderType
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    ProviderTypeId string
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.
    InstanceId string
    ProviderTypeId string
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.
    instanceId String
    providerTypeId String
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.
    instanceId string
    providerTypeId string
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.
    instance_id str
    provider_type_id str
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.
    instanceId String
    providerTypeId String
    The provider type ID.

    • Constraints: The maximum length is 36 characters. The minimum length is 32 characters. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

    getSccProviderType Result

    The following output properties are available:

    Attributes Dictionary<string, string>
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    CreatedAt string
    (String) The time when the resource was created.
    DataType string
    (String) The format of the results that a provider supports.
    Description string
    (String) The provider type description.
    Icon string
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    Id string
    (String) The unique identifier of the provider type.
    InstanceId string
    InstanceLimit double
    (Integer) The maximum number of instances that can be created for the provider type.
    Labels List<GetSccProviderTypeLabel>
    (List) The label that is associated with the provider type. Nested schema for label:
    Mode string
    (String) The mode that is used to get results from provider (PUSH or PULL).
    Name string
    (String) The name of the provider type.
    ProviderTypeId string
    S2sEnabled bool
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    Type string
    (String) The type of the provider type.
    UpdatedAt string
    (String) The time when the resource was updated.
    Attributes map[string]string
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    CreatedAt string
    (String) The time when the resource was created.
    DataType string
    (String) The format of the results that a provider supports.
    Description string
    (String) The provider type description.
    Icon string
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    Id string
    (String) The unique identifier of the provider type.
    InstanceId string
    InstanceLimit float64
    (Integer) The maximum number of instances that can be created for the provider type.
    Labels []GetSccProviderTypeLabel
    (List) The label that is associated with the provider type. Nested schema for label:
    Mode string
    (String) The mode that is used to get results from provider (PUSH or PULL).
    Name string
    (String) The name of the provider type.
    ProviderTypeId string
    S2sEnabled bool
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    Type string
    (String) The type of the provider type.
    UpdatedAt string
    (String) The time when the resource was updated.
    attributes Map<String,String>
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    createdAt String
    (String) The time when the resource was created.
    dataType String
    (String) The format of the results that a provider supports.
    description String
    (String) The provider type description.
    icon String
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    id String
    (String) The unique identifier of the provider type.
    instanceId String
    instanceLimit Double
    (Integer) The maximum number of instances that can be created for the provider type.
    labels List<GetSccProviderTypeLabel>
    (List) The label that is associated with the provider type. Nested schema for label:
    mode String
    (String) The mode that is used to get results from provider (PUSH or PULL).
    name String
    (String) The name of the provider type.
    providerTypeId String
    s2sEnabled Boolean
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    type String
    (String) The type of the provider type.
    updatedAt String
    (String) The time when the resource was updated.
    attributes {[key: string]: string}
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    createdAt string
    (String) The time when the resource was created.
    dataType string
    (String) The format of the results that a provider supports.
    description string
    (String) The provider type description.
    icon string
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    id string
    (String) The unique identifier of the provider type.
    instanceId string
    instanceLimit number
    (Integer) The maximum number of instances that can be created for the provider type.
    labels GetSccProviderTypeLabel[]
    (List) The label that is associated with the provider type. Nested schema for label:
    mode string
    (String) The mode that is used to get results from provider (PUSH or PULL).
    name string
    (String) The name of the provider type.
    providerTypeId string
    s2sEnabled boolean
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    type string
    (String) The type of the provider type.
    updatedAt string
    (String) The time when the resource was updated.
    attributes Mapping[str, str]
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    created_at str
    (String) The time when the resource was created.
    data_type str
    (String) The format of the results that a provider supports.
    description str
    (String) The provider type description.
    icon str
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    id str
    (String) The unique identifier of the provider type.
    instance_id str
    instance_limit float
    (Integer) The maximum number of instances that can be created for the provider type.
    labels Sequence[GetSccProviderTypeLabel]
    (List) The label that is associated with the provider type. Nested schema for label:
    mode str
    (String) The mode that is used to get results from provider (PUSH or PULL).
    name str
    (String) The name of the provider type.
    provider_type_id str
    s2s_enabled bool
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    type str
    (String) The type of the provider type.
    updated_at str
    (String) The time when the resource was updated.
    attributes Map<String>
    (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, {type:"", display_name:""}. NOTE; If the provider type is s2s-enabled, which means that if the s2s_enabled field is set to true, then a CRN field of type text is required in the attributes value object.
    createdAt String
    (String) The time when the resource was created.
    dataType String
    (String) The format of the results that a provider supports.
    description String
    (String) The provider type description.
    icon String
    (String) The icon of a provider in .svg format that is encoded as a base64 string.
    id String
    (String) The unique identifier of the provider type.
    instanceId String
    instanceLimit Number
    (Integer) The maximum number of instances that can be created for the provider type.
    labels List<Property Map>
    (List) The label that is associated with the provider type. Nested schema for label:
    mode String
    (String) The mode that is used to get results from provider (PUSH or PULL).
    name String
    (String) The name of the provider type.
    providerTypeId String
    s2sEnabled Boolean
    (Boolean) A boolean that indicates whether the provider type is s2s-enabled.
    type String
    (String) The type of the provider type.
    updatedAt String
    (String) The time when the resource was updated.

    Supporting Types

    GetSccProviderTypeLabel

    Text string
    (String) The text of the label.
    Tip string
    (String) The text to be shown when user hover overs the label.
    Text string
    (String) The text of the label.
    Tip string
    (String) The text to be shown when user hover overs the label.
    text String
    (String) The text of the label.
    tip String
    (String) The text to be shown when user hover overs the label.
    text string
    (String) The text of the label.
    tip string
    (String) The text to be shown when user hover overs the label.
    text str
    (String) The text of the label.
    tip str
    (String) The text to be shown when user hover overs the label.
    text String
    (String) The text of the label.
    tip String
    (String) The text to be shown when user hover overs the label.

    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