1. Packages
  2. CTFd Provider
  3. API Docs
  4. Provider
CTFd v2.0.5 published on Thursday, Feb 13, 2025 by CTFer.io

ctfd.Provider

Explore with Pulumi AI

The provider type for the ctfd 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_key: Optional[str] = None,
             password: Optional[str] = None,
             url: Optional[str] = None,
             username: 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:ctfd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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:

ApiKey string
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
Password string
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
Url string
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
Username string
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.
ApiKey string
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
Password string
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
Url string
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
Username string
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.
apiKey String
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
password String
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
url String
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
username String
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.
apiKey string
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
password string
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
url string
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
username string
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.
api_key str
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
password str
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
url str
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
username str
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.
apiKey String
User API key. Could use CTFD_API_KEY environment variable instead. Despite being the most convenient way to authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation policy.
password String
The administrator or service account password to login with. Could use CTFD_ADMIN_PASSWORD environment variable instead.
url String
CTFd base URL (e.g. https://my-ctf.lan). Could use CTFD_URL environment variable instead.
username String
The administrator or service account username to login with. Could use CTFD_ADMIN_USERNAME environment variable instead.

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