1. Packages
  2. Incapsula Provider
  3. API Docs
  4. Domain
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva

incapsula.Domain

Explore with Pulumi AI

incapsula logo
incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva

    Provides an Incapsula Domain resource for V3 Sites. The provider will add/delete domains to/from an Imperva site, based on this resource. These domains are protected by Imperva and share the website settings and configuration of the onboarded website. Legitimate traffic for all verified domains is allowed.

    Note: This resource is designed to work with sites represented by the “incapsula.SiteV3” resource, and cannot be used together in the same configuration with the “incapsula.SiteDomainConfiguration” resource. Adding an apex domain without its corresponding www subdomain is not supported.

    Create Domain Resource

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

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
    def Domain(resource_name: str,
               args: DomainArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               domain: Optional[str] = None,
               site_id: Optional[str] = None,
               domain_id: Optional[str] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
    public Domain(String name, DomainArgs args, CustomResourceOptions options)
    
    type: incapsula:Domain
    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 DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    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 domainResource = new Incapsula.Domain("domainResource", new()
    {
        Domain = "string",
        SiteId = "string",
        DomainId = "string",
    });
    
    example, err := incapsula.NewDomain(ctx, "domainResource", &incapsula.DomainArgs{
    	Domain:   pulumi.String("string"),
    	SiteId:   pulumi.String("string"),
    	DomainId: pulumi.String("string"),
    })
    
    var domainResource = new Domain("domainResource", DomainArgs.builder()
        .domain("string")
        .siteId("string")
        .domainId("string")
        .build());
    
    domain_resource = incapsula.Domain("domainResource",
        domain="string",
        site_id="string",
        domain_id="string")
    
    const domainResource = new incapsula.Domain("domainResource", {
        domain: "string",
        siteId: "string",
        domainId: "string",
    });
    
    type: incapsula:Domain
    properties:
        domain: string
        domainId: string
        siteId: string
    

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

    Domain string
    The fully qualified domain name of the site.
    SiteId string
    Numeric identifier of the site.
    DomainId string
    Domain string
    The fully qualified domain name of the site.
    SiteId string
    Numeric identifier of the site.
    DomainId string
    domain String
    The fully qualified domain name of the site.
    siteId String
    Numeric identifier of the site.
    domainId String
    domain string
    The fully qualified domain name of the site.
    siteId string
    Numeric identifier of the site.
    domainId string
    domain str
    The fully qualified domain name of the site.
    site_id str
    Numeric identifier of the site.
    domain_id str
    domain String
    The fully qualified domain name of the site.
    siteId String
    Numeric identifier of the site.
    domainId String

    Outputs

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

    ARecords List<string>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    CnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    ARecords []string
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    CnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords List<String>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord String
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords string[]
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    a_records Sequence[str]
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cname_redirection_record str
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords List<String>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord String
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            a_records: Optional[Sequence[str]] = None,
            cname_redirection_record: Optional[str] = None,
            domain: Optional[str] = None,
            domain_id: Optional[str] = None,
            site_id: Optional[str] = None,
            status: Optional[str] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    resources:  _:    type: incapsula:Domain    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:
    ARecords List<string>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    CnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    Domain string
    The fully qualified domain name of the site.
    DomainId string
    SiteId string
    Numeric identifier of the site.
    Status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    ARecords []string
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    CnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    Domain string
    The fully qualified domain name of the site.
    DomainId string
    SiteId string
    Numeric identifier of the site.
    Status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords List<String>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord String
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    domain String
    The fully qualified domain name of the site.
    domainId String
    siteId String
    Numeric identifier of the site.
    status String
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords string[]
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord string
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    domain string
    The fully qualified domain name of the site.
    domainId string
    siteId string
    Numeric identifier of the site.
    status string
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    a_records Sequence[str]
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cname_redirection_record str
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    domain str
    The fully qualified domain name of the site.
    domain_id str
    site_id str
    Numeric identifier of the site.
    status str
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.
    aRecords List<String>
    Will appear for apex domains only. A Records for traffic redirection. Point your apex domain's DNS to this record in order to forward the traffic to Imperva.
    cnameRedirectionRecord String
    CNAME validation code for traffic redirection. Point your domain's DNS to this record in order to forward the traffic to Imperva.
    domain String
    The fully qualified domain name of the site.
    domainId String
    siteId String
    Numeric identifier of the site.
    status String
    Status of the domain. Indicates if domain DNS is pointed to Imperva's CNAME. Options: BYPASSED, VERIFIED, PROTECTED, MISCONFIGURED.

    Import

    Domains can be imported using the site_id and domain_id separated by /, e.g.:

    $ pulumi import incapsula:index/domain:Domain example_domain site_id/domain_id
    

    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 logo
    incapsula 3.32.1 published on Monday, Apr 14, 2025 by imperva