Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nexus Provider
  3. API Docs
  4. RepositoryNpmHosted
nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers
datadrivers/terraform-provider-nexus

nexus.RepositoryNpmHosted

Explore with Pulumi AI

nexus logo
nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers
datadrivers/terraform-provider-nexus

    Use this resource to create a hosted Npm repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nexus from "@pulumi/nexus";

const npm = new nexus.RepositoryNpmHosted("npm", {});
const npm1 = new nexus.RepositoryNpmHosted("npm1", {
    cleanups: [{
        policyNames: ["policy"],
    }],
    online: true,
    storage: {
        blobStoreName: "default",
        strictContentTypeValidation: true,
        writePolicy: "ALLOW",
    },
});

    import pulumi
import pulumi_nexus as nexus

npm = nexus.RepositoryNpmHosted("npm")
npm1 = nexus.RepositoryNpmHosted("npm1",
    cleanups=[{
        "policy_names": ["policy"],
    }],
    online=True,
    storage={
        "blob_store_name": "default",
        "strict_content_type_validation": True,
        "write_policy": "ALLOW",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nexus/v2/nexus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nexus.NewRepositoryNpmHosted(ctx, "npm", nil)
		if err != nil {
			return err
		}
		_, err = nexus.NewRepositoryNpmHosted(ctx, "npm1", &nexus.RepositoryNpmHostedArgs{
			Cleanups: nexus.RepositoryNpmHostedCleanupArray{
				&nexus.RepositoryNpmHostedCleanupArgs{
					PolicyNames: pulumi.StringArray{
						pulumi.String("policy"),
					},
				},
			},
			Online: pulumi.Bool(true),
			Storage: &nexus.RepositoryNpmHostedStorageArgs{
				BlobStoreName:               pulumi.String("default"),
				StrictContentTypeValidation: pulumi.Bool(true),
				WritePolicy:                 pulumi.String("ALLOW"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nexus = Pulumi.Nexus;

return await Deployment.RunAsync(() => 
{
    var npm = new Nexus.RepositoryNpmHosted("npm");

    var npm1 = new Nexus.RepositoryNpmHosted("npm1", new()
    {
        Cleanups = new[]
        {
            new Nexus.Inputs.RepositoryNpmHostedCleanupArgs
            {
                PolicyNames = new[]
                {
                    "policy",
                },
            },
        },
        Online = true,
        Storage = new Nexus.Inputs.RepositoryNpmHostedStorageArgs
        {
            BlobStoreName = "default",
            StrictContentTypeValidation = true,
            WritePolicy = "ALLOW",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nexus.RepositoryNpmHosted;
import com.pulumi.nexus.RepositoryNpmHostedArgs;
import com.pulumi.nexus.inputs.RepositoryNpmHostedCleanupArgs;
import com.pulumi.nexus.inputs.RepositoryNpmHostedStorageArgs;
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) {
        var npm = new RepositoryNpmHosted("npm");

        var npm1 = new RepositoryNpmHosted("npm1", RepositoryNpmHostedArgs.builder()
            .cleanups(RepositoryNpmHostedCleanupArgs.builder()
                .policyNames("policy")
                .build())
            .online(true)
            .storage(RepositoryNpmHostedStorageArgs.builder()
                .blobStoreName("default")
                .strictContentTypeValidation(true)
                .writePolicy("ALLOW")
                .build())
            .build());

    }
}

    resources:
  npm:
    type: nexus:RepositoryNpmHosted
  npm1:
    type: nexus:RepositoryNpmHosted
    properties:
      cleanups:
        - policyNames:
            - policy
      online: true
      storage:
        blobStoreName: default
        strictContentTypeValidation: true
        writePolicy: ALLOW

    Create RepositoryNpmHosted Resource

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

    Constructor syntax

    new RepositoryNpmHosted(name: string, args: RepositoryNpmHostedArgs, opts?: CustomResourceOptions);
    @overload
def RepositoryNpmHosted(resource_name: str,
                        args: RepositoryNpmHostedArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def RepositoryNpmHosted(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        storage: Optional[RepositoryNpmHostedStorageArgs] = None,
                        cleanups: Optional[Sequence[RepositoryNpmHostedCleanupArgs]] = None,
                        component: Optional[RepositoryNpmHostedComponentArgs] = None,
                        name: Optional[str] = None,
                        online: Optional[bool] = None)
    func NewRepositoryNpmHosted(ctx *Context, name string, args RepositoryNpmHostedArgs, opts ...ResourceOption) (*RepositoryNpmHosted, error)
    public RepositoryNpmHosted(string name, RepositoryNpmHostedArgs args, CustomResourceOptions? opts = null)
    public RepositoryNpmHosted(String name, RepositoryNpmHostedArgs args)
public RepositoryNpmHosted(String name, RepositoryNpmHostedArgs args, CustomResourceOptions options)

    type: nexus:RepositoryNpmHosted
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 RepositoryNpmHostedArgs
    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 RepositoryNpmHostedArgs
    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 RepositoryNpmHostedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RepositoryNpmHostedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RepositoryNpmHostedArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var repositoryNpmHostedResource = new Nexus.RepositoryNpmHosted("repositoryNpmHostedResource", new()
{
    Storage = new Nexus.Inputs.RepositoryNpmHostedStorageArgs
    {
        BlobStoreName = "string",
        StrictContentTypeValidation = false,
        WritePolicy = "string",
    },
    Cleanups = new[]
    {
        new Nexus.Inputs.RepositoryNpmHostedCleanupArgs
        {
            PolicyNames = new[]
            {
                "string",
            },
        },
    },
    Component = new Nexus.Inputs.RepositoryNpmHostedComponentArgs
    {
        ProprietaryComponents = false,
    },
    Name = "string",
    Online = false,
});

    example, err := nexus.NewRepositoryNpmHosted(ctx, "repositoryNpmHostedResource", &nexus.RepositoryNpmHostedArgs{
	Storage: &nexus.RepositoryNpmHostedStorageArgs{
		BlobStoreName:               pulumi.String("string"),
		StrictContentTypeValidation: pulumi.Bool(false),
		WritePolicy:                 pulumi.String("string"),
	},
	Cleanups: nexus.RepositoryNpmHostedCleanupArray{
		&nexus.RepositoryNpmHostedCleanupArgs{
			PolicyNames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Component: &nexus.RepositoryNpmHostedComponentArgs{
		ProprietaryComponents: pulumi.Bool(false),
	},
	Name:   pulumi.String("string"),
	Online: pulumi.Bool(false),
})

    var repositoryNpmHostedResource = new RepositoryNpmHosted("repositoryNpmHostedResource", RepositoryNpmHostedArgs.builder()
    .storage(RepositoryNpmHostedStorageArgs.builder()
        .blobStoreName("string")
        .strictContentTypeValidation(false)
        .writePolicy("string")
        .build())
    .cleanups(RepositoryNpmHostedCleanupArgs.builder()
        .policyNames("string")
        .build())
    .component(RepositoryNpmHostedComponentArgs.builder()
        .proprietaryComponents(false)
        .build())
    .name("string")
    .online(false)
    .build());

    repository_npm_hosted_resource = nexus.RepositoryNpmHosted("repositoryNpmHostedResource",
    storage={
        "blob_store_name": "string",
        "strict_content_type_validation": False,
        "write_policy": "string",
    },
    cleanups=[{
        "policy_names": ["string"],
    }],
    component={
        "proprietary_components": False,
    },
    name="string",
    online=False)

    const repositoryNpmHostedResource = new nexus.RepositoryNpmHosted("repositoryNpmHostedResource", {
    storage: {
        blobStoreName: "string",
        strictContentTypeValidation: false,
        writePolicy: "string",
    },
    cleanups: [{
        policyNames: ["string"],
    }],
    component: {
        proprietaryComponents: false,
    },
    name: "string",
    online: false,
});

    type: nexus:RepositoryNpmHosted
properties:
    cleanups:
        - policyNames:
            - string
    component:
        proprietaryComponents: false
    name: string
    online: false
    storage:
        blobStoreName: string
        strictContentTypeValidation: false
        writePolicy: string

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

    Storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    Cleanups List<RepositoryNpmHostedCleanup>
    Cleanup policies
    Component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    Name string
    A unique identifier for this repository
    Online bool
    Whether this repository accepts incoming requests
    Storage RepositoryNpmHostedStorageArgs
    The storage configuration of the repository
    Cleanups []RepositoryNpmHostedCleanupArgs
    Cleanup policies
    Component RepositoryNpmHostedComponentArgs
    Component configuration for the hosted repository
    Name string
    A unique identifier for this repository
    Online bool
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    cleanups List<RepositoryNpmHostedCleanup>
    Cleanup policies
    component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    name String
    A unique identifier for this repository
    online Boolean
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    cleanups RepositoryNpmHostedCleanup[]
    Cleanup policies
    component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    name string
    A unique identifier for this repository
    online boolean
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorageArgs
    The storage configuration of the repository
    cleanups Sequence[RepositoryNpmHostedCleanupArgs]
    Cleanup policies
    component RepositoryNpmHostedComponentArgs
    Component configuration for the hosted repository
    name str
    A unique identifier for this repository
    online bool
    Whether this repository accepts incoming requests
    storage Property Map
    The storage configuration of the repository
    cleanups List<Property Map>
    Cleanup policies
    component Property Map
    Component configuration for the hosted repository
    name String
    A unique identifier for this repository
    online Boolean
    Whether this repository accepts incoming requests

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RepositoryNpmHosted 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.

    Look up Existing RepositoryNpmHosted Resource

    Get an existing RepositoryNpmHosted resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RepositoryNpmHostedState, opts?: CustomResourceOptions): RepositoryNpmHosted
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cleanups: Optional[Sequence[RepositoryNpmHostedCleanupArgs]] = None,
        component: Optional[RepositoryNpmHostedComponentArgs] = None,
        name: Optional[str] = None,
        online: Optional[bool] = None,
        storage: Optional[RepositoryNpmHostedStorageArgs] = None) -> RepositoryNpmHosted
    func GetRepositoryNpmHosted(ctx *Context, name string, id IDInput, state *RepositoryNpmHostedState, opts ...ResourceOption) (*RepositoryNpmHosted, error)
    public static RepositoryNpmHosted Get(string name, Input<string> id, RepositoryNpmHostedState? state, CustomResourceOptions? opts = null)
    public static RepositoryNpmHosted get(String name, Output<String> id, RepositoryNpmHostedState state, CustomResourceOptions options)
    resources:  _:    type: nexus:RepositoryNpmHosted    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Cleanups List<RepositoryNpmHostedCleanup>
    Cleanup policies
    Component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    Name string
    A unique identifier for this repository
    Online bool
    Whether this repository accepts incoming requests
    Storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    Cleanups []RepositoryNpmHostedCleanupArgs
    Cleanup policies
    Component RepositoryNpmHostedComponentArgs
    Component configuration for the hosted repository
    Name string
    A unique identifier for this repository
    Online bool
    Whether this repository accepts incoming requests
    Storage RepositoryNpmHostedStorageArgs
    The storage configuration of the repository
    cleanups List<RepositoryNpmHostedCleanup>
    Cleanup policies
    component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    name String
    A unique identifier for this repository
    online Boolean
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    cleanups RepositoryNpmHostedCleanup[]
    Cleanup policies
    component RepositoryNpmHostedComponent
    Component configuration for the hosted repository
    name string
    A unique identifier for this repository
    online boolean
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorage
    The storage configuration of the repository
    cleanups Sequence[RepositoryNpmHostedCleanupArgs]
    Cleanup policies
    component RepositoryNpmHostedComponentArgs
    Component configuration for the hosted repository
    name str
    A unique identifier for this repository
    online bool
    Whether this repository accepts incoming requests
    storage RepositoryNpmHostedStorageArgs
    The storage configuration of the repository
    cleanups List<Property Map>
    Cleanup policies
    component Property Map
    Component configuration for the hosted repository
    name String
    A unique identifier for this repository
    online Boolean
    Whether this repository accepts incoming requests
    storage Property Map
    The storage configuration of the repository

    Supporting Types

    RepositoryNpmHostedCleanup, RepositoryNpmHostedCleanupArgs

    PolicyNames List<string>
    List of policy names
    PolicyNames []string
    List of policy names
    policyNames List<String>
    List of policy names
    policyNames string[]
    List of policy names
    policy_names Sequence[str]
    List of policy names
    policyNames List<String>
    List of policy names

    RepositoryNpmHostedComponent, RepositoryNpmHostedComponentArgs

    ProprietaryComponents bool
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)
    ProprietaryComponents bool
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)
    proprietaryComponents Boolean
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)
    proprietaryComponents boolean
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)
    proprietary_components bool
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)
    proprietaryComponents Boolean
    Components in this repository count as proprietary for namespace conflict attacks (requires Sonatype Nexus Firewall)

    RepositoryNpmHostedStorage, RepositoryNpmHostedStorageArgs

    BlobStoreName string
    Blob store used to store repository contents
    StrictContentTypeValidation bool
    Whether to validate uploaded content's MIME type appropriate for the repository format
    WritePolicy string
    Controls if deployments of and updates to assets are allowed
    BlobStoreName string
    Blob store used to store repository contents
    StrictContentTypeValidation bool
    Whether to validate uploaded content's MIME type appropriate for the repository format
    WritePolicy string
    Controls if deployments of and updates to assets are allowed
    blobStoreName String
    Blob store used to store repository contents
    strictContentTypeValidation Boolean
    Whether to validate uploaded content's MIME type appropriate for the repository format
    writePolicy String
    Controls if deployments of and updates to assets are allowed
    blobStoreName string
    Blob store used to store repository contents
    strictContentTypeValidation boolean
    Whether to validate uploaded content's MIME type appropriate for the repository format
    writePolicy string
    Controls if deployments of and updates to assets are allowed
    blob_store_name str
    Blob store used to store repository contents
    strict_content_type_validation bool
    Whether to validate uploaded content's MIME type appropriate for the repository format
    write_policy str
    Controls if deployments of and updates to assets are allowed
    blobStoreName String
    Blob store used to store repository contents
    strictContentTypeValidation Boolean
    Whether to validate uploaded content's MIME type appropriate for the repository format
    writePolicy String
    Controls if deployments of and updates to assets are allowed

    Import

    import using the name of repository

    $ pulumi import nexus:index/repositoryNpmHosted:RepositoryNpmHosted npm npm

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    nexus datadrivers/terraform-provider-nexus
    License
    Notes
    This Pulumi package is based on the nexus Terraform Provider.
    nexus logo
    nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers
    datadrivers/terraform-provider-nexus