Unifi v0.0.3, Dec 5 22

unifi.Provider

The provider type for the unifi 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

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_insecure: Optional[bool] = None,
             api_url: Optional[str] = None,
             password: Optional[str] = None,
             site: Optional[str] = None,
             username: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = 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:unifi
properties: # The arguments to resource properties.
options: # 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.

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

The Provider resource accepts the following input properties:

AllowInsecure bool: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
ApiUrl string: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
Password string: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
Site string: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
Username string: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

AllowInsecure bool: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
ApiUrl string: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
Password string: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
Site string: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
Username string: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

allowInsecure Boolean: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
apiUrl String: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
password String: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
site String: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
username String: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

allowInsecure boolean: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
apiUrl string: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
password string: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
site string: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
username string: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

allow_insecure bool: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
api_url str: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
password str: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
site str: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
username str: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

allowInsecure Boolean: Skip verification of TLS certificates of API requests. You may need to set this to true if you are using your local API without setting up a signed certificate. Can be specified with the UNIFI_INSECURE environment variable. It can also be sourced from the following environment variable: UNIFI_INSECURE
apiUrl String: URL of the controller API. Can be specified with the UNIFI_API environment variable. You should NOT supply the path (/api), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths. It can also be sourced from the following environment variable: UNIFI_API
password String: Password for the user accessing the API. Can be specified with the UNIFI_PASSWORD environment variable. It can also be sourced from the following environment variable: UNIFI_PASSWORD
site String: The site in the Unifi controller this provider will manage. Can be specified with the UNIFI_SITE environment variable. Default: default It can also be sourced from the following environment variable: UNIFI_SITE
username String: Local user name for the Unifi controller API. Can be specified with the UNIFI_USERNAME environment variable. It can also be sourced from the following environment variable: UNIFI_USERNAME

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: unifi pulumiverse/pulumi-unifi
License: Apache-2.0
Notes: This Pulumi package is based on the unifi Terraform Provider.