Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. ElasticsearchMlCalendar
Viewing docs for elasticstack 0.16.0
published on Monday, May 25, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.ElasticsearchMlCalendar

Viewing docs for elasticstack 0.16.0
published on Monday, May 25, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Manages Machine Learning calendars (the calendar definition only). To attach anomaly detection jobs to a calendar, use elasticstack.ElasticsearchMlCalendarJob. See the ML put calendar API for more details. Import id format: <cluster_uuid>/<calendar_id> (the same value as the computed id attribute).

    Create ElasticsearchMlCalendar Resource

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

    Constructor syntax

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

@overload
def ElasticsearchMlCalendar(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            calendar_id: Optional[str] = None,
                            description: Optional[str] = None,
                            elasticsearch_connections: Optional[Sequence[ElasticsearchMlCalendarElasticsearchConnectionArgs]] = None)
    func NewElasticsearchMlCalendar(ctx *Context, name string, args ElasticsearchMlCalendarArgs, opts ...ResourceOption) (*ElasticsearchMlCalendar, error)
    public ElasticsearchMlCalendar(string name, ElasticsearchMlCalendarArgs args, CustomResourceOptions? opts = null)
    public ElasticsearchMlCalendar(String name, ElasticsearchMlCalendarArgs args)
public ElasticsearchMlCalendar(String name, ElasticsearchMlCalendarArgs args, CustomResourceOptions options)

    type: elasticstack:ElasticsearchMlCalendar
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "elasticstack_elasticsearchmlcalendar" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ElasticsearchMlCalendarArgs
    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 ElasticsearchMlCalendarArgs
    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 ElasticsearchMlCalendarArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticsearchMlCalendarArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticsearchMlCalendarArgs
    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 elasticsearchMlCalendarResource = new Elasticstack.ElasticsearchMlCalendar("elasticsearchMlCalendarResource", new()
{
    CalendarId = "string",
    Description = "string",
    ElasticsearchConnections = new[]
    {
        new Elasticstack.Inputs.ElasticsearchMlCalendarElasticsearchConnectionArgs
        {
            ApiKey = "string",
            BearerToken = "string",
            CaData = "string",
            CaFile = "string",
            CertData = "string",
            CertFile = "string",
            Endpoints = new[]
            {
                "string",
            },
            EsClientAuthentication = "string",
            Headers = 
            {
                { "string", "string" },
            },
            Insecure = false,
            KeyData = "string",
            KeyFile = "string",
            Password = "string",
            Username = "string",
        },
    },
});

    example, err := elasticstack.NewElasticsearchMlCalendar(ctx, "elasticsearchMlCalendarResource", &elasticstack.ElasticsearchMlCalendarArgs{
	CalendarId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	ElasticsearchConnections: elasticstack.ElasticsearchMlCalendarElasticsearchConnectionArray{
		&elasticstack.ElasticsearchMlCalendarElasticsearchConnectionArgs{
			ApiKey:      pulumi.String("string"),
			BearerToken: pulumi.String("string"),
			CaData:      pulumi.String("string"),
			CaFile:      pulumi.String("string"),
			CertData:    pulumi.String("string"),
			CertFile:    pulumi.String("string"),
			Endpoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			EsClientAuthentication: pulumi.String("string"),
			Headers: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Insecure: pulumi.Bool(false),
			KeyData:  pulumi.String("string"),
			KeyFile:  pulumi.String("string"),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
	},
})

    resource "elasticstack_elasticsearchmlcalendar" "elasticsearchMlCalendarResource" {
  calendar_id = "string"
  description = "string"
  elasticsearch_connections {
    api_key                  = "string"
    bearer_token             = "string"
    ca_data                  = "string"
    ca_file                  = "string"
    cert_data                = "string"
    cert_file                = "string"
    endpoints                = ["string"]
    es_client_authentication = "string"
    headers = {
      "string" = "string"
    }
    insecure = false
    key_data = "string"
    key_file = "string"
    password = "string"
    username = "string"
  }
}

    var elasticsearchMlCalendarResource = new ElasticsearchMlCalendar("elasticsearchMlCalendarResource", ElasticsearchMlCalendarArgs.builder()
    .calendarId("string")
    .description("string")
    .elasticsearchConnections(ElasticsearchMlCalendarElasticsearchConnectionArgs.builder()
        .apiKey("string")
        .bearerToken("string")
        .caData("string")
        .caFile("string")
        .certData("string")
        .certFile("string")
        .endpoints("string")
        .esClientAuthentication("string")
        .headers(Map.of("string", "string"))
        .insecure(false)
        .keyData("string")
        .keyFile("string")
        .password("string")
        .username("string")
        .build())
    .build());

    elasticsearch_ml_calendar_resource = elasticstack.ElasticsearchMlCalendar("elasticsearchMlCalendarResource",
    calendar_id="string",
    description="string",
    elasticsearch_connections=[{
        "api_key": "string",
        "bearer_token": "string",
        "ca_data": "string",
        "ca_file": "string",
        "cert_data": "string",
        "cert_file": "string",
        "endpoints": ["string"],
        "es_client_authentication": "string",
        "headers": {
            "string": "string",
        },
        "insecure": False,
        "key_data": "string",
        "key_file": "string",
        "password": "string",
        "username": "string",
    }])

    const elasticsearchMlCalendarResource = new elasticstack.ElasticsearchMlCalendar("elasticsearchMlCalendarResource", {
    calendarId: "string",
    description: "string",
    elasticsearchConnections: [{
        apiKey: "string",
        bearerToken: "string",
        caData: "string",
        caFile: "string",
        certData: "string",
        certFile: "string",
        endpoints: ["string"],
        esClientAuthentication: "string",
        headers: {
            string: "string",
        },
        insecure: false,
        keyData: "string",
        keyFile: "string",
        password: "string",
        username: "string",
    }],
});

    type: elasticstack:ElasticsearchMlCalendar
properties:
    calendarId: string
    description: string
    elasticsearchConnections:
        - apiKey: string
          bearerToken: string
          caData: string
          caFile: string
          certData: string
          certFile: string
          endpoints:
            - string
          esClientAuthentication: string
          headers:
            string: string
          insecure: false
          keyData: string
          keyFile: string
          password: string
          username: string

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

    CalendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    Description string
    A description of the calendar.
    ElasticsearchConnections List<ElasticsearchMlCalendarElasticsearchConnection>
    Elasticsearch connection configuration block.
    CalendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    Description string
    A description of the calendar.
    ElasticsearchConnections []ElasticsearchMlCalendarElasticsearchConnectionArgs
    Elasticsearch connection configuration block.
    calendar_id string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description string
    A description of the calendar.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    calendarId String
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description String
    A description of the calendar.
    elasticsearchConnections List<ElasticsearchMlCalendarElasticsearchConnection>
    Elasticsearch connection configuration block.
    calendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description string
    A description of the calendar.
    elasticsearchConnections ElasticsearchMlCalendarElasticsearchConnection[]
    Elasticsearch connection configuration block.
    calendar_id str
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description str
    A description of the calendar.
    elasticsearch_connections Sequence[ElasticsearchMlCalendarElasticsearchConnectionArgs]
    Elasticsearch connection configuration block.
    calendarId String
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description String
    A description of the calendar.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.

    Outputs

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

    Get an existing ElasticsearchMlCalendar 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?: ElasticsearchMlCalendarState, opts?: CustomResourceOptions): ElasticsearchMlCalendar
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        calendar_id: Optional[str] = None,
        description: Optional[str] = None,
        elasticsearch_connections: Optional[Sequence[ElasticsearchMlCalendarElasticsearchConnectionArgs]] = None) -> ElasticsearchMlCalendar
    func GetElasticsearchMlCalendar(ctx *Context, name string, id IDInput, state *ElasticsearchMlCalendarState, opts ...ResourceOption) (*ElasticsearchMlCalendar, error)
    public static ElasticsearchMlCalendar Get(string name, Input<string> id, ElasticsearchMlCalendarState? state, CustomResourceOptions? opts = null)
    public static ElasticsearchMlCalendar get(String name, Output<String> id, ElasticsearchMlCalendarState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:ElasticsearchMlCalendar    get:      id: ${id}
    import {
  to = elasticstack_elasticsearchmlcalendar.example
  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:
    CalendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    Description string
    A description of the calendar.
    ElasticsearchConnections List<ElasticsearchMlCalendarElasticsearchConnection>
    Elasticsearch connection configuration block.
    CalendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    Description string
    A description of the calendar.
    ElasticsearchConnections []ElasticsearchMlCalendarElasticsearchConnectionArgs
    Elasticsearch connection configuration block.
    calendar_id string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description string
    A description of the calendar.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    calendarId String
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description String
    A description of the calendar.
    elasticsearchConnections List<ElasticsearchMlCalendarElasticsearchConnection>
    Elasticsearch connection configuration block.
    calendarId string
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description string
    A description of the calendar.
    elasticsearchConnections ElasticsearchMlCalendarElasticsearchConnection[]
    Elasticsearch connection configuration block.
    calendar_id str
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description str
    A description of the calendar.
    elasticsearch_connections Sequence[ElasticsearchMlCalendarElasticsearchConnectionArgs]
    Elasticsearch connection configuration block.
    calendarId String
    A string that uniquely identifies a calendar. Must contain lowercase alphanumeric characters (a-z and 0-9), hyphens, or underscores. Must start and end with an alphanumeric character.
    description String
    A description of the calendar.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.

    Supporting Types

    ElasticsearchMlCalendarElasticsearchConnection, ElasticsearchMlCalendarElasticsearchConnectionArgs

    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints List<string>
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Headers Dictionary<string, string>
    A list of headers to be sent with each request to Elasticsearch.
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints []string
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Headers map[string]string
    A list of headers to be sent with each request to Elasticsearch.
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    api_key string
    API Key to use for authentication to Elasticsearch
    bearer_token string
    Bearer Token to use for authentication to Elasticsearch
    ca_data string
    PEM-encoded custom Certificate Authority certificate
    ca_file string
    Path to a custom Certificate Authority certificate
    cert_data string
    PEM encoded certificate for client auth
    cert_file string
    Path to a file containing the PEM encoded certificate for client auth
    endpoints list(string)
    es_client_authentication string
    ES Client Authentication field to be used with the JWT token
    headers map(string)
    A list of headers to be sent with each request to Elasticsearch.
    insecure bool
    Disable TLS certificate validation
    key_data string
    PEM encoded private key for client auth
    key_file string
    Path to a file containing the PEM encoded private key for client auth
    password string
    Password to use for API authentication to Elasticsearch.
    username string
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    headers Map<String,String>
    A list of headers to be sent with each request to Elasticsearch.
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.
    apiKey string
    API Key to use for authentication to Elasticsearch
    bearerToken string
    Bearer Token to use for authentication to Elasticsearch
    caData string
    PEM-encoded custom Certificate Authority certificate
    caFile string
    Path to a custom Certificate Authority certificate
    certData string
    PEM encoded certificate for client auth
    certFile string
    Path to a file containing the PEM encoded certificate for client auth
    endpoints string[]
    esClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    headers {[key: string]: string}
    A list of headers to be sent with each request to Elasticsearch.
    insecure boolean
    Disable TLS certificate validation
    keyData string
    PEM encoded private key for client auth
    keyFile string
    Path to a file containing the PEM encoded private key for client auth
    password string
    Password to use for API authentication to Elasticsearch.
    username string
    Username to use for API authentication to Elasticsearch.
    api_key str
    API Key to use for authentication to Elasticsearch
    bearer_token str
    Bearer Token to use for authentication to Elasticsearch
    ca_data str
    PEM-encoded custom Certificate Authority certificate
    ca_file str
    Path to a custom Certificate Authority certificate
    cert_data str
    PEM encoded certificate for client auth
    cert_file str
    Path to a file containing the PEM encoded certificate for client auth
    endpoints Sequence[str]
    es_client_authentication str
    ES Client Authentication field to be used with the JWT token
    headers Mapping[str, str]
    A list of headers to be sent with each request to Elasticsearch.
    insecure bool
    Disable TLS certificate validation
    key_data str
    PEM encoded private key for client auth
    key_file str
    Path to a file containing the PEM encoded private key for client auth
    password str
    Password to use for API authentication to Elasticsearch.
    username str
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    headers Map<String>
    A list of headers to be sent with each request to Elasticsearch.
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    Viewing docs for elasticstack 0.16.0
    published on Monday, May 25, 2026 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial