Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. ElasticCloud (EC)
  3. API Docs
  4. ObservabilityProject
ElasticCloud (EC) v0.9.0 published on Friday, Aug 30, 2024 by Pulumi
pulumi/pulumi-ec

ec.ObservabilityProject

Explore with Pulumi AI

ec logo
ElasticCloud (EC) v0.9.0 published on Friday, Aug 30, 2024 by Pulumi
pulumi/pulumi-ec

    Technical preview

    This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

    Example Usage

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

const myProject = new ec.ObservabilityProject("my_project", {
    name: "my_project",
    regionId: "aws-us-east-1",
});

    import pulumi
import pulumi_ec as ec

my_project = ec.ObservabilityProject("my_project",
    name="my_project",
    region_id="aws-us-east-1")

    package main

import (
	"github.com/pulumi/pulumi-ec/sdk/go/ec"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec.NewObservabilityProject(ctx, "my_project", &ec.ObservabilityProjectArgs{
			Name:     pulumi.String("my_project"),
			RegionId: pulumi.String("aws-us-east-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ElasticCloud = Pulumi.ElasticCloud;

return await Deployment.RunAsync(() => 
{
    var myProject = new ElasticCloud.ObservabilityProject("my_project", new()
    {
        Name = "my_project",
        RegionId = "aws-us-east-1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.ObservabilityProject;
import com.pulumi.ec.ObservabilityProjectArgs;
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 myProject = new ObservabilityProject("myProject", ObservabilityProjectArgs.builder()
            .name("my_project")
            .regionId("aws-us-east-1")
            .build());

    }
}

    resources:
  myProject:
    type: ec:ObservabilityProject
    name: my_project
    properties:
      name: my_project
      regionId: aws-us-east-1

    Create ObservabilityProject Resource

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

    Constructor syntax

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

@overload
def ObservabilityProject(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         region_id: Optional[str] = None,
                         alias: Optional[str] = None,
                         name: Optional[str] = None)
    func NewObservabilityProject(ctx *Context, name string, args ObservabilityProjectArgs, opts ...ResourceOption) (*ObservabilityProject, error)
    public ObservabilityProject(string name, ObservabilityProjectArgs args, CustomResourceOptions? opts = null)
    public ObservabilityProject(String name, ObservabilityProjectArgs args)
public ObservabilityProject(String name, ObservabilityProjectArgs args, CustomResourceOptions options)

    type: ec:ObservabilityProject
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 ObservabilityProjectArgs
    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 ObservabilityProjectArgs
    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 ObservabilityProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObservabilityProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObservabilityProjectArgs
    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 observabilityProjectResource = new ElasticCloud.ObservabilityProject("observabilityProjectResource", new()
{
    RegionId = "string",
    Alias = "string",
    Name = "string",
});

    example, err := ec.NewObservabilityProject(ctx, "observabilityProjectResource", &ec.ObservabilityProjectArgs{
	RegionId: pulumi.String("string"),
	Alias:    pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var observabilityProjectResource = new ObservabilityProject("observabilityProjectResource", ObservabilityProjectArgs.builder()
    .regionId("string")
    .alias("string")
    .name("string")
    .build());

    observability_project_resource = ec.ObservabilityProject("observabilityProjectResource",
    region_id="string",
    alias="string",
    name="string")

    const observabilityProjectResource = new ec.ObservabilityProject("observabilityProjectResource", {
    regionId: "string",
    alias: "string",
    name: "string",
});

    type: ec:ObservabilityProject
properties:
    alias: string
    name: string
    regionId: string

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

    RegionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    Alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    Name string
    Descriptive name for a project.
    RegionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    Alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    Name string
    Descriptive name for a project.
    regionId String
    Unique human-readable identifier for a region in Elastic Cloud.
    alias String
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    name String
    Descriptive name for a project.
    regionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    name string
    Descriptive name for a project.
    region_id str
    Unique human-readable identifier for a region in Elastic Cloud.
    alias str
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    name str
    Descriptive name for a project.
    regionId String
    Unique human-readable identifier for a region in Elastic Cloud.
    alias String
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    name String
    Descriptive name for a project.

    Outputs

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

    CloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    Credentials Pulumi.ElasticCloud.Outputs.ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    Endpoints Pulumi.ElasticCloud.Outputs.ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata Pulumi.ElasticCloud.Outputs.ObservabilityProjectMetadata
    Additional details about the project.
    Type string
    the type of the project
    CloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    Credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    Endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata ObservabilityProjectMetadata
    Additional details about the project.
    Type string
    the type of the project
    cloudId String
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata ObservabilityProjectMetadata
    Additional details about the project.
    type String
    the type of the project
    cloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    id string
    The provider-assigned unique ID for this managed resource.
    metadata ObservabilityProjectMetadata
    Additional details about the project.
    type string
    the type of the project
    cloud_id str
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    id str
    The provider-assigned unique ID for this managed resource.
    metadata ObservabilityProjectMetadata
    Additional details about the project.
    type str
    the type of the project
    cloudId String
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials Property Map
    Basic auth credentials to access the Elasticsearch API.
    endpoints Property Map
    The endpoints to access the different apps of the project.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Property Map
    Additional details about the project.
    type String
    the type of the project

    Look up Existing ObservabilityProject Resource

    Get an existing ObservabilityProject 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?: ObservabilityProjectState, opts?: CustomResourceOptions): ObservabilityProject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        cloud_id: Optional[str] = None,
        credentials: Optional[ObservabilityProjectCredentialsArgs] = None,
        endpoints: Optional[ObservabilityProjectEndpointsArgs] = None,
        metadata: Optional[ObservabilityProjectMetadataArgs] = None,
        name: Optional[str] = None,
        region_id: Optional[str] = None,
        type: Optional[str] = None) -> ObservabilityProject
    func GetObservabilityProject(ctx *Context, name string, id IDInput, state *ObservabilityProjectState, opts ...ResourceOption) (*ObservabilityProject, error)
    public static ObservabilityProject Get(string name, Input<string> id, ObservabilityProjectState? state, CustomResourceOptions? opts = null)
    public static ObservabilityProject get(String name, Output<String> id, ObservabilityProjectState 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:
    Alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    CloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    Credentials Pulumi.ElasticCloud.Inputs.ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    Endpoints Pulumi.ElasticCloud.Inputs.ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    Metadata Pulumi.ElasticCloud.Inputs.ObservabilityProjectMetadata
    Additional details about the project.
    Name string
    Descriptive name for a project.
    RegionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    Type string
    the type of the project
    Alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    CloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    Credentials ObservabilityProjectCredentialsArgs
    Basic auth credentials to access the Elasticsearch API.
    Endpoints ObservabilityProjectEndpointsArgs
    The endpoints to access the different apps of the project.
    Metadata ObservabilityProjectMetadataArgs
    Additional details about the project.
    Name string
    Descriptive name for a project.
    RegionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    Type string
    the type of the project
    alias String
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    cloudId String
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    metadata ObservabilityProjectMetadata
    Additional details about the project.
    name String
    Descriptive name for a project.
    regionId String
    Unique human-readable identifier for a region in Elastic Cloud.
    type String
    the type of the project
    alias string
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    cloudId string
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentials
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpoints
    The endpoints to access the different apps of the project.
    metadata ObservabilityProjectMetadata
    Additional details about the project.
    name string
    Descriptive name for a project.
    regionId string
    Unique human-readable identifier for a region in Elastic Cloud.
    type string
    the type of the project
    alias str
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    cloud_id str
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials ObservabilityProjectCredentialsArgs
    Basic auth credentials to access the Elasticsearch API.
    endpoints ObservabilityProjectEndpointsArgs
    The endpoints to access the different apps of the project.
    metadata ObservabilityProjectMetadataArgs
    Additional details about the project.
    name str
    Descriptive name for a project.
    region_id str
    Unique human-readable identifier for a region in Elastic Cloud.
    type str
    the type of the project
    alias String
    A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
    cloudId String
    The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
    credentials Property Map
    Basic auth credentials to access the Elasticsearch API.
    endpoints Property Map
    The endpoints to access the different apps of the project.
    metadata Property Map
    Additional details about the project.
    name String
    Descriptive name for a project.
    regionId String
    Unique human-readable identifier for a region in Elastic Cloud.
    type String
    the type of the project

    Supporting Types

    ObservabilityProjectCredentials, ObservabilityProjectCredentialsArgs

    Password string
    Basic auth password that can be used to access the Elasticsearch API.
    Username string
    Basic auth username that can be used to access the Elasticsearch API.
    Password string
    Basic auth password that can be used to access the Elasticsearch API.
    Username string
    Basic auth username that can be used to access the Elasticsearch API.
    password String
    Basic auth password that can be used to access the Elasticsearch API.
    username String
    Basic auth username that can be used to access the Elasticsearch API.
    password string
    Basic auth password that can be used to access the Elasticsearch API.
    username string
    Basic auth username that can be used to access the Elasticsearch API.
    password str
    Basic auth password that can be used to access the Elasticsearch API.
    username str
    Basic auth username that can be used to access the Elasticsearch API.
    password String
    Basic auth password that can be used to access the Elasticsearch API.
    username String
    Basic auth username that can be used to access the Elasticsearch API.

    ObservabilityProjectEndpoints, ObservabilityProjectEndpointsArgs

    Apm string
    The endpoint to access apm.
    Elasticsearch string
    The endpoint to access elasticsearch.
    Kibana string
    The endpoint to access kibana.
    Apm string
    The endpoint to access apm.
    Elasticsearch string
    The endpoint to access elasticsearch.
    Kibana string
    The endpoint to access kibana.
    apm String
    The endpoint to access apm.
    elasticsearch String
    The endpoint to access elasticsearch.
    kibana String
    The endpoint to access kibana.
    apm string
    The endpoint to access apm.
    elasticsearch string
    The endpoint to access elasticsearch.
    kibana string
    The endpoint to access kibana.
    apm str
    The endpoint to access apm.
    elasticsearch str
    The endpoint to access elasticsearch.
    kibana str
    The endpoint to access kibana.
    apm String
    The endpoint to access apm.
    elasticsearch String
    The endpoint to access elasticsearch.
    kibana String
    The endpoint to access kibana.

    ObservabilityProjectMetadata, ObservabilityProjectMetadataArgs

    CreatedAt string
    Date and time when the project was created.
    CreatedBy string
    ID of the user.
    OrganizationId string
    The Organization ID who owns the project.
    SuspendedAt string
    Date and time when the project was suspended.
    SuspendedReason string
    Reason why the project was suspended.
    CreatedAt string
    Date and time when the project was created.
    CreatedBy string
    ID of the user.
    OrganizationId string
    The Organization ID who owns the project.
    SuspendedAt string
    Date and time when the project was suspended.
    SuspendedReason string
    Reason why the project was suspended.
    createdAt String
    Date and time when the project was created.
    createdBy String
    ID of the user.
    organizationId String
    The Organization ID who owns the project.
    suspendedAt String
    Date and time when the project was suspended.
    suspendedReason String
    Reason why the project was suspended.
    createdAt string
    Date and time when the project was created.
    createdBy string
    ID of the user.
    organizationId string
    The Organization ID who owns the project.
    suspendedAt string
    Date and time when the project was suspended.
    suspendedReason string
    Reason why the project was suspended.
    created_at str
    Date and time when the project was created.
    created_by str
    ID of the user.
    organization_id str
    The Organization ID who owns the project.
    suspended_at str
    Date and time when the project was suspended.
    suspended_reason str
    Reason why the project was suspended.
    createdAt String
    Date and time when the project was created.
    createdBy String
    ID of the user.
    organizationId String
    The Organization ID who owns the project.
    suspendedAt String
    Date and time when the project was suspended.
    suspendedReason String
    Reason why the project was suspended.

    Import

    Projects can be imported using the id, for example:

    $ pulumi import ec:index/observabilityProject:ObservabilityProject id 320b7b540dfc967a7a649c18e2fce4ed

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

    Package Details

    Repository
    ec pulumi/pulumi-ec
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ec Terraform Provider.
    ec logo
    ElasticCloud (EC) v0.9.0 published on Friday, Aug 30, 2024 by Pulumi
    pulumi/pulumi-ec