Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel
  3. API Docs
  4. AttackChallengeMode
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.AttackChallengeMode

Explore with Pulumi AI

Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

Provides an Attack Challenge Mode resource.

Attack Challenge Mode prevent malicious traffic by showing a verification challenge for every visitor.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vercel from "@pulumiverse/vercel";

const exampleProject = new vercel.Project("exampleProject", {});
const exampleAttackChallengeMode = new vercel.AttackChallengeMode("exampleAttackChallengeMode", {
    projectId: exampleProject.id,
    enabled: true,
});
Copy
import pulumi
import pulumiverse_vercel as vercel

example_project = vercel.Project("exampleProject")
example_attack_challenge_mode = vercel.AttackChallengeMode("exampleAttackChallengeMode",
    project_id=example_project.id,
    enabled=True)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := vercel.NewProject(ctx, "exampleProject", nil)
		if err != nil {
			return err
		}
		_, err = vercel.NewAttackChallengeMode(ctx, "exampleAttackChallengeMode", &vercel.AttackChallengeModeArgs{
			ProjectId: exampleProject.ID(),
			Enabled:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumiverse.Vercel;

return await Deployment.RunAsync(() => 
{
    var exampleProject = new Vercel.Project("exampleProject");

    var exampleAttackChallengeMode = new Vercel.AttackChallengeMode("exampleAttackChallengeMode", new()
    {
        ProjectId = exampleProject.Id,
        Enabled = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.Project;
import com.pulumi.vercel.AttackChallengeMode;
import com.pulumi.vercel.AttackChallengeModeArgs;
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 exampleProject = new Project("exampleProject");

        var exampleAttackChallengeMode = new AttackChallengeMode("exampleAttackChallengeMode", AttackChallengeModeArgs.builder()
            .projectId(exampleProject.id())
            .enabled(true)
            .build());

    }
}
Copy
resources:
  exampleProject:
    type: vercel:Project
  exampleAttackChallengeMode:
    type: vercel:AttackChallengeMode
    properties:
      projectId: ${exampleProject.id}
      enabled: true
Copy

Create AttackChallengeMode Resource

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

Constructor syntax

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

@overload
def AttackChallengeMode(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enabled: Optional[bool] = None,
                        project_id: Optional[str] = None,
                        team_id: Optional[str] = None)
func NewAttackChallengeMode(ctx *Context, name string, args AttackChallengeModeArgs, opts ...ResourceOption) (*AttackChallengeMode, error)
public AttackChallengeMode(string name, AttackChallengeModeArgs args, CustomResourceOptions? opts = null)
public AttackChallengeMode(String name, AttackChallengeModeArgs args)
public AttackChallengeMode(String name, AttackChallengeModeArgs args, CustomResourceOptions options)

type: vercel:AttackChallengeMode
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 This property is required. AttackChallengeModeArgs
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 This property is required. AttackChallengeModeArgs
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 This property is required. AttackChallengeModeArgs
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 This property is required. AttackChallengeModeArgs
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. AttackChallengeModeArgs
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 attackChallengeModeResource = new Vercel.AttackChallengeMode("attackChallengeModeResource", new()
{
    Enabled = false,
    ProjectId = "string",
    TeamId = "string",
});
Copy
example, err := vercel.NewAttackChallengeMode(ctx, "attackChallengeModeResource", &vercel.AttackChallengeModeArgs{
	Enabled:   pulumi.Bool(false),
	ProjectId: pulumi.String("string"),
	TeamId:    pulumi.String("string"),
})
Copy
var attackChallengeModeResource = new AttackChallengeMode("attackChallengeModeResource", AttackChallengeModeArgs.builder()
    .enabled(false)
    .projectId("string")
    .teamId("string")
    .build());
Copy
attack_challenge_mode_resource = vercel.AttackChallengeMode("attackChallengeModeResource",
    enabled=False,
    project_id="string",
    team_id="string")
Copy
const attackChallengeModeResource = new vercel.AttackChallengeMode("attackChallengeModeResource", {
    enabled: false,
    projectId: "string",
    teamId: "string",
});
Copy
type: vercel:AttackChallengeMode
properties:
    enabled: false
    projectId: string
    teamId: string
Copy

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

Enabled This property is required. bool
Whether Attack Challenge Mode is enabled or not.
ProjectId This property is required. string
The ID of the Project to toggle Attack Challenge Mode on.
TeamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
Enabled This property is required. bool
Whether Attack Challenge Mode is enabled or not.
ProjectId This property is required. string
The ID of the Project to toggle Attack Challenge Mode on.
TeamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled This property is required. Boolean
Whether Attack Challenge Mode is enabled or not.
projectId This property is required. String
The ID of the Project to toggle Attack Challenge Mode on.
teamId String
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled This property is required. boolean
Whether Attack Challenge Mode is enabled or not.
projectId This property is required. string
The ID of the Project to toggle Attack Challenge Mode on.
teamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled This property is required. bool
Whether Attack Challenge Mode is enabled or not.
project_id This property is required. str
The ID of the Project to toggle Attack Challenge Mode on.
team_id str
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled This property is required. Boolean
Whether Attack Challenge Mode is enabled or not.
projectId This property is required. String
The ID of the Project to toggle Attack Challenge Mode on.
teamId String
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.

Outputs

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

Get an existing AttackChallengeMode 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?: AttackChallengeModeState, opts?: CustomResourceOptions): AttackChallengeMode
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None,
        team_id: Optional[str] = None) -> AttackChallengeMode
func GetAttackChallengeMode(ctx *Context, name string, id IDInput, state *AttackChallengeModeState, opts ...ResourceOption) (*AttackChallengeMode, error)
public static AttackChallengeMode Get(string name, Input<string> id, AttackChallengeModeState? state, CustomResourceOptions? opts = null)
public static AttackChallengeMode get(String name, Output<String> id, AttackChallengeModeState state, CustomResourceOptions options)
resources:  _:    type: vercel:AttackChallengeMode    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Attack Challenge Mode is enabled or not.
ProjectId string
The ID of the Project to toggle Attack Challenge Mode on.
TeamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
Enabled bool
Whether Attack Challenge Mode is enabled or not.
ProjectId string
The ID of the Project to toggle Attack Challenge Mode on.
TeamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled Boolean
Whether Attack Challenge Mode is enabled or not.
projectId String
The ID of the Project to toggle Attack Challenge Mode on.
teamId String
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled boolean
Whether Attack Challenge Mode is enabled or not.
projectId string
The ID of the Project to toggle Attack Challenge Mode on.
teamId string
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled bool
Whether Attack Challenge Mode is enabled or not.
project_id str
The ID of the Project to toggle Attack Challenge Mode on.
team_id str
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
enabled Boolean
Whether Attack Challenge Mode is enabled or not.
projectId String
The ID of the Project to toggle Attack Challenge Mode on.
teamId String
The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.

Import

You can import via the team_id and project_id.

  • team_id can be found in the team settings tab in the Vercel UI.

  • project_id can be found in the project settings tab in the Vercel UI.

$ pulumi import vercel:index/attackChallengeMode:AttackChallengeMode example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Copy

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

Package Details

Repository
vercel pulumiverse/pulumi-vercel
License
Apache-2.0
Notes
This Pulumi package is based on the vercel Terraform Provider.
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel