Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. Provider
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.Provider

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    The provider type for the commercetools 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,
             api_url: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             project_key: Optional[str] = None,
             scopes: Optional[str] = None,
             token_url: 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:commercetools
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:

    ApiUrl string
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    ClientId string
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    ClientSecret string
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    ProjectKey string
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    Scopes string
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    TokenUrl string
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
    ApiUrl string
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    ClientId string
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    ClientSecret string
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    ProjectKey string
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    Scopes string
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    TokenUrl string
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
    apiUrl String
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    clientId String
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    clientSecret String
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    projectKey String
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    scopes String
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    tokenUrl String
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
    apiUrl string
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    clientId string
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    clientSecret string
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    projectKey string
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    scopes string
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    tokenUrl string
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
    api_url str
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    client_id str
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    client_secret str
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    project_key str
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    scopes str
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    token_url str
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization
    apiUrl String
    The API URL of the commercetools platform. https://docs.commercetools.com/api/general-concepts#hosts
    clientId String
    The OAuth Client ID for a commercetools platform project. https://docs.commercetools.com/api/authorization
    clientSecret String
    The OAuth Client Secret for a commercetools platform project. https://docs.commercetools.com/api/authorization
    projectKey String
    The project key of commercetools platform project. https://docs.commercetools.com/getting-started
    scopes String
    A list as string of OAuth scopes assigned to a project key, to access resources in a commercetools platform project. https://docs.commercetools.com/api/authorization
    tokenUrl String
    The authentication URL of the commercetools platform. https://docs.commercetools.com/api/authorization

    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
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools