1. Packages
  2. OVH
  3. API Docs
  4. Dbaas
  5. LogsOutputOpenSearchIndex
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

ovh.Dbaas.LogsOutputOpenSearchIndex

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

    Creates a DBaaS Logs Opensearch output index.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const index = new ovh.dbaas.LogsOutputOpenSearchIndex("index", {
        description: "my opensearch index",
        serviceName: "....",
        suffix: "index",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    index = ovh.dbaas.LogsOutputOpenSearchIndex("index",
        description="my opensearch index",
        service_name="....",
        suffix="index")
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Dbaas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Dbaas.NewLogsOutputOpenSearchIndex(ctx, "index", &Dbaas.LogsOutputOpenSearchIndexArgs{
    			Description: pulumi.String("my opensearch index"),
    			ServiceName: pulumi.String("...."),
    			Suffix:      pulumi.String("index"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var index = new Ovh.Dbaas.LogsOutputOpenSearchIndex("index", new()
        {
            Description = "my opensearch index",
            ServiceName = "....",
            Suffix = "index",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.Dbaas.LogsOutputOpenSearchIndex;
    import com.pulumi.ovh.Dbaas.LogsOutputOpenSearchIndexArgs;
    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 index = new LogsOutputOpenSearchIndex("index", LogsOutputOpenSearchIndexArgs.builder()
                .description("my opensearch index")
                .serviceName("....")
                .suffix("index")
                .build());
    
        }
    }
    
    resources:
      index:
        type: ovh:Dbaas:LogsOutputOpenSearchIndex
        properties:
          description: my opensearch index
          serviceName: '....'
          suffix: index
    

    Create LogsOutputOpenSearchIndex Resource

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

    Constructor syntax

    new LogsOutputOpenSearchIndex(name: string, args: LogsOutputOpenSearchIndexArgs, opts?: CustomResourceOptions);
    @overload
    def LogsOutputOpenSearchIndex(resource_name: str,
                                  args: LogsOutputOpenSearchIndexArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def LogsOutputOpenSearchIndex(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  description: Optional[str] = None,
                                  nb_shard: Optional[int] = None,
                                  service_name: Optional[str] = None,
                                  suffix: Optional[str] = None)
    func NewLogsOutputOpenSearchIndex(ctx *Context, name string, args LogsOutputOpenSearchIndexArgs, opts ...ResourceOption) (*LogsOutputOpenSearchIndex, error)
    public LogsOutputOpenSearchIndex(string name, LogsOutputOpenSearchIndexArgs args, CustomResourceOptions? opts = null)
    public LogsOutputOpenSearchIndex(String name, LogsOutputOpenSearchIndexArgs args)
    public LogsOutputOpenSearchIndex(String name, LogsOutputOpenSearchIndexArgs args, CustomResourceOptions options)
    
    type: ovh:Dbaas:LogsOutputOpenSearchIndex
    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 LogsOutputOpenSearchIndexArgs
    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 LogsOutputOpenSearchIndexArgs
    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 LogsOutputOpenSearchIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogsOutputOpenSearchIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogsOutputOpenSearchIndexArgs
    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 logsOutputOpenSearchIndexResource = new Ovh.Dbaas.LogsOutputOpenSearchIndex("logsOutputOpenSearchIndexResource", new()
    {
        Description = "string",
        NbShard = 0,
        ServiceName = "string",
        Suffix = "string",
    });
    
    example, err := Dbaas.NewLogsOutputOpenSearchIndex(ctx, "logsOutputOpenSearchIndexResource", &Dbaas.LogsOutputOpenSearchIndexArgs{
    	Description: pulumi.String("string"),
    	NbShard:     pulumi.Int(0),
    	ServiceName: pulumi.String("string"),
    	Suffix:      pulumi.String("string"),
    })
    
    var logsOutputOpenSearchIndexResource = new LogsOutputOpenSearchIndex("logsOutputOpenSearchIndexResource", LogsOutputOpenSearchIndexArgs.builder()
        .description("string")
        .nbShard(0)
        .serviceName("string")
        .suffix("string")
        .build());
    
    logs_output_open_search_index_resource = ovh.dbaas.LogsOutputOpenSearchIndex("logsOutputOpenSearchIndexResource",
        description="string",
        nb_shard=0,
        service_name="string",
        suffix="string")
    
    const logsOutputOpenSearchIndexResource = new ovh.dbaas.LogsOutputOpenSearchIndex("logsOutputOpenSearchIndexResource", {
        description: "string",
        nbShard: 0,
        serviceName: "string",
        suffix: "string",
    });
    
    type: ovh:Dbaas:LogsOutputOpenSearchIndex
    properties:
        description: string
        nbShard: 0
        serviceName: string
        suffix: string
    

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

    Description string
    Index description
    NbShard int
    Number of shards
    ServiceName string
    The service name
    Suffix string
    Index suffix
    Description string
    Index description
    NbShard int
    Number of shards
    ServiceName string
    The service name
    Suffix string
    Index suffix
    description String
    Index description
    nbShard Integer
    Number of shards
    serviceName String
    The service name
    suffix String
    Index suffix
    description string
    Index description
    nbShard number
    Number of shards
    serviceName string
    The service name
    suffix string
    Index suffix
    description str
    Index description
    nb_shard int
    Number of shards
    service_name str
    The service name
    suffix str
    Index suffix
    description String
    Index description
    nbShard Number
    Number of shards
    serviceName String
    The service name
    suffix String
    Index suffix

    Outputs

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

    AlertNotifyEnabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    CreatedAt string
    Index creation
    CurrentSize int
    Current index size (in bytes)
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    Index ID
    IsEditable bool
    Indicates if you are allowed to edit entry
    MaxSize int
    Maximum index size (in bytes)
    Name string
    Index name
    UpdatedAt string
    Index last update
    AlertNotifyEnabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    CreatedAt string
    Index creation
    CurrentSize int
    Current index size (in bytes)
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    Index ID
    IsEditable bool
    Indicates if you are allowed to edit entry
    MaxSize int
    Maximum index size (in bytes)
    Name string
    Index name
    UpdatedAt string
    Index last update
    alertNotifyEnabled Boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt String
    Index creation
    currentSize Integer
    Current index size (in bytes)
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    Index ID
    isEditable Boolean
    Indicates if you are allowed to edit entry
    maxSize Integer
    Maximum index size (in bytes)
    name String
    Index name
    updatedAt String
    Index last update
    alertNotifyEnabled boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt string
    Index creation
    currentSize number
    Current index size (in bytes)
    id string
    The provider-assigned unique ID for this managed resource.
    indexId string
    Index ID
    isEditable boolean
    Indicates if you are allowed to edit entry
    maxSize number
    Maximum index size (in bytes)
    name string
    Index name
    updatedAt string
    Index last update
    alert_notify_enabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    created_at str
    Index creation
    current_size int
    Current index size (in bytes)
    id str
    The provider-assigned unique ID for this managed resource.
    index_id str
    Index ID
    is_editable bool
    Indicates if you are allowed to edit entry
    max_size int
    Maximum index size (in bytes)
    name str
    Index name
    updated_at str
    Index last update
    alertNotifyEnabled Boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt String
    Index creation
    currentSize Number
    Current index size (in bytes)
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    Index ID
    isEditable Boolean
    Indicates if you are allowed to edit entry
    maxSize Number
    Maximum index size (in bytes)
    name String
    Index name
    updatedAt String
    Index last update

    Look up Existing LogsOutputOpenSearchIndex Resource

    Get an existing LogsOutputOpenSearchIndex 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?: LogsOutputOpenSearchIndexState, opts?: CustomResourceOptions): LogsOutputOpenSearchIndex
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_notify_enabled: Optional[bool] = None,
            created_at: Optional[str] = None,
            current_size: Optional[int] = None,
            description: Optional[str] = None,
            index_id: Optional[str] = None,
            is_editable: Optional[bool] = None,
            max_size: Optional[int] = None,
            name: Optional[str] = None,
            nb_shard: Optional[int] = None,
            service_name: Optional[str] = None,
            suffix: Optional[str] = None,
            updated_at: Optional[str] = None) -> LogsOutputOpenSearchIndex
    func GetLogsOutputOpenSearchIndex(ctx *Context, name string, id IDInput, state *LogsOutputOpenSearchIndexState, opts ...ResourceOption) (*LogsOutputOpenSearchIndex, error)
    public static LogsOutputOpenSearchIndex Get(string name, Input<string> id, LogsOutputOpenSearchIndexState? state, CustomResourceOptions? opts = null)
    public static LogsOutputOpenSearchIndex get(String name, Output<String> id, LogsOutputOpenSearchIndexState 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:
    AlertNotifyEnabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    CreatedAt string
    Index creation
    CurrentSize int
    Current index size (in bytes)
    Description string
    Index description
    IndexId string
    Index ID
    IsEditable bool
    Indicates if you are allowed to edit entry
    MaxSize int
    Maximum index size (in bytes)
    Name string
    Index name
    NbShard int
    Number of shards
    ServiceName string
    The service name
    Suffix string
    Index suffix
    UpdatedAt string
    Index last update
    AlertNotifyEnabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    CreatedAt string
    Index creation
    CurrentSize int
    Current index size (in bytes)
    Description string
    Index description
    IndexId string
    Index ID
    IsEditable bool
    Indicates if you are allowed to edit entry
    MaxSize int
    Maximum index size (in bytes)
    Name string
    Index name
    NbShard int
    Number of shards
    ServiceName string
    The service name
    Suffix string
    Index suffix
    UpdatedAt string
    Index last update
    alertNotifyEnabled Boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt String
    Index creation
    currentSize Integer
    Current index size (in bytes)
    description String
    Index description
    indexId String
    Index ID
    isEditable Boolean
    Indicates if you are allowed to edit entry
    maxSize Integer
    Maximum index size (in bytes)
    name String
    Index name
    nbShard Integer
    Number of shards
    serviceName String
    The service name
    suffix String
    Index suffix
    updatedAt String
    Index last update
    alertNotifyEnabled boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt string
    Index creation
    currentSize number
    Current index size (in bytes)
    description string
    Index description
    indexId string
    Index ID
    isEditable boolean
    Indicates if you are allowed to edit entry
    maxSize number
    Maximum index size (in bytes)
    name string
    Index name
    nbShard number
    Number of shards
    serviceName string
    The service name
    suffix string
    Index suffix
    updatedAt string
    Index last update
    alert_notify_enabled bool
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    created_at str
    Index creation
    current_size int
    Current index size (in bytes)
    description str
    Index description
    index_id str
    Index ID
    is_editable bool
    Indicates if you are allowed to edit entry
    max_size int
    Maximum index size (in bytes)
    name str
    Index name
    nb_shard int
    Number of shards
    service_name str
    The service name
    suffix str
    Index suffix
    updated_at str
    Index last update
    alertNotifyEnabled Boolean
    If set, notify when size is near 80, 90 or 100 % of its maximum capacity
    createdAt String
    Index creation
    currentSize Number
    Current index size (in bytes)
    description String
    Index description
    indexId String
    Index ID
    isEditable Boolean
    Indicates if you are allowed to edit entry
    maxSize Number
    Maximum index size (in bytes)
    name String
    Index name
    nbShard Number
    Number of shards
    serviceName String
    The service name
    suffix String
    Index suffix
    updatedAt String
    Index last update

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud