ec.DeploymentExtension
Explore with Pulumi AI
Provides an Elastic Cloud extension resource, which allows extensions to be created, updated, and deleted.
Extensions allow users of Elastic Cloud to use custom plugins, scripts, or dictionaries to enhance the core functionality of Elasticsearch. Before you install an extension, be sure to check out the supported and official Elasticsearch plugins already available.
Tip : If you experience timeouts when uploading an extension through a slow network, you might need to increase the timeout setting.
Example Usage
With extension file
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.DeploymentExtension;
import com.pulumi.ec.DeploymentExtensionArgs;
import com.pulumi.ec.EcFunctions;
import com.pulumi.ec.inputs.GetStackArgs;
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 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 filePath = "/path/to/plugin.zip";
var exampleExtension = new DeploymentExtension("exampleExtension", DeploymentExtensionArgs.builder()
.description("my extension")
.version("*")
.extensionType("bundle")
.filePath(filePath)
.fileHash(computeFileBase64Sha256(filePath))
.build());
final var latest = EcFunctions.getStack(GetStackArgs.builder()
.versionRegex("latest")
.region("us-east-1")
.build());
var withExtension = new Deployment("withExtension", DeploymentArgs.builder()
.region("us-east-1")
.version(latest.applyValue(getStackResult -> getStackResult.version()))
.deploymentTemplateId("aws-io-optimized-v2")
.elasticsearch(DeploymentElasticsearchArgs.builder()
.hot(DeploymentElasticsearchHotArgs.builder()
.autoscaling()
.build())
.extension(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build())
.build());
}
}
Coming soon!
Coming soon!
Coming soon!
With download URL
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.DeploymentExtension;
import com.pulumi.ec.DeploymentExtensionArgs;
import com.pulumi.ec.EcFunctions;
import com.pulumi.ec.inputs.GetStackArgs;
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 java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleExtension = new DeploymentExtension("exampleExtension", DeploymentExtensionArgs.builder()
.description("my extension")
.version("*")
.extensionType("bundle")
.downloadUrl("https://example.net")
.build());
final var latest = EcFunctions.getStack(GetStackArgs.builder()
.versionRegex("latest")
.region("us-east-1")
.build());
var withExtension = new Deployment("withExtension", DeploymentArgs.builder()
.region("us-east-1")
.version(latest.applyValue(getStackResult -> getStackResult.version()))
.deploymentTemplateId("aws-io-optimized-v2")
.elasticsearch(DeploymentElasticsearchArgs.builder()
.hot(DeploymentElasticsearchHotArgs.builder()
.autoscaling()
.build())
.extension(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
exampleExtension:
type: ec:DeploymentExtension
properties:
description: my extension
version: '*'
extensionType: bundle
downloadUrl: https://example.net
withExtension:
type: ec:Deployment
properties:
# Mandatory fields
region: us-east-1
version: ${latest.version}
deploymentTemplateId: aws-io-optimized-v2
elasticsearch:
hot:
autoscaling: {}
extension:
- name: ${exampleExtension.name}
type: bundle
version: ${latest.version}
url: ${exampleExtension.url}
variables:
latest:
fn::invoke:
Function: ec:getStack
Arguments:
versionRegex: latest
region: us-east-1
Create DeploymentExtension Resource
new DeploymentExtension(name: string, args: DeploymentExtensionArgs, opts?: CustomResourceOptions);
@overload
def DeploymentExtension(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
download_url: Optional[str] = None,
extension_type: Optional[str] = None,
file_hash: Optional[str] = None,
file_path: Optional[str] = None,
name: Optional[str] = None,
version: Optional[str] = None)
@overload
def DeploymentExtension(resource_name: str,
args: DeploymentExtensionArgs,
opts: Optional[ResourceOptions] = None)
func NewDeploymentExtension(ctx *Context, name string, args DeploymentExtensionArgs, opts ...ResourceOption) (*DeploymentExtension, error)
public DeploymentExtension(string name, DeploymentExtensionArgs args, CustomResourceOptions? opts = null)
public DeploymentExtension(String name, DeploymentExtensionArgs args)
public DeploymentExtension(String name, DeploymentExtensionArgs args, CustomResourceOptions options)
type: ec:DeploymentExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentExtensionArgs
- 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 DeploymentExtensionArgs
- 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 DeploymentExtensionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentExtensionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DeploymentExtension Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DeploymentExtension resource accepts the following input properties:
- Extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- Version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- Description string
Description for the extension
- Download
Url string The URL to download the extension archive.
- File
Hash string Hash value of the file. Triggers re-uploading the file on change.
- File
Path string Local file path to upload as the extension.
- Name string
Name of the extension
- Extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- Version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- Description string
Description for the extension
- Download
Url string The URL to download the extension archive.
- File
Hash string Hash value of the file. Triggers re-uploading the file on change.
- File
Path string Local file path to upload as the extension.
- Name string
Name of the extension
- extension
Type String Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- version String
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description String
Description for the extension
- download
Url String The URL to download the extension archive.
- file
Hash String Hash value of the file. Triggers re-uploading the file on change.
- file
Path String Local file path to upload as the extension.
- name String
Name of the extension
- extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description string
Description for the extension
- download
Url string The URL to download the extension archive.
- file
Hash string Hash value of the file. Triggers re-uploading the file on change.
- file
Path string Local file path to upload as the extension.
- name string
Name of the extension
- extension_
type str Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- version str
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description str
Description for the extension
- download_
url str The URL to download the extension archive.
- file_
hash str Hash value of the file. Triggers re-uploading the file on change.
- file_
path str Local file path to upload as the extension.
- name str
Name of the extension
- extension
Type String Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- version String
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description String
Description for the extension
- download
Url String The URL to download the extension archive.
- file
Hash String Hash value of the file. Triggers re-uploading the file on change.
- file
Path String Local file path to upload as the extension.
- name String
Name of the extension
Outputs
All input properties are implicitly available as output properties. Additionally, the DeploymentExtension resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified string The datatime the extension was last modified.
- Size int
The size of the extension file in bytes.
- Url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified string The datatime the extension was last modified.
- Size int
The size of the extension file in bytes.
- Url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified String The datatime the extension was last modified.
- size Integer
The size of the extension file in bytes.
- url String
The extension URL which will be used in the Elastic Cloud deployment plan.
- id string
The provider-assigned unique ID for this managed resource.
- last
Modified string The datatime the extension was last modified.
- size number
The size of the extension file in bytes.
- url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- id str
The provider-assigned unique ID for this managed resource.
- last_
modified str The datatime the extension was last modified.
- size int
The size of the extension file in bytes.
- url str
The extension URL which will be used in the Elastic Cloud deployment plan.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified String The datatime the extension was last modified.
- size Number
The size of the extension file in bytes.
- url String
The extension URL which will be used in the Elastic Cloud deployment plan.
Look up Existing DeploymentExtension Resource
Get an existing DeploymentExtension 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?: DeploymentExtensionState, opts?: CustomResourceOptions): DeploymentExtension
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
download_url: Optional[str] = None,
extension_type: Optional[str] = None,
file_hash: Optional[str] = None,
file_path: Optional[str] = None,
last_modified: Optional[str] = None,
name: Optional[str] = None,
size: Optional[int] = None,
url: Optional[str] = None,
version: Optional[str] = None) -> DeploymentExtension
func GetDeploymentExtension(ctx *Context, name string, id IDInput, state *DeploymentExtensionState, opts ...ResourceOption) (*DeploymentExtension, error)
public static DeploymentExtension Get(string name, Input<string> id, DeploymentExtensionState? state, CustomResourceOptions? opts = null)
public static DeploymentExtension get(String name, Output<String> id, DeploymentExtensionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Description string
Description for the extension
- Download
Url string The URL to download the extension archive.
- Extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- File
Hash string Hash value of the file. Triggers re-uploading the file on change.
- File
Path string Local file path to upload as the extension.
- Last
Modified string The datatime the extension was last modified.
- Name string
Name of the extension
- Size int
The size of the extension file in bytes.
- Url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- Version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- Description string
Description for the extension
- Download
Url string The URL to download the extension archive.
- Extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- File
Hash string Hash value of the file. Triggers re-uploading the file on change.
- File
Path string Local file path to upload as the extension.
- Last
Modified string The datatime the extension was last modified.
- Name string
Name of the extension
- Size int
The size of the extension file in bytes.
- Url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- Version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description String
Description for the extension
- download
Url String The URL to download the extension archive.
- extension
Type String Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- file
Hash String Hash value of the file. Triggers re-uploading the file on change.
- file
Path String Local file path to upload as the extension.
- last
Modified String The datatime the extension was last modified.
- name String
Name of the extension
- size Integer
The size of the extension file in bytes.
- url String
The extension URL which will be used in the Elastic Cloud deployment plan.
- version String
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description string
Description for the extension
- download
Url string The URL to download the extension archive.
- extension
Type string Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- file
Hash string Hash value of the file. Triggers re-uploading the file on change.
- file
Path string Local file path to upload as the extension.
- last
Modified string The datatime the extension was last modified.
- name string
Name of the extension
- size number
The size of the extension file in bytes.
- url string
The extension URL which will be used in the Elastic Cloud deployment plan.
- version string
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description str
Description for the extension
- download_
url str The URL to download the extension archive.
- extension_
type str Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- file_
hash str Hash value of the file. Triggers re-uploading the file on change.
- file_
path str Local file path to upload as the extension.
- last_
modified str The datatime the extension was last modified.
- name str
Name of the extension
- size int
The size of the extension file in bytes.
- url str
The extension URL which will be used in the Elastic Cloud deployment plan.
- version str
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
- description String
Description for the extension
- download
Url String The URL to download the extension archive.
- extension
Type String Extension type. Must be
bundle
orplugin
. Abundle
will usually contain a dictionary or script, where aplugin
is compiled from source.- file
Hash String Hash value of the file. Triggers re-uploading the file on change.
- file
Path String Local file path to upload as the extension.
- last
Modified String The datatime the extension was last modified.
- name String
Name of the extension
- size Number
The size of the extension file in bytes.
- url String
The extension URL which will be used in the Elastic Cloud deployment plan.
- version String
Elastic stack version. A full version (e.g 8.7.0) should be set for plugins. A wildcard (e.g 8.*) may be used for bundles.
Import
Extensions can be imported using the id
, for example
$ pulumi import ec:index/deploymentExtension:DeploymentExtension name 320b7b540dfc967a7a649c18e2fce4ed
Package Details
- Repository
- ec pulumi/pulumi-ec
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
ec
Terraform Provider.