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

netlify.Provider

Explore with Pulumi AI

netlify logo
netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify
netlify/terraform-provider-netlify

    The provider type for the netlify 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,
             default_team_id: Optional[str] = None,
             default_team_slug: Optional[str] = None,
             endpoint: Optional[str] = None,
             token: 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:netlify
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:

    DefaultTeamId string
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    DefaultTeamSlug string
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    Endpoint string
    Defaults to: https://api.netlify.com
    Token string
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.
    DefaultTeamId string
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    DefaultTeamSlug string
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    Endpoint string
    Defaults to: https://api.netlify.com
    Token string
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.
    defaultTeamId String
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    defaultTeamSlug String
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    endpoint String
    Defaults to: https://api.netlify.com
    token String
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.
    defaultTeamId string
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    defaultTeamSlug string
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    endpoint string
    Defaults to: https://api.netlify.com
    token string
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.
    default_team_id str
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    default_team_slug str
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    endpoint str
    Defaults to: https://api.netlify.com
    token str
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.
    defaultTeamId String
    The default team ID to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    defaultTeamSlug String
    The default team slug to use for resources that require a team ID or a team slug. Warning: Changing this value may not trigger recreation of resources.
    endpoint String
    Defaults to: https://api.netlify.com
    token String
    Read: https://docs.netlify.com/api/get-started/#authentication , will use the NETLIFY_API_TOKEN environment variable if not set.

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