1. Packages
  2. Packages
  3. Nexus Provider
  4. API Docs
  5. Capability
Viewing docs for nexus 3.0.0
published on Tuesday, Jul 28, 2026 by datadrivers
Viewing docs for nexus 3.0.0
published on Tuesday, Jul 28, 2026 by datadrivers

    Use this resource to manage Nexus capabilities.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nexus from "@pulumi/nexus";
    
    // Manage a Nexus capability
    // Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
    // Example: Repository Firewall Audit Capability
    const firewallAudit = new nexus.Capability("firewall_audit", {
        type: "firewall.audit",
        enabled: true,
        notes: "Firewall audit capability for maven-central repository",
        properties: {
            repository: "maven-central",
            quarantine: "false",
        },
    });
    // Example: Outreach Management Capability
    const outreach = new nexus.Capability("outreach", {
        type: "OutreachManagementCapability",
        enabled: true,
        notes: "Enable outreach management",
        properties: {},
    });
    // Example: HTTP Client Capability
    const httpClient = new nexus.Capability("http_client", {
        type: "httpclient",
        enabled: true,
        notes: "Global HTTP client configuration",
        properties: {
            userAgentCustomisation: "Nexus Repository Manager",
        },
    });
    
    import pulumi
    import pulumi_nexus as nexus
    
    # Manage a Nexus capability
    # Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
    # Example: Repository Firewall Audit Capability
    firewall_audit = nexus.Capability("firewall_audit",
        type="firewall.audit",
        enabled=True,
        notes="Firewall audit capability for maven-central repository",
        properties={
            "repository": "maven-central",
            "quarantine": "false",
        })
    # Example: Outreach Management Capability
    outreach = nexus.Capability("outreach",
        type="OutreachManagementCapability",
        enabled=True,
        notes="Enable outreach management",
        properties={})
    # Example: HTTP Client Capability
    http_client = nexus.Capability("http_client",
        type="httpclient",
        enabled=True,
        notes="Global HTTP client configuration",
        properties={
            "userAgentCustomisation": "Nexus Repository Manager",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nexus/v3/nexus"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Manage a Nexus capability
    		// Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
    		// Example: Repository Firewall Audit Capability
    		_, err := nexus.NewCapability(ctx, "firewall_audit", &nexus.CapabilityArgs{
    			Type:    pulumi.String("firewall.audit"),
    			Enabled: pulumi.Bool(true),
    			Notes:   pulumi.String("Firewall audit capability for maven-central repository"),
    			Properties: pulumi.StringMap{
    				"repository": pulumi.String("maven-central"),
    				"quarantine": pulumi.String("false"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// Example: Outreach Management Capability
    		_, err = nexus.NewCapability(ctx, "outreach", &nexus.CapabilityArgs{
    			Type:       pulumi.String("OutreachManagementCapability"),
    			Enabled:    pulumi.Bool(true),
    			Notes:      pulumi.String("Enable outreach management"),
    			Properties: pulumi.StringMap{},
    		})
    		if err != nil {
    			return err
    		}
    		// Example: HTTP Client Capability
    		_, err = nexus.NewCapability(ctx, "http_client", &nexus.CapabilityArgs{
    			Type:    pulumi.String("httpclient"),
    			Enabled: pulumi.Bool(true),
    			Notes:   pulumi.String("Global HTTP client configuration"),
    			Properties: pulumi.StringMap{
    				"userAgentCustomisation": pulumi.String("Nexus Repository Manager"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nexus = Pulumi.Nexus;
    
    return await Deployment.RunAsync(() => 
    {
        // Manage a Nexus capability
        // Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
        // Example: Repository Firewall Audit Capability
        var firewallAudit = new Nexus.Capability("firewall_audit", new()
        {
            Type = "firewall.audit",
            Enabled = true,
            Notes = "Firewall audit capability for maven-central repository",
            Properties = 
            {
                { "repository", "maven-central" },
                { "quarantine", "false" },
            },
        });
    
        // Example: Outreach Management Capability
        var outreach = new Nexus.Capability("outreach", new()
        {
            Type = "OutreachManagementCapability",
            Enabled = true,
            Notes = "Enable outreach management",
            Properties = null,
        });
    
        // Example: HTTP Client Capability
        var httpClient = new Nexus.Capability("http_client", new()
        {
            Type = "httpclient",
            Enabled = true,
            Notes = "Global HTTP client configuration",
            Properties = 
            {
                { "userAgentCustomisation", "Nexus Repository Manager" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nexus.Capability;
    import com.pulumi.nexus.CapabilityArgs;
    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) {
            // Manage a Nexus capability
            // Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
            // Example: Repository Firewall Audit Capability
            var firewallAudit = new Capability("firewallAudit", CapabilityArgs.builder()
                .type("firewall.audit")
                .enabled(true)
                .notes("Firewall audit capability for maven-central repository")
                .properties(Map.ofEntries(
                    Map.entry("repository", "maven-central"),
                    Map.entry("quarantine", "false")
                ))
                .build());
    
            // Example: Outreach Management Capability
            var outreach = new Capability("outreach", CapabilityArgs.builder()
                .type("OutreachManagementCapability")
                .enabled(true)
                .notes("Enable outreach management")
                .properties(Map.ofEntries(
                ))
                .build());
    
            // Example: HTTP Client Capability
            var httpClient = new Capability("httpClient", CapabilityArgs.builder()
                .type("httpclient")
                .enabled(true)
                .notes("Global HTTP client configuration")
                .properties(Map.of("userAgentCustomisation", "Nexus Repository Manager"))
                .build());
    
        }
    }
    
    resources:
      # Manage a Nexus capability
      # Note: Capabilities API requires Nexus Repository Manager 3.85.0 or later
    
      # Example: Repository Firewall Audit Capability
      firewallAudit:
        type: nexus:Capability
        name: firewall_audit
        properties:
          type: firewall.audit
          enabled: true
          notes: Firewall audit capability for maven-central repository
          properties:
            repository: maven-central
            quarantine: 'false'
      # Example: Outreach Management Capability
      outreach:
        type: nexus:Capability
        properties:
          type: OutreachManagementCapability
          enabled: true
          notes: Enable outreach management
          properties: {}
      # Example: HTTP Client Capability
      httpClient:
        type: nexus:Capability
        name: http_client
        properties:
          type: httpclient
          enabled: true
          notes: Global HTTP client configuration
          properties:
            userAgentCustomisation: Nexus Repository Manager
    
    Example coming soon!
    

    Create Capability Resource

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

    Constructor syntax

    new Capability(name: string, args: CapabilityArgs, opts?: CustomResourceOptions);
    @overload
    def Capability(resource_name: str,
                   args: CapabilityArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Capability(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   type: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   notes: Optional[str] = None,
                   properties: Optional[Mapping[str, str]] = None)
    func NewCapability(ctx *Context, name string, args CapabilityArgs, opts ...ResourceOption) (*Capability, error)
    public Capability(string name, CapabilityArgs args, CustomResourceOptions? opts = null)
    public Capability(String name, CapabilityArgs args)
    public Capability(String name, CapabilityArgs args, CustomResourceOptions options)
    
    type: nexus:Capability
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "nexus_capability" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CapabilityArgs
    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 CapabilityArgs
    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 CapabilityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CapabilityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CapabilityArgs
    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 capabilityResource = new Nexus.Capability("capabilityResource", new()
    {
        Type = "string",
        Enabled = false,
        Notes = "string",
        Properties = 
        {
            { "string", "string" },
        },
    });
    
    example, err := nexus.NewCapability(ctx, "capabilityResource", &nexus.CapabilityArgs{
    	Type:    pulumi.String("string"),
    	Enabled: pulumi.Bool(false),
    	Notes:   pulumi.String("string"),
    	Properties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "nexus_capability" "capabilityResource" {
      lifecycle {
        create_before_destroy = true
      }
      type    = "string"
      enabled = false
      notes   = "string"
      properties = {
        "string" = "string"
      }
    }
    
    var capabilityResource = new Capability("capabilityResource", CapabilityArgs.builder()
        .type("string")
        .enabled(false)
        .notes("string")
        .properties(Map.of("string", "string"))
        .build());
    
    capability_resource = nexus.Capability("capabilityResource",
        type="string",
        enabled=False,
        notes="string",
        properties={
            "string": "string",
        })
    
    const capabilityResource = new nexus.Capability("capabilityResource", {
        type: "string",
        enabled: false,
        notes: "string",
        properties: {
            string: "string",
        },
    });
    
    type: nexus:Capability
    properties:
        enabled: false
        notes: string
        properties:
            string: string
        type: string
    

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

    Type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    Enabled bool
    Whether the capability is enabled.
    Notes string
    Free-form notes about the capability.
    Properties Dictionary<string, string>
    Type-specific configuration properties.
    Type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    Enabled bool
    Whether the capability is enabled.
    Notes string
    Free-form notes about the capability.
    Properties map[string]string
    Type-specific configuration properties.
    type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled bool
    Whether the capability is enabled.
    notes string
    Free-form notes about the capability.
    properties map(string)
    Type-specific configuration properties.
    type String
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled Boolean
    Whether the capability is enabled.
    notes String
    Free-form notes about the capability.
    properties Map<String,String>
    Type-specific configuration properties.
    type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled boolean
    Whether the capability is enabled.
    notes string
    Free-form notes about the capability.
    properties {[key: string]: string}
    Type-specific configuration properties.
    type str
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled bool
    Whether the capability is enabled.
    notes str
    Free-form notes about the capability.
    properties Mapping[str, str]
    Type-specific configuration properties.
    type String
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled Boolean
    Whether the capability is enabled.
    notes String
    Free-form notes about the capability.
    properties Map<String>
    Type-specific configuration properties.

    Outputs

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

    Get an existing Capability 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?: CapabilityState, opts?: CustomResourceOptions): Capability
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            notes: Optional[str] = None,
            properties: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None) -> Capability
    func GetCapability(ctx *Context, name string, id IDInput, state *CapabilityState, opts ...ResourceOption) (*Capability, error)
    public static Capability Get(string name, Input<string> id, CapabilityState? state, CustomResourceOptions? opts = null)
    public static Capability get(String name, Output<String> id, CapabilityState state, CustomResourceOptions options)
    resources:  _:    type: nexus:Capability    get:      id: ${id}
    import {
      to = nexus_capability.example
      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:
    Enabled bool
    Whether the capability is enabled.
    Notes string
    Free-form notes about the capability.
    Properties Dictionary<string, string>
    Type-specific configuration properties.
    Type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    Enabled bool
    Whether the capability is enabled.
    Notes string
    Free-form notes about the capability.
    Properties map[string]string
    Type-specific configuration properties.
    Type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled bool
    Whether the capability is enabled.
    notes string
    Free-form notes about the capability.
    properties map(string)
    Type-specific configuration properties.
    type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled Boolean
    Whether the capability is enabled.
    notes String
    Free-form notes about the capability.
    properties Map<String,String>
    Type-specific configuration properties.
    type String
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled boolean
    Whether the capability is enabled.
    notes string
    Free-form notes about the capability.
    properties {[key: string]: string}
    Type-specific configuration properties.
    type string
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled bool
    Whether the capability is enabled.
    notes str
    Free-form notes about the capability.
    properties Mapping[str, str]
    Type-specific configuration properties.
    type str
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').
    enabled Boolean
    Whether the capability is enabled.
    notes String
    Free-form notes about the capability.
    properties Map<String>
    Type-specific configuration properties.
    type String
    The type of capability (e.g., 'OutreachManagementCapability', 'HttpClientCapability').

    Package Details

    Repository
    nexus datadrivers/terraform-provider-nexus
    License
    Notes
    This Pulumi package is based on the nexus Terraform Provider.
    Viewing docs for nexus 3.0.0
    published on Tuesday, Jul 28, 2026 by datadrivers

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial