ElasticCloud (EC) v0.10.2, Oct 2 24

ElasticCloud (EC) v0.10.2 published on Wednesday, Oct 2, 2024 by Pulumi

ec.getDeploymentTemplates

Explore with Pulumi AI

ElasticCloud (EC) v0.10.2 published on Wednesday, Oct 2, 2024 by Pulumi

Example Usage

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

const example = ec.getDeploymentTemplates({
    region: "us-east-1",
});
const myDeployment = new ec.Deployment("my_deployment", {
    name: "My Deployment",
    version: "8.12.2",
    region: allTemplates.region,
    deploymentTemplateId: allTemplates.templates[0].id,
    elasticsearch: {
        hot: {
            autoscaling: {},
        },
    },
    kibana: {},
});

import pulumi
import pulumi_ec as ec

example = ec.get_deployment_templates(region="us-east-1")
my_deployment = ec.Deployment("my_deployment",
    name="My Deployment",
    version="8.12.2",
    region=all_templates["region"],
    deployment_template_id=all_templates["templates"][0]["id"],
    elasticsearch={
        "hot": {
            "autoscaling": {},
        },
    },
    kibana={})

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.GetDeploymentTemplates(ctx, &ec.GetDeploymentTemplatesArgs{
			Region: "us-east-1",
		}, nil)
		if err != nil {
			return err
		}
		_, err = ec.NewDeployment(ctx, "my_deployment", &ec.DeploymentArgs{
			Name:                 pulumi.String("My Deployment"),
			Version:              pulumi.String("8.12.2"),
			Region:               pulumi.Any(allTemplates.Region),
			DeploymentTemplateId: pulumi.Any(allTemplates.Templates[0].Id),
			Elasticsearch: &ec.DeploymentElasticsearchArgs{
				Hot: &ec.DeploymentElasticsearchHotArgs{
					Autoscaling: nil,
				},
			},
			Kibana: nil,
		})
		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 example = ElasticCloud.GetDeploymentTemplates.Invoke(new()
    {
        Region = "us-east-1",
    });

    var myDeployment = new ElasticCloud.Deployment("my_deployment", new()
    {
        Name = "My Deployment",
        Version = "8.12.2",
        Region = allTemplates.Region,
        DeploymentTemplateId = allTemplates.Templates[0].Id,
        Elasticsearch = new ElasticCloud.Inputs.DeploymentElasticsearchArgs
        {
            Hot = new ElasticCloud.Inputs.DeploymentElasticsearchHotArgs
            {
                Autoscaling = null,
            },
        },
        Kibana = null,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.EcFunctions;
import com.pulumi.ec.inputs.GetDeploymentTemplatesArgs;
import com.pulumi.ec.Deployment;
import com.pulumi.ec.DeploymentArgs;
import com.pulumi.ec.inputs.DeploymentElasticsearchArgs;
import com.pulumi.ec.inputs.DeploymentElasticsearchHotArgs;
import com.pulumi.ec.inputs.DeploymentElasticsearchHotAutoscalingArgs;
import com.pulumi.ec.inputs.DeploymentKibanaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = EcFunctions.getDeploymentTemplates(GetDeploymentTemplatesArgs.builder()
            .region("us-east-1")
            .build());

        var myDeployment = new Deployment("myDeployment", DeploymentArgs.builder()
            .name("My Deployment")
            .version("8.12.2")
            .region(allTemplates.region())
            .deploymentTemplateId(allTemplates.templates()[0].id())
            .elasticsearch(DeploymentElasticsearchArgs.builder()
                .hot(DeploymentElasticsearchHotArgs.builder()
                    .autoscaling()
                    .build())
                .build())
            .kibana()
            .build());

    }
}

resources:
  myDeployment:
    type: ec:Deployment
    name: my_deployment
    properties:
      name: My Deployment
      version: 8.12.2
      region: ${allTemplates.region}
      deploymentTemplateId: ${allTemplates.templates[0].id}
      elasticsearch:
        hot:
          autoscaling: {}
      kibana: {}
variables:
  example:
    fn::invoke:
      Function: ec:getDeploymentTemplates
      Arguments:
        region: us-east-1

Using getDeploymentTemplates

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

function getDeploymentTemplates(args: GetDeploymentTemplatesArgs, opts?: InvokeOptions): Promise<GetDeploymentTemplatesResult>
function getDeploymentTemplatesOutput(args: GetDeploymentTemplatesOutputArgs, opts?: InvokeOptions): Output<GetDeploymentTemplatesResult>

