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

ibm.Provider

Explore with Pulumi AI

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

    The provider type for the ibm package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bluemix_api_key: Optional[str] = None,
                 bluemix_timeout: Optional[float] = None,
                 endpoints_file_path: Optional[str] = None,
                 function_namespace: Optional[str] = None,
                 generation: Optional[float] = None,
                 iaas_classic_api_key: Optional[str] = None,
                 iaas_classic_endpoint_url: Optional[str] = None,
                 iaas_classic_timeout: Optional[float] = None,
                 iaas_classic_username: Optional[str] = None,
                 iam_profile_id: Optional[str] = None,
                 iam_refresh_token: Optional[str] = None,
                 iam_token: Optional[str] = None,
                 ibmcloud_api_key: Optional[str] = None,
                 ibmcloud_timeout: Optional[float] = None,
                 max_retries: Optional[float] = None,
                 private_endpoint_type: Optional[str] = None,
                 region: Optional[str] = None,
                 resource_group: Optional[str] = None,
                 riaas_endpoint: Optional[str] = None,
                 softlayer_api_key: Optional[str] = None,
                 softlayer_endpoint_url: Optional[str] = None,
                 softlayer_timeout: Optional[float] = None,
                 softlayer_username: Optional[str] = None,
                 visibility: Optional[str] = None,
                 zone: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:ibm
    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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    BluemixApiKey string
    The Bluemix API Key

    Deprecated: Deprecated

    BluemixTimeout double
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    EndpointsFilePath string
    Path of the file that contains private and public regional endpoints mapping
    FunctionNamespace string
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    Generation double
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    IaasClassicApiKey string
    The Classic Infrastructure API Key
    IaasClassicEndpointUrl string
    The Classic Infrastructure Endpoint
    IaasClassicTimeout double
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    IaasClassicUsername string
    The Classic Infrastructure API user name
    IamProfileId string
    IAM Trusted Profile Authentication token
    IamRefreshToken string
    IAM Authentication refresh token
    IamToken string
    IAM Authentication token
    IbmcloudApiKey string
    The IBM Cloud API Key
    IbmcloudTimeout double
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    MaxRetries double
    The retry count to set for API calls.
    PrivateEndpointType string
    Private Endpoint type used by the service endpoints. Example: vpe.
    Region string
    The IBM cloud Region (for example 'us-south').
    ResourceGroup string
    The Resource group id.
    RiaasEndpoint string
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    SoftlayerApiKey string
    The SoftLayer API Key

    Deprecated: Deprecated

    SoftlayerEndpointUrl string
    The Softlayer Endpoint

    Deprecated: Deprecated

    SoftlayerTimeout double
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    SoftlayerUsername string
    The SoftLayer user name

    Deprecated: Deprecated

    Visibility string
    Visibility of the provider if it is private or public.
    Zone string
    The IBM cloud Region zone (for example 'us-south-1') for power resources.
    BluemixApiKey string
    The Bluemix API Key

    Deprecated: Deprecated

    BluemixTimeout float64
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    EndpointsFilePath string
    Path of the file that contains private and public regional endpoints mapping
    FunctionNamespace string
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    Generation float64
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    IaasClassicApiKey string
    The Classic Infrastructure API Key
    IaasClassicEndpointUrl string
    The Classic Infrastructure Endpoint
    IaasClassicTimeout float64
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    IaasClassicUsername string
    The Classic Infrastructure API user name
    IamProfileId string
    IAM Trusted Profile Authentication token
    IamRefreshToken string
    IAM Authentication refresh token
    IamToken string
    IAM Authentication token
    IbmcloudApiKey string
    The IBM Cloud API Key
    IbmcloudTimeout float64
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    MaxRetries float64
    The retry count to set for API calls.
    PrivateEndpointType string
    Private Endpoint type used by the service endpoints. Example: vpe.
    Region string
    The IBM cloud Region (for example 'us-south').
    ResourceGroup string
    The Resource group id.
    RiaasEndpoint string
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    SoftlayerApiKey string
    The SoftLayer API Key

    Deprecated: Deprecated

    SoftlayerEndpointUrl string
    The Softlayer Endpoint

    Deprecated: Deprecated

    SoftlayerTimeout float64
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    SoftlayerUsername string
    The SoftLayer user name

    Deprecated: Deprecated

    Visibility string
    Visibility of the provider if it is private or public.
    Zone string
    The IBM cloud Region zone (for example 'us-south-1') for power resources.
    bluemixApiKey String
    The Bluemix API Key

    Deprecated: Deprecated

    bluemixTimeout Double
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    endpointsFilePath String
    Path of the file that contains private and public regional endpoints mapping
    functionNamespace String
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    generation Double
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    iaasClassicApiKey String
    The Classic Infrastructure API Key
    iaasClassicEndpointUrl String
    The Classic Infrastructure Endpoint
    iaasClassicTimeout Double
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    iaasClassicUsername String
    The Classic Infrastructure API user name
    iamProfileId String
    IAM Trusted Profile Authentication token
    iamRefreshToken String
    IAM Authentication refresh token
    iamToken String
    IAM Authentication token
    ibmcloudApiKey String
    The IBM Cloud API Key
    ibmcloudTimeout Double
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    maxRetries Double
    The retry count to set for API calls.
    privateEndpointType String
    Private Endpoint type used by the service endpoints. Example: vpe.
    region String
    The IBM cloud Region (for example 'us-south').
    resourceGroup String
    The Resource group id.
    riaasEndpoint String
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    softlayerApiKey String
    The SoftLayer API Key

    Deprecated: Deprecated

    softlayerEndpointUrl String
    The Softlayer Endpoint

    Deprecated: Deprecated

    softlayerTimeout Double
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    softlayerUsername String
    The SoftLayer user name

    Deprecated: Deprecated

    visibility String
    Visibility of the provider if it is private or public.
    zone String
    The IBM cloud Region zone (for example 'us-south-1') for power resources.
    bluemixApiKey string
    The Bluemix API Key

    Deprecated: Deprecated

    bluemixTimeout number
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    endpointsFilePath string
    Path of the file that contains private and public regional endpoints mapping
    functionNamespace string
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    generation number
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    iaasClassicApiKey string
    The Classic Infrastructure API Key
    iaasClassicEndpointUrl string
    The Classic Infrastructure Endpoint
    iaasClassicTimeout number
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    iaasClassicUsername string
    The Classic Infrastructure API user name
    iamProfileId string
    IAM Trusted Profile Authentication token
    iamRefreshToken string
    IAM Authentication refresh token
    iamToken string
    IAM Authentication token
    ibmcloudApiKey string
    The IBM Cloud API Key
    ibmcloudTimeout number
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    maxRetries number
    The retry count to set for API calls.
    privateEndpointType string
    Private Endpoint type used by the service endpoints. Example: vpe.
    region string
    The IBM cloud Region (for example 'us-south').
    resourceGroup string
    The Resource group id.
    riaasEndpoint string
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    softlayerApiKey string
    The SoftLayer API Key

    Deprecated: Deprecated

    softlayerEndpointUrl string
    The Softlayer Endpoint

    Deprecated: Deprecated

    softlayerTimeout number
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    softlayerUsername string
    The SoftLayer user name

    Deprecated: Deprecated

    visibility string
    Visibility of the provider if it is private or public.
    zone string
    The IBM cloud Region zone (for example 'us-south-1') for power resources.
    bluemix_api_key str
    The Bluemix API Key

    Deprecated: Deprecated

    bluemix_timeout float
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    endpoints_file_path str
    Path of the file that contains private and public regional endpoints mapping
    function_namespace str
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    generation float
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    iaas_classic_api_key str
    The Classic Infrastructure API Key
    iaas_classic_endpoint_url str
    The Classic Infrastructure Endpoint
    iaas_classic_timeout float
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    iaas_classic_username str
    The Classic Infrastructure API user name
    iam_profile_id str
    IAM Trusted Profile Authentication token
    iam_refresh_token str
    IAM Authentication refresh token
    iam_token str
    IAM Authentication token
    ibmcloud_api_key str
    The IBM Cloud API Key
    ibmcloud_timeout float
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    max_retries float
    The retry count to set for API calls.
    private_endpoint_type str
    Private Endpoint type used by the service endpoints. Example: vpe.
    region str
    The IBM cloud Region (for example 'us-south').
    resource_group str
    The Resource group id.
    riaas_endpoint str
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    softlayer_api_key str
    The SoftLayer API Key

    Deprecated: Deprecated

    softlayer_endpoint_url str
    The Softlayer Endpoint

    Deprecated: Deprecated

    softlayer_timeout float
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    softlayer_username str
    The SoftLayer user name

    Deprecated: Deprecated

    visibility str
    Visibility of the provider if it is private or public.
    zone str
    The IBM cloud Region zone (for example 'us-south-1') for power resources.
    bluemixApiKey String
    The Bluemix API Key

    Deprecated: Deprecated

    bluemixTimeout Number
    The timeout (in seconds) to set for any Bluemix API calls made.

    Deprecated: Deprecated

    endpointsFilePath String
    Path of the file that contains private and public regional endpoints mapping
    functionNamespace String
    The IBM Cloud Function namespace

    Deprecated: Deprecated

    generation Number
    Generation of Virtual Private Cloud. Default is 2

    Deprecated: Deprecated

    iaasClassicApiKey String
    The Classic Infrastructure API Key
    iaasClassicEndpointUrl String
    The Classic Infrastructure Endpoint
    iaasClassicTimeout Number
    The timeout (in seconds) to set for any Classic Infrastructure API calls made.
    iaasClassicUsername String
    The Classic Infrastructure API user name
    iamProfileId String
    IAM Trusted Profile Authentication token
    iamRefreshToken String
    IAM Authentication refresh token
    iamToken String
    IAM Authentication token
    ibmcloudApiKey String
    The IBM Cloud API Key
    ibmcloudTimeout Number
    The timeout (in seconds) to set for any IBM Cloud API calls made.
    maxRetries Number
    The retry count to set for API calls.
    privateEndpointType String
    Private Endpoint type used by the service endpoints. Example: vpe.
    region String
    The IBM cloud Region (for example 'us-south').
    resourceGroup String
    The Resource group id.
    riaasEndpoint String
    The next generation infrastructure service endpoint url.

    Deprecated: Deprecated

    softlayerApiKey String
    The SoftLayer API Key

    Deprecated: Deprecated

    softlayerEndpointUrl String
    The Softlayer Endpoint

    Deprecated: Deprecated

    softlayerTimeout Number
    The timeout (in seconds) to set for any SoftLayer API calls made.

    Deprecated: Deprecated

    softlayerUsername String
    The SoftLayer user name

    Deprecated: Deprecated

    visibility String
    Visibility of the provider if it is private or public.
    zone String
    The IBM cloud Region zone (for example 'us-south-1') for power resources.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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