1. Packages
  2. Incapsula Provider
  3. API Docs
  4. getSslInstructions
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva

incapsula.getSslInstructions

Explore with Pulumi AI

incapsula logo
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva

    Provides an Incapsula Site SSL instruction resource.

    This data resource enables you to retrieve instructions for configuring your DNS and SSL for completing the domain validation process.
    Note: This resource is designed to work with sites represented by the “incapsula.SiteV3” resource only.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as incapsula from "@pulumi/incapsula";
    
    const example = incapsula.getSslInstructions({
        siteId: incapsula_site.mysite.id,
        domainIds: [
            incapsula_domain.my_domain1.id,
            incapsula_domain.my_domain2.id,
        ],
        managedCertificateSettingsId: incapsula_managed_certificate_settings.my_managed_certificate_settings.id,
    });
    
    import pulumi
    import pulumi_incapsula as incapsula
    
    example = incapsula.get_ssl_instructions(site_id=incapsula_site["mysite"]["id"],
        domain_ids=[
            incapsula_domain["my_domain1"]["id"],
            incapsula_domain["my_domain2"]["id"],
        ],
        managed_certificate_settings_id=incapsula_managed_certificate_settings["my_managed_certificate_settings"]["id"])
    
    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.GetSslInstructions(ctx, &incapsula.GetSslInstructionsArgs{
    SiteId: incapsula_site.Mysite.Id,
    DomainIds: interface{}{
    incapsula_domain.My_domain1.Id,
    incapsula_domain.My_domain2.Id,
    },
    ManagedCertificateSettingsId: incapsula_managed_certificate_settings.My_managed_certificate_settings.Id,
    }, nil);
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Incapsula = Pulumi.Incapsula;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Incapsula.GetSslInstructions.Invoke(new()
        {
            SiteId = incapsula_site.Mysite.Id,
            DomainIds = new[]
            {
                incapsula_domain.My_domain1.Id,
                incapsula_domain.My_domain2.Id,
            },
            ManagedCertificateSettingsId = incapsula_managed_certificate_settings.My_managed_certificate_settings.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.incapsula.IncapsulaFunctions;
    import com.pulumi.incapsula.inputs.GetSslInstructionsArgs;
    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) {
            final var example = IncapsulaFunctions.getSslInstructions(GetSslInstructionsArgs.builder()
                .siteId(incapsula_site.mysite().id())
                .domainIds(            
                    incapsula_domain.my_domain1().id(),
                    incapsula_domain.my_domain2().id())
                .managedCertificateSettingsId(incapsula_managed_certificate_settings.my_managed_certificate_settings().id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: incapsula:getSslInstructions
          arguments:
            siteId: ${incapsula_site.mysite.id}
            domainIds:
              - ${incapsula_domain.my_domain1.id}
              - ${incapsula_domain.my_domain2.id}
            managedCertificateSettingsId: ${incapsula_managed_certificate_settings.my_managed_certificate_settings.id}
    

    Using getSslInstructions

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSslInstructions(args: GetSslInstructionsArgs, opts?: InvokeOptions): Promise<GetSslInstructionsResult>
    function getSslInstructionsOutput(args: GetSslInstructionsOutputArgs, opts?: InvokeOptions): Output<GetSslInstructionsResult>
    def get_ssl_instructions(domain_ids: Optional[Sequence[str]] = None,
                             id: Optional[str] = None,
                             managed_certificate_settings_id: Optional[str] = None,
                             site_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSslInstructionsResult
    def get_ssl_instructions_output(domain_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             managed_certificate_settings_id: Optional[pulumi.Input[str]] = None,
                             site_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSslInstructionsResult]
    func GetSslInstructions(ctx *Context, args *GetSslInstructionsArgs, opts ...InvokeOption) (*GetSslInstructionsResult, error)
    func GetSslInstructionsOutput(ctx *Context, args *GetSslInstructionsOutputArgs, opts ...InvokeOption) GetSslInstructionsResultOutput

    > Note: This function is named GetSslInstructions in the Go SDK.

    public static class GetSslInstructions 
    {
        public static Task<GetSslInstructionsResult> InvokeAsync(GetSslInstructionsArgs args, InvokeOptions? opts = null)
        public static Output<GetSslInstructionsResult> Invoke(GetSslInstructionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSslInstructionsResult> getSslInstructions(GetSslInstructionsArgs args, InvokeOptions options)
    public static Output<GetSslInstructionsResult> getSslInstructions(GetSslInstructionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: incapsula:index/getSslInstructions:getSslInstructions
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DomainIds List<string>
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    ManagedCertificateSettingsId string
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    SiteId string
    Numeric identifier of the site to operate on.
    Id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    DomainIds []string
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    ManagedCertificateSettingsId string
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    SiteId string
    Numeric identifier of the site to operate on.
    Id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    domainIds List<String>
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    managedCertificateSettingsId String
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    siteId String
    Numeric identifier of the site to operate on.
    id String
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    domainIds string[]
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    managedCertificateSettingsId string
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    siteId string
    Numeric identifier of the site to operate on.
    id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    domain_ids Sequence[str]
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    managed_certificate_settings_id str
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    site_id str
    Numeric identifier of the site to operate on.
    id str
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    domainIds List<String>
    Numeric identifiers of the domains of the site to which the settings will be applied.

    • Type: list of int
    managedCertificateSettingsId String
    : Numeric identifier of the managed certificate settings related to the domains.

    • Type: int
    siteId String
    Numeric identifier of the site to operate on.
    id String
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.

    getSslInstructions Result

    The following output properties are available:

    DomainIds List<string>
    Id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    Instructions List<GetSslInstructionsInstruction>
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    ManagedCertificateSettingsId string
    SiteId string
    DomainIds []string
    Id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    Instructions []GetSslInstructionsInstruction
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    ManagedCertificateSettingsId string
    SiteId string
    domainIds List<String>
    id String
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    instructions List<GetSslInstructionsInstruction>
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    managedCertificateSettingsId String
    siteId String
    domainIds string[]
    id string
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    instructions GetSslInstructionsInstruction[]
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    managedCertificateSettingsId string
    siteId string
    domain_ids Sequence[str]
    id str
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    instructions Sequence[GetSslInstructionsInstruction]
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    managed_certificate_settings_id str
    site_id str
    domainIds List<String>
    id String
    Unique identifier in the API for the Site SSL settings. The id is identical to Site id.
    instructions List<Property Map>
    The SSL settings instructions for the domain. It will return a set of instructions for the domains. Each instruction will contain the following fields:
    managedCertificateSettingsId String
    siteId String

    Supporting Types

    GetSslInstructionsInstruction

    DomainId double
    The domain id.
    Name string
    the domain name to add to the DNS server
    SanId double
    The SAN id.
    Type string
    The record type used for the instructions. e.g TXT.
    Value string
    The certificate verification code
    DomainId float64
    The domain id.
    Name string
    the domain name to add to the DNS server
    SanId float64
    The SAN id.
    Type string
    The record type used for the instructions. e.g TXT.
    Value string
    The certificate verification code
    domainId Double
    The domain id.
    name String
    the domain name to add to the DNS server
    sanId Double
    The SAN id.
    type String
    The record type used for the instructions. e.g TXT.
    value String
    The certificate verification code
    domainId number
    The domain id.
    name string
    the domain name to add to the DNS server
    sanId number
    The SAN id.
    type string
    The record type used for the instructions. e.g TXT.
    value string
    The certificate verification code
    domain_id float
    The domain id.
    name str
    the domain name to add to the DNS server
    san_id float
    The SAN id.
    type str
    The record type used for the instructions. e.g TXT.
    value str
    The certificate verification code
    domainId Number
    The domain id.
    name String
    the domain name to add to the DNS server
    sanId Number
    The SAN id.
    type String
    The record type used for the instructions. e.g TXT.
    value String
    The certificate verification code

    Package Details

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