1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Analytics
  5. AnalyticsInstanceVanityUrl
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Analytics.AnalyticsInstanceVanityUrl

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This resource provides the Analytics Instance Vanity Url resource in Oracle Cloud Infrastructure Analytics service.

    Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate for this host.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAnalyticsInstanceVanityUrl = new oci.analytics.AnalyticsInstanceVanityUrl("test_analytics_instance_vanity_url", {
        analyticsInstanceId: testAnalyticsInstance.id,
        caCertificate: analyticsInstanceVanityUrlCaCertificate,
        hosts: analyticsInstanceVanityUrlHosts,
        privateKey: analyticsInstanceVanityUrlPrivateKey,
        publicCertificate: analyticsInstanceVanityUrlPublicCertificate,
        description: analyticsInstanceVanityUrlDescription,
        passphrase: analyticsInstanceVanityUrlPassphrase,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_analytics_instance_vanity_url = oci.analytics.AnalyticsInstanceVanityUrl("test_analytics_instance_vanity_url",
        analytics_instance_id=test_analytics_instance["id"],
        ca_certificate=analytics_instance_vanity_url_ca_certificate,
        hosts=analytics_instance_vanity_url_hosts,
        private_key=analytics_instance_vanity_url_private_key,
        public_certificate=analytics_instance_vanity_url_public_certificate,
        description=analytics_instance_vanity_url_description,
        passphrase=analytics_instance_vanity_url_passphrase)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Analytics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Analytics.NewAnalyticsInstanceVanityUrl(ctx, "test_analytics_instance_vanity_url", &Analytics.AnalyticsInstanceVanityUrlArgs{
    			AnalyticsInstanceId: pulumi.Any(testAnalyticsInstance.Id),
    			CaCertificate:       pulumi.Any(analyticsInstanceVanityUrlCaCertificate),
    			Hosts:               pulumi.Any(analyticsInstanceVanityUrlHosts),
    			PrivateKey:          pulumi.Any(analyticsInstanceVanityUrlPrivateKey),
    			PublicCertificate:   pulumi.Any(analyticsInstanceVanityUrlPublicCertificate),
    			Description:         pulumi.Any(analyticsInstanceVanityUrlDescription),
    			Passphrase:          pulumi.Any(analyticsInstanceVanityUrlPassphrase),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAnalyticsInstanceVanityUrl = new Oci.Analytics.AnalyticsInstanceVanityUrl("test_analytics_instance_vanity_url", new()
        {
            AnalyticsInstanceId = testAnalyticsInstance.Id,
            CaCertificate = analyticsInstanceVanityUrlCaCertificate,
            Hosts = analyticsInstanceVanityUrlHosts,
            PrivateKey = analyticsInstanceVanityUrlPrivateKey,
            PublicCertificate = analyticsInstanceVanityUrlPublicCertificate,
            Description = analyticsInstanceVanityUrlDescription,
            Passphrase = analyticsInstanceVanityUrlPassphrase,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Analytics.AnalyticsInstanceVanityUrl;
    import com.pulumi.oci.Analytics.AnalyticsInstanceVanityUrlArgs;
    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 testAnalyticsInstanceVanityUrl = new AnalyticsInstanceVanityUrl("testAnalyticsInstanceVanityUrl", AnalyticsInstanceVanityUrlArgs.builder()
                .analyticsInstanceId(testAnalyticsInstance.id())
                .caCertificate(analyticsInstanceVanityUrlCaCertificate)
                .hosts(analyticsInstanceVanityUrlHosts)
                .privateKey(analyticsInstanceVanityUrlPrivateKey)
                .publicCertificate(analyticsInstanceVanityUrlPublicCertificate)
                .description(analyticsInstanceVanityUrlDescription)
                .passphrase(analyticsInstanceVanityUrlPassphrase)
                .build());
    
        }
    }
    
    resources:
      testAnalyticsInstanceVanityUrl:
        type: oci:Analytics:AnalyticsInstanceVanityUrl
        name: test_analytics_instance_vanity_url
        properties:
          analyticsInstanceId: ${testAnalyticsInstance.id}
          caCertificate: ${analyticsInstanceVanityUrlCaCertificate}
          hosts: ${analyticsInstanceVanityUrlHosts}
          privateKey: ${analyticsInstanceVanityUrlPrivateKey}
          publicCertificate: ${analyticsInstanceVanityUrlPublicCertificate}
          description: ${analyticsInstanceVanityUrlDescription}
          passphrase: ${analyticsInstanceVanityUrlPassphrase}
    

    Create AnalyticsInstanceVanityUrl Resource

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

    Constructor syntax

    new AnalyticsInstanceVanityUrl(name: string, args: AnalyticsInstanceVanityUrlArgs, opts?: CustomResourceOptions);
    @overload
    def AnalyticsInstanceVanityUrl(resource_name: str,
                                   args: AnalyticsInstanceVanityUrlArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnalyticsInstanceVanityUrl(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   analytics_instance_id: Optional[str] = None,
                                   ca_certificate: Optional[str] = None,
                                   hosts: Optional[Sequence[str]] = None,
                                   private_key: Optional[str] = None,
                                   public_certificate: Optional[str] = None,
                                   description: Optional[str] = None,
                                   passphrase: Optional[str] = None)
    func NewAnalyticsInstanceVanityUrl(ctx *Context, name string, args AnalyticsInstanceVanityUrlArgs, opts ...ResourceOption) (*AnalyticsInstanceVanityUrl, error)
    public AnalyticsInstanceVanityUrl(string name, AnalyticsInstanceVanityUrlArgs args, CustomResourceOptions? opts = null)
    public AnalyticsInstanceVanityUrl(String name, AnalyticsInstanceVanityUrlArgs args)
    public AnalyticsInstanceVanityUrl(String name, AnalyticsInstanceVanityUrlArgs args, CustomResourceOptions options)
    
    type: oci:Analytics:AnalyticsInstanceVanityUrl
    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 AnalyticsInstanceVanityUrlArgs
    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 AnalyticsInstanceVanityUrlArgs
    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 AnalyticsInstanceVanityUrlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnalyticsInstanceVanityUrlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnalyticsInstanceVanityUrlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var analyticsInstanceVanityUrlResource = new Oci.Analytics.AnalyticsInstanceVanityUrl("analyticsInstanceVanityUrlResource", new()
    {
        AnalyticsInstanceId = "string",
        CaCertificate = "string",
        Hosts = new[]
        {
            "string",
        },
        PrivateKey = "string",
        PublicCertificate = "string",
        Description = "string",
        Passphrase = "string",
    });
    
    example, err := Analytics.NewAnalyticsInstanceVanityUrl(ctx, "analyticsInstanceVanityUrlResource", &Analytics.AnalyticsInstanceVanityUrlArgs{
    	AnalyticsInstanceId: pulumi.String("string"),
    	CaCertificate:       pulumi.String("string"),
    	Hosts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PrivateKey:        pulumi.String("string"),
    	PublicCertificate: pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	Passphrase:        pulumi.String("string"),
    })
    
    var analyticsInstanceVanityUrlResource = new AnalyticsInstanceVanityUrl("analyticsInstanceVanityUrlResource", AnalyticsInstanceVanityUrlArgs.builder()
        .analyticsInstanceId("string")
        .caCertificate("string")
        .hosts("string")
        .privateKey("string")
        .publicCertificate("string")
        .description("string")
        .passphrase("string")
        .build());
    
    analytics_instance_vanity_url_resource = oci.analytics.AnalyticsInstanceVanityUrl("analyticsInstanceVanityUrlResource",
        analytics_instance_id="string",
        ca_certificate="string",
        hosts=["string"],
        private_key="string",
        public_certificate="string",
        description="string",
        passphrase="string")
    
    const analyticsInstanceVanityUrlResource = new oci.analytics.AnalyticsInstanceVanityUrl("analyticsInstanceVanityUrlResource", {
        analyticsInstanceId: "string",
        caCertificate: "string",
        hosts: ["string"],
        privateKey: "string",
        publicCertificate: "string",
        description: "string",
        passphrase: "string",
    });
    
    type: oci:Analytics:AnalyticsInstanceVanityUrl
    properties:
        analyticsInstanceId: string
        caCertificate: string
        description: string
        hosts:
            - string
        passphrase: string
        privateKey: string
        publicCertificate: string
    

    AnalyticsInstanceVanityUrl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AnalyticsInstanceVanityUrl resource accepts the following input properties:

    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    CaCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    Hosts List<string>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    PrivateKey string
    (Updatable) PEM Private key for HTTPS connections.
    PublicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Description string
    Optional description.
    Passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    CaCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    Hosts []string
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    PrivateKey string
    (Updatable) PEM Private key for HTTPS connections.
    PublicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Description string
    Optional description.
    Passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    caCertificate String
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    hosts List<String>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    privateKey String
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate String

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    description String
    Optional description.
    passphrase String
    (Updatable) Passphrase for the PEM Private key (if any).
    analyticsInstanceId string
    The OCID of the AnalyticsInstance.
    caCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    hosts string[]
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    privateKey string
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    description string
    Optional description.
    passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    analytics_instance_id str
    The OCID of the AnalyticsInstance.
    ca_certificate str
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    hosts Sequence[str]
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    private_key str
    (Updatable) PEM Private key for HTTPS connections.
    public_certificate str

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    description str
    Optional description.
    passphrase str
    (Updatable) Passphrase for the PEM Private key (if any).
    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    caCertificate String
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    hosts List<String>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    privateKey String
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate String

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    description String
    Optional description.
    passphrase String
    (Updatable) Passphrase for the PEM Private key (if any).

    Outputs

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

    Get an existing AnalyticsInstanceVanityUrl 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?: AnalyticsInstanceVanityUrlState, opts?: CustomResourceOptions): AnalyticsInstanceVanityUrl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            analytics_instance_id: Optional[str] = None,
            ca_certificate: Optional[str] = None,
            description: Optional[str] = None,
            hosts: Optional[Sequence[str]] = None,
            passphrase: Optional[str] = None,
            private_key: Optional[str] = None,
            public_certificate: Optional[str] = None) -> AnalyticsInstanceVanityUrl
    func GetAnalyticsInstanceVanityUrl(ctx *Context, name string, id IDInput, state *AnalyticsInstanceVanityUrlState, opts ...ResourceOption) (*AnalyticsInstanceVanityUrl, error)
    public static AnalyticsInstanceVanityUrl Get(string name, Input<string> id, AnalyticsInstanceVanityUrlState? state, CustomResourceOptions? opts = null)
    public static AnalyticsInstanceVanityUrl get(String name, Output<String> id, AnalyticsInstanceVanityUrlState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    CaCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    Description string
    Optional description.
    Hosts List<string>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    Passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    PrivateKey string
    (Updatable) PEM Private key for HTTPS connections.
    PublicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AnalyticsInstanceId string
    The OCID of the AnalyticsInstance.
    CaCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    Description string
    Optional description.
    Hosts []string
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    Passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    PrivateKey string
    (Updatable) PEM Private key for HTTPS connections.
    PublicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    caCertificate String
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    description String
    Optional description.
    hosts List<String>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    passphrase String
    (Updatable) Passphrase for the PEM Private key (if any).
    privateKey String
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate String

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId string
    The OCID of the AnalyticsInstance.
    caCertificate string
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    description string
    Optional description.
    hosts string[]
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    passphrase string
    (Updatable) Passphrase for the PEM Private key (if any).
    privateKey string
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate string

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analytics_instance_id str
    The OCID of the AnalyticsInstance.
    ca_certificate str
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    description str
    Optional description.
    hosts Sequence[str]
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    passphrase str
    (Updatable) Passphrase for the PEM Private key (if any).
    private_key str
    (Updatable) PEM Private key for HTTPS connections.
    public_certificate str

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    analyticsInstanceId String
    The OCID of the AnalyticsInstance.
    caCertificate String
    (Updatable) PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
    description String
    Optional description.
    hosts List<String>
    List of fully qualified hostnames supported by this vanity URL definition (max of 3).
    passphrase String
    (Updatable) Passphrase for the PEM Private key (if any).
    privateKey String
    (Updatable) PEM Private key for HTTPS connections.
    publicCertificate String

    (Updatable) PEM certificate for HTTPS connections.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    AnalyticsInstanceVanityUrls can be imported using the id, e.g.

    $ pulumi import oci:Analytics/analyticsInstanceVanityUrl:AnalyticsInstanceVanityUrl test_analytics_instance_vanity_url "analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi