ibm.Provider
Explore with Pulumi AI
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:
- Bluemix
Api stringKey - The Bluemix API Key
- Bluemix
Timeout double - The timeout (in seconds) to set for any Bluemix API calls made.
- Endpoints
File stringPath - Path of the file that contains private and public regional endpoints mapping
- Function
Namespace string - The IBM Cloud Function namespace
- Generation double
- Generation of Virtual Private Cloud. Default is 2
- Iaas
Classic stringApi Key - The Classic Infrastructure API Key
- Iaas
Classic stringEndpoint Url - The Classic Infrastructure Endpoint
- Iaas
Classic doubleTimeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- Iaas
Classic stringUsername - The Classic Infrastructure API user name
- Iam
Profile stringId - IAM Trusted Profile Authentication token
- Iam
Refresh stringToken - IAM Authentication refresh token
- Iam
Token string - IAM Authentication token
- Ibmcloud
Api stringKey - The IBM Cloud API Key
- Ibmcloud
Timeout double - The timeout (in seconds) to set for any IBM Cloud API calls made.
- Max
Retries double - The retry count to set for API calls.
- Private
Endpoint stringType - Private Endpoint type used by the service endpoints. Example: vpe.
- Region string
- The IBM cloud Region (for example 'us-south').
- Resource
Group string - The Resource group id.
- Riaas
Endpoint string - The next generation infrastructure service endpoint url.
- Softlayer
Api stringKey - The SoftLayer API Key
- Softlayer
Endpoint stringUrl - The Softlayer Endpoint
- Softlayer
Timeout double - The timeout (in seconds) to set for any SoftLayer API calls made.
- Softlayer
Username string - The SoftLayer user name
- 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 stringKey - The Bluemix API Key
- Bluemix
Timeout float64 - The timeout (in seconds) to set for any Bluemix API calls made.
- Endpoints
File stringPath - Path of the file that contains private and public regional endpoints mapping
- Function
Namespace string - The IBM Cloud Function namespace
- Generation float64
- Generation of Virtual Private Cloud. Default is 2
- Iaas
Classic stringApi Key - The Classic Infrastructure API Key
- Iaas
Classic stringEndpoint Url - The Classic Infrastructure Endpoint
- Iaas
Classic float64Timeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- Iaas
Classic stringUsername - The Classic Infrastructure API user name
- Iam
Profile stringId - IAM Trusted Profile Authentication token
- Iam
Refresh stringToken - IAM Authentication refresh token
- Iam
Token string - IAM Authentication token
- Ibmcloud
Api stringKey - The IBM Cloud API Key
- Ibmcloud
Timeout float64 - The timeout (in seconds) to set for any IBM Cloud API calls made.
- Max
Retries float64 - The retry count to set for API calls.
- Private
Endpoint stringType - Private Endpoint type used by the service endpoints. Example: vpe.
- Region string
- The IBM cloud Region (for example 'us-south').
- Resource
Group string - The Resource group id.
- Riaas
Endpoint string - The next generation infrastructure service endpoint url.
- Softlayer
Api stringKey - The SoftLayer API Key
- Softlayer
Endpoint stringUrl - The Softlayer Endpoint
- Softlayer
Timeout float64 - The timeout (in seconds) to set for any SoftLayer API calls made.
- Softlayer
Username string - The SoftLayer user name
- 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 StringKey - The Bluemix API Key
- bluemix
Timeout Double - The timeout (in seconds) to set for any Bluemix API calls made.
- endpoints
File StringPath - Path of the file that contains private and public regional endpoints mapping
- function
Namespace String - The IBM Cloud Function namespace
- generation Double
- Generation of Virtual Private Cloud. Default is 2
- iaas
Classic StringApi Key - The Classic Infrastructure API Key
- iaas
Classic StringEndpoint Url - The Classic Infrastructure Endpoint
- iaas
Classic DoubleTimeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- iaas
Classic StringUsername - The Classic Infrastructure API user name
- iam
Profile StringId - IAM Trusted Profile Authentication token
- iam
Refresh StringToken - IAM Authentication refresh token
- iam
Token String - IAM Authentication token
- ibmcloud
Api StringKey - The IBM Cloud API Key
- ibmcloud
Timeout Double - The timeout (in seconds) to set for any IBM Cloud API calls made.
- max
Retries Double - The retry count to set for API calls.
- private
Endpoint StringType - Private Endpoint type used by the service endpoints. Example: vpe.
- region String
- The IBM cloud Region (for example 'us-south').
- resource
Group String - The Resource group id.
- riaas
Endpoint String - The next generation infrastructure service endpoint url.
- softlayer
Api StringKey - The SoftLayer API Key
- softlayer
Endpoint StringUrl - The Softlayer Endpoint
- softlayer
Timeout Double - The timeout (in seconds) to set for any SoftLayer API calls made.
- softlayer
Username String - The SoftLayer user name
- 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 stringKey - The Bluemix API Key
- bluemix
Timeout number - The timeout (in seconds) to set for any Bluemix API calls made.
- endpoints
File stringPath - Path of the file that contains private and public regional endpoints mapping
- function
Namespace string - The IBM Cloud Function namespace
- generation number
- Generation of Virtual Private Cloud. Default is 2
- iaas
Classic stringApi Key - The Classic Infrastructure API Key
- iaas
Classic stringEndpoint Url - The Classic Infrastructure Endpoint
- iaas
Classic numberTimeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- iaas
Classic stringUsername - The Classic Infrastructure API user name
- iam
Profile stringId - IAM Trusted Profile Authentication token
- iam
Refresh stringToken - IAM Authentication refresh token
- iam
Token string - IAM Authentication token
- ibmcloud
Api stringKey - The IBM Cloud API Key
- ibmcloud
Timeout number - The timeout (in seconds) to set for any IBM Cloud API calls made.
- max
Retries number - The retry count to set for API calls.
- private
Endpoint stringType - Private Endpoint type used by the service endpoints. Example: vpe.
- region string
- The IBM cloud Region (for example 'us-south').
- resource
Group string - The Resource group id.
- riaas
Endpoint string - The next generation infrastructure service endpoint url.
- softlayer
Api stringKey - The SoftLayer API Key
- softlayer
Endpoint stringUrl - The Softlayer Endpoint
- softlayer
Timeout number - The timeout (in seconds) to set for any SoftLayer API calls made.
- softlayer
Username string - The SoftLayer user name
- 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_ strkey - The Bluemix API Key
- bluemix_
timeout float - The timeout (in seconds) to set for any Bluemix API calls made.
- endpoints_
file_ strpath - Path of the file that contains private and public regional endpoints mapping
- function_
namespace str - The IBM Cloud Function namespace
- generation float
- Generation of Virtual Private Cloud. Default is 2
- iaas_
classic_ strapi_ key - The Classic Infrastructure API Key
- iaas_
classic_ strendpoint_ url - The Classic Infrastructure Endpoint
- iaas_
classic_ floattimeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- iaas_
classic_ strusername - The Classic Infrastructure API user name
- iam_
profile_ strid - IAM Trusted Profile Authentication token
- iam_
refresh_ strtoken - IAM Authentication refresh token
- iam_
token str - IAM Authentication token
- ibmcloud_
api_ strkey - 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_ strtype - 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.
- softlayer_
api_ strkey - The SoftLayer API Key
- softlayer_
endpoint_ strurl - The Softlayer Endpoint
- softlayer_
timeout float - The timeout (in seconds) to set for any SoftLayer API calls made.
- softlayer_
username str - The SoftLayer user name
- 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.
- bluemix
Api StringKey - The Bluemix API Key
- bluemix
Timeout Number - The timeout (in seconds) to set for any Bluemix API calls made.
- endpoints
File StringPath - Path of the file that contains private and public regional endpoints mapping
- function
Namespace String - The IBM Cloud Function namespace
- generation Number
- Generation of Virtual Private Cloud. Default is 2
- iaas
Classic StringApi Key - The Classic Infrastructure API Key
- iaas
Classic StringEndpoint Url - The Classic Infrastructure Endpoint
- iaas
Classic NumberTimeout - The timeout (in seconds) to set for any Classic Infrastructure API calls made.
- iaas
Classic StringUsername - The Classic Infrastructure API user name
- iam
Profile StringId - IAM Trusted Profile Authentication token
- iam
Refresh StringToken - IAM Authentication refresh token
- iam
Token String - IAM Authentication token
- ibmcloud
Api StringKey - The IBM Cloud API Key
- ibmcloud
Timeout Number - The timeout (in seconds) to set for any IBM Cloud API calls made.
- max
Retries Number - The retry count to set for API calls.
- private
Endpoint StringType - Private Endpoint type used by the service endpoints. Example: vpe.
- region String
- The IBM cloud Region (for example 'us-south').
- resource
Group String - The Resource group id.
- riaas
Endpoint String - The next generation infrastructure service endpoint url.
- softlayer
Api StringKey - The SoftLayer API Key
- softlayer
Endpoint StringUrl - The Softlayer Endpoint
- softlayer
Timeout Number - The timeout (in seconds) to set for any SoftLayer API calls made.
- softlayer
Username String - The SoftLayer user name
- 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.