Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incapsula Provider
  3. API Docs
  4. SiteV3
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

incapsula.SiteV3

Explore with Pulumi AI

incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula

Provides an Incapsula V3 site resource. A V3 site resource is the core resource that is required by all other resources. incapsula.SiteV3 is a newer version of incapsula_site. Site can be managed by incapsula.SiteV3 or incapsula_site, but not both simultaneously. Full site onboarding example with TF can be found here.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as incapsula from "@pulumi/incapsula";

const example_site_v3 = new incapsula.SiteV3("example-site-v3", {});
Copy
import pulumi
import pulumi_incapsula as incapsula

example_site_v3 = incapsula.SiteV3("example-site-v3")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/incapsula/v3/incapsula"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := incapsula.NewSiteV3(ctx, "example-site-v3", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;

return await Deployment.RunAsync(() => 
{
    var example_site_v3 = new Incapsula.SiteV3("example-site-v3");

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.SiteV3;
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 example_site_v3 = new SiteV3("example-site-v3");

    }
}
Copy
resources:
  example-site-v3:
    type: incapsula:SiteV3
Copy

Create SiteV3 Resource

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

Constructor syntax

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

@overload
def SiteV3(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account_id: Optional[str] = None,
           active: Optional[bool] = None,
           name: Optional[str] = None,
           ref_id: Optional[str] = None,
           site_v3_id: Optional[str] = None,
           type: Optional[str] = None)
func NewSiteV3(ctx *Context, name string, args *SiteV3Args, opts ...ResourceOption) (*SiteV3, error)
public SiteV3(string name, SiteV3Args? args = null, CustomResourceOptions? opts = null)
public SiteV3(String name, SiteV3Args args)
public SiteV3(String name, SiteV3Args args, CustomResourceOptions options)

type: incapsula:SiteV3
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 SiteV3Args
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 SiteV3Args
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 SiteV3Args
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 SiteV3Args
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. SiteV3Args
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 siteV3Resource = new Incapsula.SiteV3("siteV3Resource", new()
{
    AccountId = "string",
    Active = false,
    Name = "string",
    RefId = "string",
    SiteV3Id = "string",
    Type = "string",
});
Copy
example, err := incapsula.NewSiteV3(ctx, "siteV3Resource", &incapsula.SiteV3Args{
AccountId: pulumi.String("string"),
Active: pulumi.Bool(false),
Name: pulumi.String("string"),
RefId: pulumi.String("string"),
SiteV3Id: pulumi.String("string"),
Type: pulumi.String("string"),
})
Copy
var siteV3Resource = new SiteV3("siteV3Resource", SiteV3Args.builder()
    .accountId("string")
    .active(false)
    .name("string")
    .refId("string")
    .siteV3Id("string")
    .type("string")
    .build());
Copy
site_v3_resource = incapsula.SiteV3("siteV3Resource",
    account_id="string",
    active=False,
    name="string",
    ref_id="string",
    site_v3_id="string",
    type="string")
Copy
const siteV3Resource = new incapsula.SiteV3("siteV3Resource", {
    accountId: "string",
    active: false,
    name: "string",
    refId: "string",
    siteV3Id: "string",
    type: "string",
});
Copy
type: incapsula:SiteV3
properties:
    accountId: string
    active: false
    name: string
    refId: string
    siteV3Id: string
    type: string
Copy

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

AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
Active bool
Whether the site is active or bypassed by the Imperva network.
Name string
The site name.
RefId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
SiteV3Id string
Unique identifier in the API for the site.
Type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
Active bool
Whether the site is active or bypassed by the Imperva network.
Name string
The site name.
RefId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
SiteV3Id string
Unique identifier in the API for the site.
Type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active Boolean
Whether the site is active or bypassed by the Imperva network.
name String
The site name.
refId String
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id String
Unique identifier in the API for the site.
type String
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active boolean
Whether the site is active or bypassed by the Imperva network.
name string
The site name.
refId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id string
Unique identifier in the API for the site.
type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
account_id str
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active bool
Whether the site is active or bypassed by the Imperva network.
name str
The site name.
ref_id str
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
site_v3_id str
Unique identifier in the API for the site.
type str
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active Boolean
Whether the site is active or bypassed by the Imperva network.
name String
The site name.
refId String
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id String
Unique identifier in the API for the site.
type String
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.

