ElasticCloud (EC) v0.8.1, Jun 4 24

ElasticCloud (EC) v0.8.1 published on Tuesday, Jun 4, 2024 by Pulumi

ec.getDeployment

Explore with Pulumi AI

ElasticCloud (EC) v0.8.1 published on Tuesday, Jun 4, 2024 by Pulumi

Example Usage

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

const example = ec.getDeployment({
    id: "f759065e5e64e9f3546f6c44f2743893",
});

import pulumi
import pulumi_ec as ec

example = ec.get_deployment(id="f759065e5e64e9f3546f6c44f2743893")

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.LookupDeployment(ctx, &ec.LookupDeploymentArgs{
			Id: "f759065e5e64e9f3546f6c44f2743893",
		}, 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.GetDeployment.Invoke(new()
    {
        Id = "f759065e5e64e9f3546f6c44f2743893",
    });

});

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.GetDeploymentArgs;
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.getDeployment(GetDeploymentArgs.builder()
            .id("f759065e5e64e9f3546f6c44f2743893")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: ec:getDeployment
      Arguments:
        id: f759065e5e64e9f3546f6c44f2743893

Using getDeployment

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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>

def get_deployment(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]

func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Id string: The unique ID of the deployment.

Id string: The unique ID of the deployment.

id String: The unique ID of the deployment.

id string: The unique ID of the deployment.

id str: The unique ID of the deployment.

id String: The unique ID of the deployment.

getDeployment Result

The following output properties are available:

Alias string: Deployment alias.
Apms List<Pulumi.ElasticCloud.Outputs.GetDeploymentApm>: Instance configuration of the APM type.
DeploymentTemplateId string: ID of the deployment template this deployment is based off.
Elasticsearches List<Pulumi.ElasticCloud.Outputs.GetDeploymentElasticsearch>: Instance configuration of the Elasticsearch Elasticsearch resource.
EnterpriseSearches List<Pulumi.ElasticCloud.Outputs.GetDeploymentEnterpriseSearch>: Instance configuration of the Enterprise Search type.
Healthy bool: Overall health status of the deployment.
Id string: The unique ID of the deployment.
IntegrationsServers List<Pulumi.ElasticCloud.Outputs.GetDeploymentIntegrationsServer>: Instance configuration of the Integrations Server type.
Kibanas List<Pulumi.ElasticCloud.Outputs.GetDeploymentKibana>: Instance configuration of the Kibana type.
Name string: The name of the deployment.
Observabilities List<Pulumi.ElasticCloud.Outputs.GetDeploymentObservability>: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
Region string: Region where the deployment is hosted.
Tags Dictionary<string, string>: Key value map of arbitrary string tags.
TrafficFilters List<string>: Traffic filter block, which contains a list of traffic filter rule identifiers.

Alias string: Deployment alias.
Apms []GetDeploymentApm: Instance configuration of the APM type.
DeploymentTemplateId string: ID of the deployment template this deployment is based off.
Elasticsearches []GetDeploymentElasticsearch: Instance configuration of the Elasticsearch Elasticsearch resource.
EnterpriseSearches []GetDeploymentEnterpriseSearch: Instance configuration of the Enterprise Search type.
Healthy bool: Overall health status of the deployment.
Id string: The unique ID of the deployment.
IntegrationsServers []GetDeploymentIntegrationsServer: Instance configuration of the Integrations Server type.
Kibanas []GetDeploymentKibana: Instance configuration of the Kibana type.
Name string: The name of the deployment.
Observabilities []GetDeploymentObservability: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
Region string: Region where the deployment is hosted.
Tags map[string]string: Key value map of arbitrary string tags.
TrafficFilters []string: Traffic filter block, which contains a list of traffic filter rule identifiers.

alias String: Deployment alias.
apms List<GetDeploymentApm>: Instance configuration of the APM type.
deploymentTemplateId String: ID of the deployment template this deployment is based off.
elasticsearches List<GetDeploymentElasticsearch>: Instance configuration of the Elasticsearch Elasticsearch resource.
enterpriseSearches List<GetDeploymentEnterpriseSearch>: Instance configuration of the Enterprise Search type.
healthy Boolean: Overall health status of the deployment.
id String: The unique ID of the deployment.
integrationsServers List<GetDeploymentIntegrationsServer>: Instance configuration of the Integrations Server type.
kibanas List<GetDeploymentKibana>: Instance configuration of the Kibana type.
name String: The name of the deployment.
observabilities List<GetDeploymentObservability>: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
region String: Region where the deployment is hosted.
tags Map<String,String>: Key value map of arbitrary string tags.
trafficFilters List<String>: Traffic filter block, which contains a list of traffic filter rule identifiers.

alias string: Deployment alias.
apms GetDeploymentApm[]: Instance configuration of the APM type.
deploymentTemplateId string: ID of the deployment template this deployment is based off.
elasticsearches GetDeploymentElasticsearch[]: Instance configuration of the Elasticsearch Elasticsearch resource.
enterpriseSearches GetDeploymentEnterpriseSearch[]: Instance configuration of the Enterprise Search type.
healthy boolean: Overall health status of the deployment.
id string: The unique ID of the deployment.
integrationsServers GetDeploymentIntegrationsServer[]: Instance configuration of the Integrations Server type.
kibanas GetDeploymentKibana[]: Instance configuration of the Kibana type.
name string: The name of the deployment.
observabilities GetDeploymentObservability[]: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
region string: Region where the deployment is hosted.
tags {[key: string]: string}: Key value map of arbitrary string tags.
trafficFilters string[]: Traffic filter block, which contains a list of traffic filter rule identifiers.

alias str: Deployment alias.
apms Sequence[GetDeploymentApm]: Instance configuration of the APM type.
deployment_template_id str: ID of the deployment template this deployment is based off.
elasticsearches Sequence[GetDeploymentElasticsearch]: Instance configuration of the Elasticsearch Elasticsearch resource.
enterprise_searches Sequence[GetDeploymentEnterpriseSearch]: Instance configuration of the Enterprise Search type.
healthy bool: Overall health status of the deployment.
id str: The unique ID of the deployment.
integrations_servers Sequence[GetDeploymentIntegrationsServer]: Instance configuration of the Integrations Server type.
kibanas Sequence[GetDeploymentKibana]: Instance configuration of the Kibana type.
name str: The name of the deployment.
observabilities Sequence[GetDeploymentObservability]: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
region str: Region where the deployment is hosted.
tags Mapping[str, str]: Key value map of arbitrary string tags.
traffic_filters Sequence[str]: Traffic filter block, which contains a list of traffic filter rule identifiers.

alias String: Deployment alias.
apms List<Property Map>: Instance configuration of the APM type.
deploymentTemplateId String: ID of the deployment template this deployment is based off.
elasticsearches List<Property Map>: Instance configuration of the Elasticsearch Elasticsearch resource.
enterpriseSearches List<Property Map>: Instance configuration of the Enterprise Search type.
healthy Boolean: Overall health status of the deployment.
id String: The unique ID of the deployment.
integrationsServers List<Property Map>: Instance configuration of the Integrations Server type.
kibanas List<Property Map>: Instance configuration of the Kibana type.
name String: The name of the deployment.
observabilities List<Property Map>: Observability settings. Information about logs and metrics shipped to a dedicated deployment.
region String: Region where the deployment is hosted.
tags Map<String>: Key value map of arbitrary string tags.
trafficFilters List<String>: Traffic filter block, which contains a list of traffic filter rule identifiers.

Supporting Types

GetDeploymentApm

ElasticsearchClusterRefId string: The locally-unique user-specified id of an APM Resource.
Healthy bool: APM resource health status.
HttpEndpoint string: HTTP endpoint for the APM resource.
HttpsEndpoint string: HTTPS endpoint for the APM resource.
RefId string: A locally-unique friendly alias for this APM resource.
ResourceId string: The resource unique identifier.
Status string: APM resource status (for example, "started", "stopped", etc).
Topologies List<Pulumi.ElasticCloud.Inputs.GetDeploymentApmTopology>: Node topology element definition.
Version string: Elastic stack version.

ElasticsearchClusterRefId string: The locally-unique user-specified id of an APM Resource.
Healthy bool: APM resource health status.
HttpEndpoint string: HTTP endpoint for the APM resource.
HttpsEndpoint string: HTTPS endpoint for the APM resource.
RefId string: A locally-unique friendly alias for this APM resource.
ResourceId string: The resource unique identifier.
Status string: APM resource status (for example, "started", "stopped", etc).
Topologies []GetDeploymentApmTopology: Node topology element definition.
Version string: Elastic stack version.

elasticsearchClusterRefId String: The locally-unique user-specified id of an APM Resource.
healthy Boolean: APM resource health status.
httpEndpoint String: HTTP endpoint for the APM resource.
httpsEndpoint String: HTTPS endpoint for the APM resource.
refId String: A locally-unique friendly alias for this APM resource.
resourceId String: The resource unique identifier.
status String: APM resource status (for example, "started", "stopped", etc).
topologies List<GetDeploymentApmTopology>: Node topology element definition.
version String: Elastic stack version.

elasticsearchClusterRefId string: The locally-unique user-specified id of an APM Resource.
healthy boolean: APM resource health status.
httpEndpoint string: HTTP endpoint for the APM resource.
httpsEndpoint string: HTTPS endpoint for the APM resource.
refId string: A locally-unique friendly alias for this APM resource.
resourceId string: The resource unique identifier.
status string: APM resource status (for example, "started", "stopped", etc).
topologies GetDeploymentApmTopology[]: Node topology element definition.
version string: Elastic stack version.

elasticsearch_cluster_ref_id str: The locally-unique user-specified id of an APM Resource.
healthy bool: APM resource health status.
http_endpoint str: HTTP endpoint for the APM resource.
https_endpoint str: HTTPS endpoint for the APM resource.
ref_id str: A locally-unique friendly alias for this APM resource.
resource_id str: The resource unique identifier.
status str: APM resource status (for example, "started", "stopped", etc).
topologies Sequence[GetDeploymentApmTopology]: Node topology element definition.
version str: Elastic stack version.

elasticsearchClusterRefId String: The locally-unique user-specified id of an APM Resource.
healthy Boolean: APM resource health status.
httpEndpoint String: HTTP endpoint for the APM resource.
httpsEndpoint String: HTTPS endpoint for the APM resource.
refId String: A locally-unique friendly alias for this APM resource.
resourceId String: The resource unique identifier.
status String: APM resource status (for example, "started", "stopped", etc).
topologies List<Property Map>: Node topology element definition.
version String: Elastic stack version.

GetDeploymentApmTopology

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Integer: Number of zones in which nodes will be placed.

instanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size string: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource string: Type of resource ("memory" or "storage")
zoneCount number: Number of zones in which nodes will be placed.

instance_configuration_id str: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size str: Amount of "size_resource" in Gigabytes. For example "4g".
size_resource str: Type of resource ("memory" or "storage")
zone_count int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Number: Number of zones in which nodes will be placed.

GetDeploymentElasticsearch

Autoscale string: Whether or not Elasticsearch autoscaling is enabled.
CloudId string: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See Configure Beats and Logstash with Cloud ID for more information.
Healthy bool: Elasticsearch resource health status.
HttpEndpoint string: HTTP endpoint for the Elasticsearch resource.
HttpsEndpoint string: HTTPS endpoint for the Elasticsearch resource.
RefId string: A locally-unique friendly alias for this Elasticsearch cluster.
ResourceId string: The resource unique identifier.
Status string: Elasticsearch resource status (for example, "started", "stopped", etc).
Topologies List<Pulumi.ElasticCloud.Inputs.GetDeploymentElasticsearchTopology>: Node topology element definition.
Version string: Elastic stack version.

Autoscale string: Whether or not Elasticsearch autoscaling is enabled.
CloudId string: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See Configure Beats and Logstash with Cloud ID for more information.
Healthy bool: Elasticsearch resource health status.
HttpEndpoint string: HTTP endpoint for the Elasticsearch resource.
HttpsEndpoint string: HTTPS endpoint for the Elasticsearch resource.
RefId string: A locally-unique friendly alias for this Elasticsearch cluster.
ResourceId string: The resource unique identifier.
Status string: Elasticsearch resource status (for example, "started", "stopped", etc).
Topologies []GetDeploymentElasticsearchTopology: Node topology element definition.
Version string: Elastic stack version.

autoscale String: Whether or not Elasticsearch autoscaling is enabled.
cloudId String: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See Configure Beats and Logstash with Cloud ID for more information.
healthy Boolean: Elasticsearch resource health status.
httpEndpoint String: HTTP endpoint for the Elasticsearch resource.
httpsEndpoint String: HTTPS endpoint for the Elasticsearch resource.
refId String: A locally-unique friendly alias for this Elasticsearch cluster.
resourceId String: The resource unique identifier.
status String: Elasticsearch resource status (for example, "started", "stopped", etc).
topologies List<GetDeploymentElasticsearchTopology>: Node topology element definition.
version String: Elastic stack version.

autoscale string: Whether or not Elasticsearch autoscaling is enabled.
cloudId string: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See Configure Beats and Logstash with Cloud ID for more information.
healthy boolean: Elasticsearch resource health status.
httpEndpoint string: HTTP endpoint for the Elasticsearch resource.
httpsEndpoint string: HTTPS endpoint for the Elasticsearch resource.
refId string: A locally-unique friendly alias for this Elasticsearch cluster.
resourceId string: The resource unique identifier.
status string: Elasticsearch resource status (for example, "started", "stopped", etc).
topologies GetDeploymentElasticsearchTopology[]: Node topology element definition.
version string: Elastic stack version.

autoscale str: Whether or not Elasticsearch autoscaling is enabled.
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. See Configure Beats and Logstash with Cloud ID for more information.
healthy bool: Elasticsearch resource health status.
http_endpoint str: HTTP endpoint for the Elasticsearch resource.
https_endpoint str: HTTPS endpoint for the Elasticsearch resource.
ref_id str: A locally-unique friendly alias for this Elasticsearch cluster.
resource_id str: The resource unique identifier.
status str: Elasticsearch resource status (for example, "started", "stopped", etc).
topologies Sequence[GetDeploymentElasticsearchTopology]: Node topology element definition.
version str: Elastic stack version.

autoscale String: Whether or not Elasticsearch autoscaling is enabled.
cloudId String: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See Configure Beats and Logstash with Cloud ID for more information.
healthy Boolean: Elasticsearch resource health status.
httpEndpoint String: HTTP endpoint for the Elasticsearch resource.
httpsEndpoint String: HTTPS endpoint for the Elasticsearch resource.
refId String: A locally-unique friendly alias for this Elasticsearch cluster.
resourceId String: The resource unique identifier.
status String: Elasticsearch resource status (for example, "started", "stopped", etc).
topologies List<Property Map>: Node topology element definition.
version String: Elastic stack version.

GetDeploymentElasticsearchTopology

Autoscalings List<Pulumi.ElasticCloud.Inputs.GetDeploymentElasticsearchTopologyAutoscaling>: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
NodeRoles List<string>: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
NodeTypeData bool: Defines whether this node can hold data (\n\n).
NodeTypeIngest bool: Defines whether this node can run an ingest pipeline (\n\n).
NodeTypeMaster bool: Defines whether this node can be elected master (\n\n).
NodeTypeMl bool: Defines whether this node can run ML jobs (\n\n).
Size string: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

Autoscalings []GetDeploymentElasticsearchTopologyAutoscaling: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
NodeRoles []string: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
NodeTypeData bool: Defines whether this node can hold data (\n\n).
NodeTypeIngest bool: Defines whether this node can run an ingest pipeline (\n\n).
NodeTypeMaster bool: Defines whether this node can be elected master (\n\n).
NodeTypeMl bool: Defines whether this node can run ML jobs (\n\n).
Size string: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

autoscalings List<GetDeploymentElasticsearchTopologyAutoscaling>: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeRoles List<String>: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
nodeTypeData Boolean: Defines whether this node can hold data (\n\n).
nodeTypeIngest Boolean: Defines whether this node can run an ingest pipeline (\n\n).
nodeTypeMaster Boolean: Defines whether this node can be elected master (\n\n).
nodeTypeMl Boolean: Defines whether this node can run ML jobs (\n\n).
size String: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Integer: Number of zones in which nodes will be placed.

autoscalings GetDeploymentElasticsearchTopologyAutoscaling[]: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
instanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeRoles string[]: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
nodeTypeData boolean: Defines whether this node can hold data (\n\n).
nodeTypeIngest boolean: Defines whether this node can run an ingest pipeline (\n\n).
nodeTypeMaster boolean: Defines whether this node can be elected master (\n\n).
nodeTypeMl boolean: Defines whether this node can run ML jobs (\n\n).
size string: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
sizeResource string: Type of resource ("memory" or "storage")
zoneCount number: Number of zones in which nodes will be placed.

autoscalings Sequence[GetDeploymentElasticsearchTopologyAutoscaling]: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
instance_configuration_id str: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
node_roles Sequence[str]: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
node_type_data bool: Defines whether this node can hold data (\n\n).
node_type_ingest bool: Defines whether this node can run an ingest pipeline (\n\n).
node_type_master bool: Defines whether this node can be elected master (\n\n).
node_type_ml bool: Defines whether this node can run ML jobs (\n\n).
size str: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
size_resource str: Type of resource ("memory" or "storage")
zone_count int: Number of zones in which nodes will be placed.

autoscalings List<Property Map>: Optional Elasticsearch autoscaling settings, such a maximum and minimum size and resources.
instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeRoles List<String>: Defines the list of Elasticsearch node roles assigned to the topology element. This is supported from v7.10, and required from v8.
nodeTypeData Boolean: Defines whether this node can hold data (\n\n).
nodeTypeIngest Boolean: Defines whether this node can run an ingest pipeline (\n\n).
nodeTypeMaster Boolean: Defines whether this node can be elected master (\n\n).
nodeTypeMl Boolean: Defines whether this node can run ML jobs (\n\n).
size String: Amount of "size_resource" per topology element in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Number: Number of zones in which nodes will be placed.

GetDeploymentElasticsearchTopologyAutoscaling

MaxSize string: Maximum size the tier can scale up to, e.g "64g".
MaxSizeResource string: Resource type used when specifying the maximum size the tier can scale up to.
MinSize string: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
MinSizeResource string: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
PolicyOverrideJson string: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

MaxSize string: Maximum size the tier can scale up to, e.g "64g".
MaxSizeResource string: Resource type used when specifying the maximum size the tier can scale up to.
MinSize string: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
MinSizeResource string: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
PolicyOverrideJson string: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

maxSize String: Maximum size the tier can scale up to, e.g "64g".
maxSizeResource String: Resource type used when specifying the maximum size the tier can scale up to.
minSize String: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
minSizeResource String: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
policyOverrideJson String: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

maxSize string: Maximum size the tier can scale up to, e.g "64g".
maxSizeResource string: Resource type used when specifying the maximum size the tier can scale up to.
minSize string: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
minSizeResource string: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
policyOverrideJson string: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

max_size str: Maximum size the tier can scale up to, e.g "64g".
max_size_resource str: Resource type used when specifying the maximum size the tier can scale up to.
min_size str: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
min_size_resource str: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
policy_override_json str: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

maxSize String: Maximum size the tier can scale up to, e.g "64g".
maxSizeResource String: Resource type used when specifying the maximum size the tier can scale up to.
minSize String: Minimum size the tier can scale down to when bidirectional autoscaling is supported.
minSizeResource String: Resource type used when specifying the minimum size the tier can scale down to when bidirectional autoscaling is supported.
policyOverrideJson String: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

GetDeploymentEnterpriseSearch

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Enterprise Search resource health status.
HttpEndpoint string: HTTP endpoint for the Enterprise Search resource.
HttpsEndpoint string: HTTPS endpoint for the Enterprise Search resource.
RefId string: A locally-unique friendly alias for this Enterprise Search resource.
ResourceId string: The resource unique identifier.
Status string: Enterprise Search resource status (for example, "started", "stopped", etc).
Topologies List<Pulumi.ElasticCloud.Inputs.GetDeploymentEnterpriseSearchTopology>: Node topology element definition.
Version string: Elastic stack version.

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Enterprise Search resource health status.
HttpEndpoint string: HTTP endpoint for the Enterprise Search resource.
HttpsEndpoint string: HTTPS endpoint for the Enterprise Search resource.
RefId string: A locally-unique friendly alias for this Enterprise Search resource.
ResourceId string: The resource unique identifier.
Status string: Enterprise Search resource status (for example, "started", "stopped", etc).
Topologies []GetDeploymentEnterpriseSearchTopology: Node topology element definition.
Version string: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Enterprise Search resource health status.
httpEndpoint String: HTTP endpoint for the Enterprise Search resource.
httpsEndpoint String: HTTPS endpoint for the Enterprise Search resource.
refId String: A locally-unique friendly alias for this Enterprise Search resource.
resourceId String: The resource unique identifier.
status String: Enterprise Search resource status (for example, "started", "stopped", etc).
topologies List<GetDeploymentEnterpriseSearchTopology>: Node topology element definition.
version String: Elastic stack version.

elasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy boolean: Enterprise Search resource health status.
httpEndpoint string: HTTP endpoint for the Enterprise Search resource.
httpsEndpoint string: HTTPS endpoint for the Enterprise Search resource.
refId string: A locally-unique friendly alias for this Enterprise Search resource.
resourceId string: The resource unique identifier.
status string: Enterprise Search resource status (for example, "started", "stopped", etc).
topologies GetDeploymentEnterpriseSearchTopology[]: Node topology element definition.
version string: Elastic stack version.

elasticsearch_cluster_ref_id str: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy bool: Enterprise Search resource health status.
http_endpoint str: HTTP endpoint for the Enterprise Search resource.
https_endpoint str: HTTPS endpoint for the Enterprise Search resource.
ref_id str: A locally-unique friendly alias for this Enterprise Search resource.
resource_id str: The resource unique identifier.
status str: Enterprise Search resource status (for example, "started", "stopped", etc).
topologies Sequence[GetDeploymentEnterpriseSearchTopology]: Node topology element definition.
version str: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Enterprise Search resource health status.
httpEndpoint String: HTTP endpoint for the Enterprise Search resource.
httpsEndpoint String: HTTPS endpoint for the Enterprise Search resource.
refId String: A locally-unique friendly alias for this Enterprise Search resource.
resourceId String: The resource unique identifier.
status String: Enterprise Search resource status (for example, "started", "stopped", etc).
topologies List<Property Map>: Node topology element definition.
version String: Elastic stack version.

GetDeploymentEnterpriseSearchTopology

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
NodeTypeAppserver bool: Defines whether this instance should run as application/API server.
NodeTypeConnector bool: Defines whether this instance should run as connector.
NodeTypeWorker bool: Defines whether this instance should run as background worker.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
NodeTypeAppserver bool: Defines whether this instance should run as application/API server.
NodeTypeConnector bool: Defines whether this instance should run as connector.
NodeTypeWorker bool: Defines whether this instance should run as background worker.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeTypeAppserver Boolean: Defines whether this instance should run as application/API server.
nodeTypeConnector Boolean: Defines whether this instance should run as connector.
nodeTypeWorker Boolean: Defines whether this instance should run as background worker.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Integer: Number of zones in which nodes will be placed.

instanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeTypeAppserver boolean: Defines whether this instance should run as application/API server.
nodeTypeConnector boolean: Defines whether this instance should run as connector.
nodeTypeWorker boolean: Defines whether this instance should run as background worker.
size string: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource string: Type of resource ("memory" or "storage")
zoneCount number: Number of zones in which nodes will be placed.

instance_configuration_id str: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
node_type_appserver bool: Defines whether this instance should run as application/API server.
node_type_connector bool: Defines whether this instance should run as connector.
node_type_worker bool: Defines whether this instance should run as background worker.
size str: Amount of "size_resource" in Gigabytes. For example "4g".
size_resource str: Type of resource ("memory" or "storage")
zone_count int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
nodeTypeAppserver Boolean: Defines whether this instance should run as application/API server.
nodeTypeConnector Boolean: Defines whether this instance should run as connector.
nodeTypeWorker Boolean: Defines whether this instance should run as background worker.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Number: Number of zones in which nodes will be placed.

GetDeploymentIntegrationsServer

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Resource kind health status.
HttpEndpoint string: HTTP endpoint for the resource kind.
HttpsEndpoint string: HTTPS endpoint for the resource kind.
RefId string: A locally-unique friendly alias for this Integrations Server resource.
ResourceId string: The resource unique identifier.
Status string: Resource kind status (for example, "started", "stopped", etc).
Topologies List<Pulumi.ElasticCloud.Inputs.GetDeploymentIntegrationsServerTopology>: Node topology element definition.
Version string: Elastic stack version.

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Resource kind health status.
HttpEndpoint string: HTTP endpoint for the resource kind.
HttpsEndpoint string: HTTPS endpoint for the resource kind.
RefId string: A locally-unique friendly alias for this Integrations Server resource.
ResourceId string: The resource unique identifier.
Status string: Resource kind status (for example, "started", "stopped", etc).
Topologies []GetDeploymentIntegrationsServerTopology: Node topology element definition.
Version string: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Resource kind health status.
httpEndpoint String: HTTP endpoint for the resource kind.
httpsEndpoint String: HTTPS endpoint for the resource kind.
refId String: A locally-unique friendly alias for this Integrations Server resource.
resourceId String: The resource unique identifier.
status String: Resource kind status (for example, "started", "stopped", etc).
topologies List<GetDeploymentIntegrationsServerTopology>: Node topology element definition.
version String: Elastic stack version.

elasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy boolean: Resource kind health status.
httpEndpoint string: HTTP endpoint for the resource kind.
httpsEndpoint string: HTTPS endpoint for the resource kind.
refId string: A locally-unique friendly alias for this Integrations Server resource.
resourceId string: The resource unique identifier.
status string: Resource kind status (for example, "started", "stopped", etc).
topologies GetDeploymentIntegrationsServerTopology[]: Node topology element definition.
version string: Elastic stack version.

elasticsearch_cluster_ref_id str: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy bool: Resource kind health status.
http_endpoint str: HTTP endpoint for the resource kind.
https_endpoint str: HTTPS endpoint for the resource kind.
ref_id str: A locally-unique friendly alias for this Integrations Server resource.
resource_id str: The resource unique identifier.
status str: Resource kind status (for example, "started", "stopped", etc).
topologies Sequence[GetDeploymentIntegrationsServerTopology]: Node topology element definition.
version str: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Resource kind health status.
httpEndpoint String: HTTP endpoint for the resource kind.
httpsEndpoint String: HTTPS endpoint for the resource kind.
refId String: A locally-unique friendly alias for this Integrations Server resource.
resourceId String: The resource unique identifier.
status String: Resource kind status (for example, "started", "stopped", etc).
topologies List<Property Map>: Node topology element definition.
version String: Elastic stack version.

GetDeploymentIntegrationsServerTopology

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of "size_resource" in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Integer: Number of zones in which nodes will be placed.

instanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size string: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource string: Type of resource ("memory" or "storage")
zoneCount number: Number of zones in which nodes will be placed.

instance_configuration_id str: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size str: Amount of "size_resource" in Gigabytes. For example "4g".
size_resource str: Type of resource ("memory" or "storage")
zone_count int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of "size_resource" in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Number: Number of zones in which nodes will be placed.

GetDeploymentKibana

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Kibana resource health status.
HttpEndpoint string: HTTP endpoint for the Kibana resource.
HttpsEndpoint string: HTTPS endpoint for the Kibana resource.
RefId string: A locally-unique friendly alias for this Kibana resource.
ResourceId string: The resource unique identifier.
Status string: Kibana resource status (for example, "started", "stopped", etc).
Topologies List<Pulumi.ElasticCloud.Inputs.GetDeploymentKibanaTopology>: Node topology element definition.
Version string: Elastic stack version.

ElasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
Healthy bool: Kibana resource health status.
HttpEndpoint string: HTTP endpoint for the Kibana resource.
HttpsEndpoint string: HTTPS endpoint for the Kibana resource.
RefId string: A locally-unique friendly alias for this Kibana resource.
ResourceId string: The resource unique identifier.
Status string: Kibana resource status (for example, "started", "stopped", etc).
Topologies []GetDeploymentKibanaTopology: Node topology element definition.
Version string: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Kibana resource health status.
httpEndpoint String: HTTP endpoint for the Kibana resource.
httpsEndpoint String: HTTPS endpoint for the Kibana resource.
refId String: A locally-unique friendly alias for this Kibana resource.
resourceId String: The resource unique identifier.
status String: Kibana resource status (for example, "started", "stopped", etc).
topologies List<GetDeploymentKibanaTopology>: Node topology element definition.
version String: Elastic stack version.

elasticsearchClusterRefId string: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy boolean: Kibana resource health status.
httpEndpoint string: HTTP endpoint for the Kibana resource.
httpsEndpoint string: HTTPS endpoint for the Kibana resource.
refId string: A locally-unique friendly alias for this Kibana resource.
resourceId string: The resource unique identifier.
status string: Kibana resource status (for example, "started", "stopped", etc).
topologies GetDeploymentKibanaTopology[]: Node topology element definition.
version string: Elastic stack version.

elasticsearch_cluster_ref_id str: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy bool: Kibana resource health status.
http_endpoint str: HTTP endpoint for the Kibana resource.
https_endpoint str: HTTPS endpoint for the Kibana resource.
ref_id str: A locally-unique friendly alias for this Kibana resource.
resource_id str: The resource unique identifier.
status str: Kibana resource status (for example, "started", "stopped", etc).
topologies Sequence[GetDeploymentKibanaTopology]: Node topology element definition.
version str: Elastic stack version.

elasticsearchClusterRefId String: A locally-unique friendly alias for an Elasticsearch resource in this deployment.
healthy Boolean: Kibana resource health status.
httpEndpoint String: HTTP endpoint for the Kibana resource.
httpsEndpoint String: HTTPS endpoint for the Kibana resource.
refId String: A locally-unique friendly alias for this Kibana resource.
resourceId String: The resource unique identifier.
status String: Kibana resource status (for example, "started", "stopped", etc).
topologies List<Property Map>: Node topology element definition.
version String: Elastic stack version.

GetDeploymentKibanaTopology

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of size_resource in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

InstanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
Size string: Amount of size_resource in Gigabytes. For example "4g".
SizeResource string: Type of resource ("memory" or "storage")
ZoneCount int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of size_resource in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Integer: Number of zones in which nodes will be placed.

instanceConfigurationId string: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size string: Amount of size_resource in Gigabytes. For example "4g".
sizeResource string: Type of resource ("memory" or "storage")
zoneCount number: Number of zones in which nodes will be placed.

instance_configuration_id str: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size str: Amount of size_resource in Gigabytes. For example "4g".
size_resource str: Type of resource ("memory" or "storage")
zone_count int: Number of zones in which nodes will be placed.

instanceConfigurationId String: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the ID of an existing instance configuration.
size String: Amount of size_resource in Gigabytes. For example "4g".
sizeResource String: Type of resource ("memory" or "storage")
zoneCount Number: Number of zones in which nodes will be placed.

GetDeploymentObservability

DeploymentId string: Destination deployment ID for the shipped logs and monitoring metrics.
Logs bool: Defines whether logs are shipped to the destination deployment.
Metrics bool: Defines whether metrics are shipped to the destination deployment.
RefId string: Elasticsearch resource kind ref_id of the destination deployment.

DeploymentId string: Destination deployment ID for the shipped logs and monitoring metrics.
Logs bool: Defines whether logs are shipped to the destination deployment.
Metrics bool: Defines whether metrics are shipped to the destination deployment.
RefId string: Elasticsearch resource kind ref_id of the destination deployment.

deploymentId String: Destination deployment ID for the shipped logs and monitoring metrics.
logs Boolean: Defines whether logs are shipped to the destination deployment.
metrics Boolean: Defines whether metrics are shipped to the destination deployment.
refId String: Elasticsearch resource kind ref_id of the destination deployment.

deploymentId string: Destination deployment ID for the shipped logs and monitoring metrics.
logs boolean: Defines whether logs are shipped to the destination deployment.
metrics boolean: Defines whether metrics are shipped to the destination deployment.
refId string: Elasticsearch resource kind ref_id of the destination deployment.

deployment_id str: Destination deployment ID for the shipped logs and monitoring metrics.
logs bool: Defines whether logs are shipped to the destination deployment.
metrics bool: Defines whether metrics are shipped to the destination deployment.
ref_id str: Elasticsearch resource kind ref_id of the destination deployment.

deploymentId String: Destination deployment ID for the shipped logs and monitoring metrics.
logs Boolean: Defines whether logs are shipped to the destination deployment.
metrics Boolean: Defines whether metrics are shipped to the destination deployment.
refId String: Elasticsearch resource kind ref_id of the destination deployment.

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.8.1 published on Tuesday, Jun 4, 2024 by Pulumi

pulumi/pulumi-ec

ec.getDeployment

On this page

On this page

Example Usage

Using getDeployment

getDeployment Result

Supporting Types

GetDeploymentApm

GetDeploymentApmTopology

GetDeploymentElasticsearch

GetDeploymentElasticsearchTopology

GetDeploymentElasticsearchTopologyAutoscaling

GetDeploymentEnterpriseSearch

GetDeploymentEnterpriseSearchTopology

GetDeploymentIntegrationsServer

GetDeploymentIntegrationsServerTopology

GetDeploymentKibana

GetDeploymentKibanaTopology

GetDeploymentObservability

Package Details

On this page

On this page