@ctfer-io/pulumi-ctfd
Version:
The CTFd provider for Pulumi, to manage its resources as code.
190 lines (189 loc) • 6.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* CTFd defines a Team as a group of Users who will attend the Capture The Flag event.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as ctfd from "@ctfer-io/pulumi-ctfd";
*
* const ctfer = new ctfd.User("ctfer", {
* email: "ctfer-io@protonmail.com",
* password: "password",
* });
* const cybercombattants = new ctfd.Team("cybercombattants", {
* email: "lucastesson@protonmail.com",
* password: "password",
* members: [ctfer.id],
* captain: ctfer.id,
* });
* ```
*/
export declare class Team extends pulumi.CustomResource {
/**
* Get an existing Team resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamState, opts?: pulumi.CustomResourceOptions): Team;
/**
* Returns true if the given object is an instance of Team. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Team;
/**
* Affiliation to a company or agency.
*/
readonly affiliation: pulumi.Output<string | undefined>;
/**
* Is true if the team is banned from the CTF.
*/
readonly banned: pulumi.Output<boolean>;
/**
* The bracket id the user plays in.
*/
readonly bracketId: pulumi.Output<string | undefined>;
/**
* Member who is captain of the team. Must be part of the members too. Note it could cause a fatal error in case of resource import with an inconsistent CTFd configuration i.e. if a team has no captain yet (should not be possible).
*/
readonly captain: pulumi.Output<string>;
/**
* Country the team represent or is hail from.
*/
readonly country: pulumi.Output<string | undefined>;
/**
* Email of the team.
*/
readonly email: pulumi.Output<string>;
/**
* Is true if the team is hidden to the participants.
*/
readonly hidden: pulumi.Output<boolean>;
/**
* List of members (User), defined by their IDs.
*/
readonly members: pulumi.Output<string[]>;
/**
* Name of the team.
*/
readonly name: pulumi.Output<string>;
/**
* Password of the team. Notice that during a CTF you may not want to update those to avoid defaulting team accesses.
*/
readonly password: pulumi.Output<string>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
readonly website: pulumi.Output<string | undefined>;
/**
* Create a Team resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TeamArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Team resources.
*/
export interface TeamState {
/**
* Affiliation to a company or agency.
*/
affiliation?: pulumi.Input<string>;
/**
* Is true if the team is banned from the CTF.
*/
banned?: pulumi.Input<boolean>;
/**
* The bracket id the user plays in.
*/
bracketId?: pulumi.Input<string>;
/**
* Member who is captain of the team. Must be part of the members too. Note it could cause a fatal error in case of resource import with an inconsistent CTFd configuration i.e. if a team has no captain yet (should not be possible).
*/
captain?: pulumi.Input<string>;
/**
* Country the team represent or is hail from.
*/
country?: pulumi.Input<string>;
/**
* Email of the team.
*/
email?: pulumi.Input<string>;
/**
* Is true if the team is hidden to the participants.
*/
hidden?: pulumi.Input<boolean>;
/**
* List of members (User), defined by their IDs.
*/
members?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the team.
*/
name?: pulumi.Input<string>;
/**
* Password of the team. Notice that during a CTF you may not want to update those to avoid defaulting team accesses.
*/
password?: pulumi.Input<string>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
website?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Team resource.
*/
export interface TeamArgs {
/**
* Affiliation to a company or agency.
*/
affiliation?: pulumi.Input<string>;
/**
* Is true if the team is banned from the CTF.
*/
banned?: pulumi.Input<boolean>;
/**
* The bracket id the user plays in.
*/
bracketId?: pulumi.Input<string>;
/**
* Member who is captain of the team. Must be part of the members too. Note it could cause a fatal error in case of resource import with an inconsistent CTFd configuration i.e. if a team has no captain yet (should not be possible).
*/
captain: pulumi.Input<string>;
/**
* Country the team represent or is hail from.
*/
country?: pulumi.Input<string>;
/**
* Email of the team.
*/
email: pulumi.Input<string>;
/**
* Is true if the team is hidden to the participants.
*/
hidden?: pulumi.Input<boolean>;
/**
* List of members (User), defined by their IDs.
*/
members: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the team.
*/
name?: pulumi.Input<string>;
/**
* Password of the team. Notice that during a CTF you may not want to update those to avoid defaulting team accesses.
*/
password: pulumi.Input<string>;
/**
* Website, blog, or anything similar (displayed to other participants).
*/
website?: pulumi.Input<string>;
}