Package class

Manages an AWS Opensearch Package.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";

const myOpensearchPackages = new aws.s3.Bucket("my_opensearch_packages", {bucket: "my-opensearch-packages"});
const example = new aws.s3.BucketObjectv2("example", {
    bucket: myOpensearchPackages.bucket,
    key: "example.txt",
    source: new pulumi.asset.FileAsset("./example.txt"),
    etag: std.filemd5({
        input: "./example.txt",
    }).then(invoke => invoke.result),
});
const examplePackage = new aws.opensearch.Package("example", {
    packageSource: {
        s3BucketName: myOpensearchPackages.bucket,
        s3Key: example.key,
    },
    packageName: "example-txt",
    packageType: "TXT-DICTIONARY",
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std

my_opensearch_packages = aws.s3.Bucket("my_opensearch_packages", bucket="my-opensearch-packages")
example = aws.s3.BucketObjectv2("example",
    bucket=my_opensearch_packages.bucket,
    key="example.txt",
    source=pulumi.FileAsset("./example.txt"),
    etag=std.filemd5(input="./example.txt").result)
example_package = aws.opensearch.Package("example",
    package_source={
        "s3_bucket_name": my_opensearch_packages.bucket,
        "s3_key": example.key,
    },
    package_name="example-txt",
    package_type="TXT-DICTIONARY")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() =>
{
    var myOpensearchPackages = new Aws.S3.Bucket("my_opensearch_packages", new()
    {
        BucketName = "my-opensearch-packages",
    });

    var example = new Aws.S3.BucketObjectv2("example", new()
    {
        Bucket = myOpensearchPackages.BucketName,
        Key = "example.txt",
        Source = new FileAsset("./example.txt"),
        Etag = Std.Filemd5.Invoke(new()
        {
            Input = "./example.txt",
        }).Apply(invoke => invoke.Result),
    });

    var examplePackage = new Aws.OpenSearch.Package("example", new()
    {
        PackageSource = new Aws.OpenSearch.Inputs.PackagePackageSourceArgs
        {
            S3BucketName = myOpensearchPackages.BucketName,
            S3Key = example.Key,
        },
        PackageName = "example-txt",
        PackageType = "TXT-DICTIONARY",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myOpensearchPackages, err := s3.NewBucket(ctx, "my_opensearch_packages", &s3.BucketArgs{
			Bucket: pulumi.String("my-opensearch-packages"),
		})
		if err != nil {
			return err
		}
		invokeFilemd5, err := std.Filemd5(ctx, &std.Filemd5Args{
			Input: "./example.txt",
		}, nil)
		if err != nil {
			return err
		}
		example, err := s3.NewBucketObjectv2(ctx, "example", &s3.BucketObjectv2Args{
			Bucket: myOpensearchPackages.Bucket,
			Key:    pulumi.String("example.txt"),
			Source: pulumi.NewFileAsset("./example.txt"),
			Etag:   pulumi.String(invokeFilemd5.Result),
		})
		if err != nil {
			return err
		}
		_, err = opensearch.NewPackage(ctx, "example", &opensearch.PackageArgs{
			PackageSource: &opensearch.PackagePackageSourceArgs{
				S3BucketName: myOpensearchPackages.Bucket,
				S3Key:        example.Key,
			},
			PackageName: pulumi.String("example-txt"),
			PackageType: pulumi.String("TXT-DICTIONARY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

resource "aws_s3_bucket" "my_opensearch_packages" {
  bucket = "my-opensearch-packages"
}
resource "aws_s3_bucketobjectv2" "example" {
  bucket = aws_s3_bucket.my_opensearch_packages.bucket
  key    = "example.txt"
  source = fileAsset("./example.txt")
  etag   = filemd5("./example.txt")
}
resource "aws_opensearch_package" "example" {
  package_source = {
    s3_bucket_name = aws_s3_bucket.my_opensearch_packages.bucket
    s3_key         = aws_s3_bucketobjectv2.example.key
  }
  package_name = "example-txt"
  package_type = "TXT-DICTIONARY"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.BucketObjectv2;
import com.pulumi.aws.s3.BucketObjectv2Args;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.Filemd5Args;
import com.pulumi.aws.opensearch.Package;
import com.pulumi.aws.opensearch.PackageArgs;
import com.pulumi.aws.opensearch.inputs.PackagePackageSourceArgs;
import com.pulumi.asset.FileAsset;
import java.util.ArrayList;
import java.util.Arrays;
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 myOpensearchPackages = new Bucket("myOpensearchPackages", BucketArgs.builder()
            .bucket("my-opensearch-packages")
            .build());

        var example = new BucketObjectv2("example", BucketObjectv2Args.builder()
            .bucket(myOpensearchPackages.bucket())
            .key("example.txt")
            .source(new FileAsset("./example.txt"))
            .etag(StdFunctions.filemd5(Filemd5Args.builder()
                .input("./example.txt")
                .build()).result())
            .build());

        var examplePackage = new Package("examplePackage", PackageArgs.builder()
            .packageSource(PackagePackageSourceArgs.builder()
                .s3BucketName(myOpensearchPackages.bucket())
                .s3Key(example.key())
                .build())
            .packageName("example-txt")
            .packageType("TXT-DICTIONARY")
            .build());

    }
}
resources:
  myOpensearchPackages:
    type: aws:s3:Bucket
    name: my_opensearch_packages
    properties:
      bucket: my-opensearch-packages
  example:
    type: aws:s3:BucketObjectv2
    properties:
      bucket: ${myOpensearchPackages.bucket}
      key: example.txt
      source:
        fn::fileAsset: ./example.txt
      etag:
        fn::invoke:
          function: std:filemd5
          arguments:
            input: ./example.txt
          return: result
  examplePackage:
    type: aws:opensearch:Package
    name: example
    properties:
      packageSource:
        s3BucketName: ${myOpensearchPackages.bucket}
        s3Key: ${example.key}
      packageName: example-txt
      packageType: TXT-DICTIONARY

Import

Using pulumi import, import AWS Opensearch Packages using the Package ID. For example:

$ pulumi import aws:opensearch/package:Package example package-id

Constructors

Package(String name, {PackageArgs? args, CustomResourceOptions? options})
Creates a new Package. name The Pulumi resource name. args Arguments used to configure this Package. The set of arguments for Package. options Resource options controlling this resource's behavior.
Package.reference(String urn)
Creates a typed reference to an existing Package resource.

Properties

availablePackageVersion ↔ Output<String>
The current version of the package.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
engineVersion ↔ Output<String?>
Engine version that the package is compatible with. This argument is required and only valid when packageType is ZIP-PLUGIN. Format: OpenSearch_X.Y or Elasticsearch_X.Y, where X and Y are the major and minor version numbers, respectively.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
packageDescription ↔ Output<String?>
Description of the package.
latefinal
packageId ↔ Output<String>
latefinal
packageName ↔ Output<String>
Unique name for the package.
latefinal
packageSource ↔ Output<PackagePackageSource>
Configuration block for the package source options.
latefinal
packageType ↔ Output<String>
The type of package. Valid values are TXT-DICTIONARY, ZIP-PLUGIN, PACKAGE-LICENSE and PACKAGE-CONFIG.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PackageState? state, CustomResourceOptions? options}) → Package
Gets an existing Package resource's state with the given name and id.