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

incapsula.CspSiteDomain

Explore with Pulumi AI

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

    Create CspSiteDomain Resource

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

    Constructor syntax

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

@overload
def CspSiteDomain(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  domain: Optional[str] = None,
                  site_id: Optional[float] = None,
                  account_id: Optional[float] = None,
                  csp_site_domain_id: Optional[str] = None,
                  include_subdomains: Optional[bool] = None,
                  notes: Optional[Sequence[str]] = None,
                  status: Optional[str] = None)
    func NewCspSiteDomain(ctx *Context, name string, args CspSiteDomainArgs, opts ...ResourceOption) (*CspSiteDomain, error)
    public CspSiteDomain(string name, CspSiteDomainArgs args, CustomResourceOptions? opts = null)
    public CspSiteDomain(String name, CspSiteDomainArgs args)
public CspSiteDomain(String name, CspSiteDomainArgs args, CustomResourceOptions options)

    type: incapsula:CspSiteDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CspSiteDomainArgs
    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 CspSiteDomainArgs
    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 CspSiteDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CspSiteDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CspSiteDomainArgs
    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 cspSiteDomainResource = new Incapsula.CspSiteDomain("cspSiteDomainResource", new()
{
    Domain = "string",
    SiteId = 0,
    AccountId = 0,
    CspSiteDomainId = "string",
    IncludeSubdomains = false,
    Notes = new[]
    {
        "string",
    },
    Status = "string",
});

    example, err := incapsula.NewCspSiteDomain(ctx, "cspSiteDomainResource", &incapsula.CspSiteDomainArgs{
	Domain:            pulumi.String("string"),
	SiteId:            pulumi.Float64(0),
	AccountId:         pulumi.Float64(0),
	CspSiteDomainId:   pulumi.String("string"),
	IncludeSubdomains: pulumi.Bool(false),
	Notes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Status: pulumi.String("string"),
})

    var cspSiteDomainResource = new CspSiteDomain("cspSiteDomainResource", CspSiteDomainArgs.builder()
    .domain("string")
    .siteId(0)
    .accountId(0)
    .cspSiteDomainId("string")
    .includeSubdomains(false)
    .notes("string")
    .status("string")
    .build());

    csp_site_domain_resource = incapsula.CspSiteDomain("cspSiteDomainResource",
    domain="string",
    site_id=0,
    account_id=0,
    csp_site_domain_id="string",
    include_subdomains=False,
    notes=["string"],
    status="string")

    const cspSiteDomainResource = new incapsula.CspSiteDomain("cspSiteDomainResource", {
    domain: "string",
    siteId: 0,
    accountId: 0,
    cspSiteDomainId: "string",
    includeSubdomains: false,
    notes: ["string"],
    status: "string",
});

    type: incapsula:CspSiteDomain
properties:
    accountId: 0
    cspSiteDomainId: string
    domain: string
    includeSubdomains: false
    notes:
        - string
    siteId: 0
    status: string

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

    Domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    SiteId double
    Numeric identifier of the site to operate on.
    AccountId double
    Numeric identifier of the account to operate on.
    CspSiteDomainId string
    IncludeSubdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    Notes List<string>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    Status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    Domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    SiteId float64
    Numeric identifier of the site to operate on.
    AccountId float64
    Numeric identifier of the account to operate on.
    CspSiteDomainId string
    IncludeSubdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    Notes []string
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    Status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    domain String
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    siteId Double
    Numeric identifier of the site to operate on.
    accountId Double
    Numeric identifier of the account to operate on.
    cspSiteDomainId String
    includeSubdomains Boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes List<String>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    status String
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    siteId number
    Numeric identifier of the site to operate on.
    accountId number
    Numeric identifier of the account to operate on.
    cspSiteDomainId string
    includeSubdomains boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes string[]
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    domain str
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    site_id float
    Numeric identifier of the site to operate on.
    account_id float
    Numeric identifier of the account to operate on.
    csp_site_domain_id str
    include_subdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes Sequence[str]
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    status str
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    domain String
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    siteId Number
    Numeric identifier of the site to operate on.
    accountId Number
    Numeric identifier of the account to operate on.
    cspSiteDomainId String
    includeSubdomains Boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes List<String>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    status String
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed

    Outputs

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

    Get an existing CspSiteDomain 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?: CspSiteDomainState, opts?: CustomResourceOptions): CspSiteDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[float] = None,
        csp_site_domain_id: Optional[str] = None,
        domain: Optional[str] = None,
        include_subdomains: Optional[bool] = None,
        notes: Optional[Sequence[str]] = None,
        site_id: Optional[float] = None,
        status: Optional[str] = None) -> CspSiteDomain
    func GetCspSiteDomain(ctx *Context, name string, id IDInput, state *CspSiteDomainState, opts ...ResourceOption) (*CspSiteDomain, error)
    public static CspSiteDomain Get(string name, Input<string> id, CspSiteDomainState? state, CustomResourceOptions? opts = null)
    public static CspSiteDomain get(String name, Output<String> id, CspSiteDomainState state, CustomResourceOptions options)
    resources:  _:    type: incapsula:CspSiteDomain    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 double
    Numeric identifier of the account to operate on.
    CspSiteDomainId string
    Domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    IncludeSubdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    Notes List<string>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    SiteId double
    Numeric identifier of the site to operate on.
    Status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    AccountId float64
    Numeric identifier of the account to operate on.
    CspSiteDomainId string
    Domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    IncludeSubdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    Notes []string
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    SiteId float64
    Numeric identifier of the site to operate on.
    Status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    accountId Double
    Numeric identifier of the account to operate on.
    cspSiteDomainId String
    domain String
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    includeSubdomains Boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes List<String>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    siteId Double
    Numeric identifier of the site to operate on.
    status String
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    accountId number
    Numeric identifier of the account to operate on.
    cspSiteDomainId string
    domain string
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    includeSubdomains boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes string[]
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    siteId number
    Numeric identifier of the site to operate on.
    status string
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    account_id float
    Numeric identifier of the account to operate on.
    csp_site_domain_id str
    domain str
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    include_subdomains bool
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes Sequence[str]
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    site_id float
    Numeric identifier of the site to operate on.
    status str
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed
    accountId Number
    Numeric identifier of the account to operate on.
    cspSiteDomainId String
    domain String
    The fully qualified domain name of the site. For example: www.example.com, hello.example.com.
    includeSubdomains Boolean
    Defines Whether or not subdomains will inherit the allowance of the parent domain. Values: true, false
    notes List<String>
    Add a quick note to a domain to help in future analysis and investigation. You can add as many notes as you like.
    siteId Number
    Numeric identifier of the site to operate on.
    status String
    Defines whether the domain should be Blocked or Allowed once the site's mode changes to the Enforcement. Values: Blocked, Allowed

    Package Details

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