Outputs

All input properties are implicitly available as output properties. Additionally, the SiteV3 resource produces the following output properties:

Cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
CreationTime double
Creation time of the site.
Id string
The provider-assigned unique ID for this managed resource.
Cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
CreationTime float64
Creation time of the site.
Id string
The provider-assigned unique ID for this managed resource.
cname String
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime Double
Creation time of the site.
id String
The provider-assigned unique ID for this managed resource.
cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime number
Creation time of the site.
id string
The provider-assigned unique ID for this managed resource.
cname str
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creation_time float
Creation time of the site.
id str
The provider-assigned unique ID for this managed resource.
cname String
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime Number
Creation time of the site.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SiteV3 Resource

Get an existing SiteV3 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?: SiteV3State, opts?: CustomResourceOptions): SiteV3
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        active: Optional[bool] = None,
        cname: Optional[str] = None,
        creation_time: Optional[float] = None,
        name: Optional[str] = None,
        ref_id: Optional[str] = None,
        site_v3_id: Optional[str] = None,
        type: Optional[str] = None) -> SiteV3
func GetSiteV3(ctx *Context, name string, id IDInput, state *SiteV3State, opts ...ResourceOption) (*SiteV3, error)
public static SiteV3 Get(string name, Input<string> id, SiteV3State? state, CustomResourceOptions? opts = null)
public static SiteV3 get(String name, Output<String> id, SiteV3State state, CustomResourceOptions options)
resources:  _:    type: incapsula:SiteV3    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:
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
Active bool
Whether the site is active or bypassed by the Imperva network.
Cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
CreationTime double
Creation time of the site.
Name string
The site name.
RefId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
SiteV3Id string
Unique identifier in the API for the site.
Type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
AccountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
Active bool
Whether the site is active or bypassed by the Imperva network.
Cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
CreationTime float64
Creation time of the site.
Name string
The site name.
RefId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
SiteV3Id string
Unique identifier in the API for the site.
Type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active Boolean
Whether the site is active or bypassed by the Imperva network.
cname String
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime Double
Creation time of the site.
name String
The site name.
refId String
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id String
Unique identifier in the API for the site.
type String
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId string
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active boolean
Whether the site is active or bypassed by the Imperva network.
cname string
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime number
Creation time of the site.
name string
The site name.
refId string
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id string
Unique identifier in the API for the site.
type string
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
account_id str
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active bool
Whether the site is active or bypassed by the Imperva network.
cname str
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creation_time float
Creation time of the site.
name str
The site name.
ref_id str
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
site_v3_id str
Unique identifier in the API for the site.
type str
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.
accountId String
The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
active Boolean
Whether the site is active or bypassed by the Imperva network.
cname String
The CNAME provided by Imperva that is used for pointing your website traffic to the Imperva network.
creationTime Number
Creation time of the site.
name String
The site name.
refId String
Sets the Reference ID. A free-text field that enables you to add a unique identifier to correlate a website in our service with an object on the customer side.
siteV3Id String
Unique identifier in the API for the site.
type String
The website type. Indicates which kind of website is created. The allowed options is CLOUD_WAF for a website onboarded to Imperva Cloud WAF.

Import

Site can be imported using the account Id/id, e.g.:

$ pulumi import incapsula:index/siteV3:SiteV3 example 543/1234
Copy

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

Package Details

Repository
incapsula imperva/terraform-provider-incapsula
License
Notes
This Pulumi package is based on the incapsula Terraform Provider.
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva
imperva/terraform-provider-incapsula