def get_deployment_templates(id: Optional[str] = None,
                             region: Optional[str] = None,
                             show_deprecated: Optional[bool] = None,
                             stack_version: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDeploymentTemplatesResult
def get_deployment_templates_output(id: Optional[pulumi.Input[str]] = None,
                             region: Optional[pulumi.Input[str]] = None,
                             show_deprecated: Optional[pulumi.Input[bool]] = None,
                             stack_version: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentTemplatesResult]

func GetDeploymentTemplates(ctx *Context, args *GetDeploymentTemplatesArgs, opts ...InvokeOption) (*GetDeploymentTemplatesResult, error)
func GetDeploymentTemplatesOutput(ctx *Context, args *GetDeploymentTemplatesOutputArgs, opts ...InvokeOption) GetDeploymentTemplatesResultOutput

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

public static class GetDeploymentTemplates 
{
    public static Task<GetDeploymentTemplatesResult> InvokeAsync(GetDeploymentTemplatesArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentTemplatesResult> Invoke(GetDeploymentTemplatesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentTemplatesResult> getDeploymentTemplates(GetDeploymentTemplatesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: ec:index/getDeploymentTemplates:getDeploymentTemplates
  arguments:
    # arguments dictionary

The following arguments are supported:

Region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
Id string: Filters for a deployment template with this id.
ShowDeprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
StackVersion string: Filters for deployment templates compatible with this stack version.

Region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
Id string: Filters for a deployment template with this id.
ShowDeprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
StackVersion string: Filters for deployment templates compatible with this stack version.

region String: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
id String: Filters for a deployment template with this id.
showDeprecated Boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion String: Filters for deployment templates compatible with this stack version.

region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
id string: Filters for a deployment template with this id.
showDeprecated boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion string: Filters for deployment templates compatible with this stack version.

region str: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
id str: Filters for a deployment template with this id.
show_deprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
stack_version str: Filters for deployment templates compatible with this stack version.

region String: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
id String: Filters for a deployment template with this id.
showDeprecated Boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion String: Filters for deployment templates compatible with this stack version.

getDeploymentTemplates Result

The following output properties are available:

Region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
Templates List<Pulumi.ElasticCloud.Outputs.GetDeploymentTemplatesTemplate>: List of available deployment templates.
Id string: Filters for a deployment template with this id.
ShowDeprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
StackVersion string: Filters for deployment templates compatible with this stack version.

Region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
Templates []GetDeploymentTemplatesTemplate: List of available deployment templates.
Id string: Filters for a deployment template with this id.
ShowDeprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
StackVersion string: Filters for deployment templates compatible with this stack version.

region String: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
templates List<GetDeploymentTemplatesTemplate>: List of available deployment templates.
id String: Filters for a deployment template with this id.
showDeprecated Boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion String: Filters for deployment templates compatible with this stack version.

region string: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
templates GetDeploymentTemplatesTemplate[]: List of available deployment templates.
id string: Filters for a deployment template with this id.
showDeprecated boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion string: Filters for deployment templates compatible with this stack version.

region str: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
templates Sequence[GetDeploymentTemplatesTemplate]: List of available deployment templates.
id str: Filters for a deployment template with this id.
show_deprecated bool: Enable to also show deprecated deployment templates. (Set to false by default.)
stack_version str: Filters for deployment templates compatible with this stack version.

region String: Region to select. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
templates List<Property Map>: List of available deployment templates.
id String: Filters for a deployment template with this id.
showDeprecated Boolean: Enable to also show deprecated deployment templates. (Set to false by default.)
stackVersion String: Filters for deployment templates compatible with this stack version.

Supporting Types

GetDeploymentTemplatesTemplate

Apm Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateApm: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Deprecated bool: Outdated templates are marked as deprecated, but can still be used.
Description string: The description of the deployment template.
Elasticsearch Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearch: Defines the default configuration for Elasticsearch.
EnterpriseSearch Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateEnterpriseSearch: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Id string: The id of the deployment template.
IntegrationsServer Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateIntegrationsServer: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Kibana Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateKibana: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
MinStackVersion string: The minimum stack version that can used with this deployment template.
Name string: The name of the deployment template.

Apm GetDeploymentTemplatesTemplateApm: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Deprecated bool: Outdated templates are marked as deprecated, but can still be used.
Description string: The description of the deployment template.
Elasticsearch GetDeploymentTemplatesTemplateElasticsearch: Defines the default configuration for Elasticsearch.
EnterpriseSearch GetDeploymentTemplatesTemplateEnterpriseSearch: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Id string: The id of the deployment template.
IntegrationsServer GetDeploymentTemplatesTemplateIntegrationsServer: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
Kibana GetDeploymentTemplatesTemplateKibana: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
MinStackVersion string: The minimum stack version that can used with this deployment template.
Name string: The name of the deployment template.

apm GetDeploymentTemplatesTemplateApm: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
deprecated Boolean: Outdated templates are marked as deprecated, but can still be used.
description String: The description of the deployment template.
elasticsearch GetDeploymentTemplatesTemplateElasticsearch: Defines the default configuration for Elasticsearch.
enterpriseSearch GetDeploymentTemplatesTemplateEnterpriseSearch: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
id String: The id of the deployment template.
integrationsServer GetDeploymentTemplatesTemplateIntegrationsServer: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
kibana GetDeploymentTemplatesTemplateKibana: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
minStackVersion String: The minimum stack version that can used with this deployment template.
name String: The name of the deployment template.

apm GetDeploymentTemplatesTemplateApm: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
deprecated boolean: Outdated templates are marked as deprecated, but can still be used.
description string: The description of the deployment template.
elasticsearch GetDeploymentTemplatesTemplateElasticsearch: Defines the default configuration for Elasticsearch.
enterpriseSearch GetDeploymentTemplatesTemplateEnterpriseSearch: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
id string: The id of the deployment template.
integrationsServer GetDeploymentTemplatesTemplateIntegrationsServer: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
kibana GetDeploymentTemplatesTemplateKibana: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
minStackVersion string: The minimum stack version that can used with this deployment template.
name string: The name of the deployment template.

apm GetDeploymentTemplatesTemplateApm: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
deprecated bool: Outdated templates are marked as deprecated, but can still be used.
description str: The description of the deployment template.
elasticsearch GetDeploymentTemplatesTemplateElasticsearch: Defines the default configuration for Elasticsearch.
enterprise_search GetDeploymentTemplatesTemplateEnterpriseSearch: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
id str: The id of the deployment template.
integrations_server GetDeploymentTemplatesTemplateIntegrationsServer: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
kibana GetDeploymentTemplatesTemplateKibana: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
min_stack_version str: The minimum stack version that can used with this deployment template.
name str: The name of the deployment template.

apm Property Map: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
deprecated Boolean: Outdated templates are marked as deprecated, but can still be used.
description String: The description of the deployment template.
elasticsearch Property Map: Defines the default configuration for Elasticsearch.
enterpriseSearch Property Map: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
id String: The id of the deployment template.
integrationsServer Property Map: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
kibana Property Map: Defines the default configuration for a stateless application (Kibana, Enterprise Search, APM or Integrations Server).
minStackVersion String: The minimum stack version that can used with this deployment template.
name String: The name of the deployment template.

GetDeploymentTemplatesTemplateApm

AvailableSizes List<string>
DefaultSize string
InstanceConfigurationId string
InstanceConfigurationVersion double
SizeResource string

AvailableSizes []string
DefaultSize string
InstanceConfigurationId string
InstanceConfigurationVersion float64
SizeResource string

availableSizes List<String>
defaultSize String
instanceConfigurationId String
instanceConfigurationVersion Double
sizeResource String

availableSizes string[]
defaultSize string
instanceConfigurationId string
instanceConfigurationVersion number
sizeResource string

available_sizes Sequence[str]
default_size str
instance_configuration_id str
instance_configuration_version float
size_resource str

availableSizes List<String>
defaultSize String
instanceConfigurationId String
instanceConfigurationVersion Number
sizeResource String

GetDeploymentTemplatesTemplateElasticsearch

Autoscale bool
Cold Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchCold: Defines the default configuration for each topology.
Coordinating Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchCoordinating: Defines the default configuration for each topology.
Frozen Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchFrozen: Defines the default configuration for each topology.
Hot Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchHot: Defines the default configuration for each topology.
Master Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchMaster: Defines the default configuration for each topology.
Ml Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchMl: Defines the default configuration for each topology.
Warm Pulumi.ElasticCloud.Inputs.GetDeploymentTemplatesTemplateElasticsearchWarm: Defines the default configuration for each topology.

Autoscale bool
Cold GetDeploymentTemplatesTemplateElasticsearchCold: Defines the default configuration for each topology.
Coordinating GetDeploymentTemplatesTemplateElasticsearchCoordinating: Defines the default configuration for each topology.
Frozen GetDeploymentTemplatesTemplateElasticsearchFrozen: Defines the default configuration for each topology.
Hot GetDeploymentTemplatesTemplateElasticsearchHot: Defines the default configuration for each topology.
Master GetDeploymentTemplatesTemplateElasticsearchMaster: Defines the default configuration for each topology.
Ml GetDeploymentTemplatesTemplateElasticsearchMl: Defines the default configuration for each topology.
Warm GetDeploymentTemplatesTemplateElasticsearchWarm: Defines the default configuration for each topology.

autoscale Boolean
cold GetDeploymentTemplatesTemplateElasticsearchCold: Defines the default configuration for each topology.
coordinating GetDeploymentTemplatesTemplateElasticsearchCoordinating: Defines the default configuration for each topology.
frozen GetDeploymentTemplatesTemplateElasticsearchFrozen: Defines the default configuration for each topology.
hot GetDeploymentTemplatesTemplateElasticsearchHot: Defines the default configuration for each topology.
master GetDeploymentTemplatesTemplateElasticsearchMaster: Defines the default configuration for each topology.
ml GetDeploymentTemplatesTemplateElasticsearchMl: Defines the default configuration for each topology.
warm GetDeploymentTemplatesTemplateElasticsearchWarm: Defines the default configuration for each topology.

autoscale boolean
cold GetDeploymentTemplatesTemplateElasticsearchCold: Defines the default configuration for each topology.
coordinating GetDeploymentTemplatesTemplateElasticsearchCoordinating: Defines the default configuration for each topology.
frozen GetDeploymentTemplatesTemplateElasticsearchFrozen: Defines the default configuration for each topology.
hot GetDeploymentTemplatesTemplateElasticsearchHot: Defines the default configuration for each topology.
master GetDeploymentTemplatesTemplateElasticsearchMaster: Defines the default configuration for each topology.
ml GetDeploymentTemplatesTemplateElasticsearchMl: Defines the default configuration for each topology.
warm GetDeploymentTemplatesTemplateElasticsearchWarm: Defines the default configuration for each topology.

autoscale bool
cold GetDeploymentTemplatesTemplateElasticsearchCold: Defines the default configuration for each topology.
coordinating GetDeploymentTemplatesTemplateElasticsearchCoordinating: Defines the default configuration for each topology.
frozen GetDeploymentTemplatesTemplateElasticsearchFrozen: Defines the default configuration for each topology.
hot GetDeploymentTemplatesTemplateElasticsearchHot: Defines the default configuration for each topology.
master GetDeploymentTemplatesTemplateElasticsearchMaster: Defines the default configuration for each topology.
ml GetDeploymentTemplatesTemplateElasticsearchMl: Defines the default configuration for each topology.
warm GetDeploymentTemplatesTemplateElasticsearchWarm: Defines the default configuration for each topology.

autoscale Boolean
cold Property Map: Defines the default configuration for each topology.
coordinating Property Map: Defines the default configuration for each topology.
frozen Property Map: Defines the default configuration for each topology.
hot Property Map: Defines the default configuration for each topology.
master Property Map: Defines the default configuration for each topology.
ml Property Map: Defines the default configuration for each topology.
warm Property Map: Defines the default configuration for each topology.

Package Details

Repository: ec pulumi/pulumi-ec
License: Apache-2.0
Notes: This Pulumi package is based on the ec Terraform Provider.

ElasticCloud (EC) v0.10.2 published on Wednesday, Oct 2, 2024 by Pulumi

pulumi/pulumi-ec

ec.getDeploymentTemplates

On this page

On this page

Example Usage

Using getDeploymentTemplates

getDeploymentTemplates Result

Supporting Types

GetDeploymentTemplatesTemplate

GetDeploymentTemplatesTemplateApm

GetDeploymentTemplatesTemplateElasticsearch

GetDeploymentTemplatesTemplateElasticsearchCold

GetDeploymentTemplatesTemplateElasticsearchColdAutoscaling

GetDeploymentTemplatesTemplateElasticsearchCoordinating

GetDeploymentTemplatesTemplateElasticsearchCoordinatingAutoscaling

GetDeploymentTemplatesTemplateElasticsearchFrozen

GetDeploymentTemplatesTemplateElasticsearchFrozenAutoscaling

GetDeploymentTemplatesTemplateElasticsearchHot

GetDeploymentTemplatesTemplateElasticsearchHotAutoscaling

GetDeploymentTemplatesTemplateElasticsearchMaster

GetDeploymentTemplatesTemplateElasticsearchMasterAutoscaling

GetDeploymentTemplatesTemplateElasticsearchMl

GetDeploymentTemplatesTemplateElasticsearchMlAutoscaling

GetDeploymentTemplatesTemplateElasticsearchWarm

GetDeploymentTemplatesTemplateElasticsearchWarmAutoscaling

GetDeploymentTemplatesTemplateEnterpriseSearch

GetDeploymentTemplatesTemplateIntegrationsServer

GetDeploymentTemplatesTemplateKibana

Package Details

On this page

On this page