Package com.pulumi.aws.opensearch

Class Package

  • public class Package
extends com.pulumi.resources.CustomResource
    Manages an AWS Opensearch Package. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import AWS Opensearch Packages using the Package ID. For example: ```sh $ pulumi import aws:opensearch/package:Package example package-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Package​(java.lang.String name)  
      Package​(java.lang.String name, PackageArgs args)  
      Package​(java.lang.String name, PackageArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> availablePackageVersion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> engineVersion()  
      static Package get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PackageState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> packageDescription()  
      com.pulumi.core.Output<java.lang.String> packageId()  
      com.pulumi.core.Output<java.lang.String> packageName()  
      com.pulumi.core.Output<PackagePackageSource> packageSource()  
      com.pulumi.core.Output<java.lang.String> packageType()  
      com.pulumi.core.Output<java.lang.String> region()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Package

        public Package​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Package

        public Package​(java.lang.String name,
               PackageArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Package

        public Package​(java.lang.String name,
               PackageArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • availablePackageVersion

        public com.pulumi.core.Output<java.lang.String> availablePackageVersion()
        Returns:
        The current version of the package.

      • engineVersion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> engineVersion()
        Returns:
        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.

      • packageDescription

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> packageDescription()
        Returns:
        Description of the package.

      • packageId

        public com.pulumi.core.Output<java.lang.String> packageId()

      • packageName

        public com.pulumi.core.Output<java.lang.String> packageName()
        Returns:
        Unique name for the package.

      • packageSource

        public com.pulumi.core.Output<PackagePackageSource> packageSource()
        Returns:
        Configuration block for the package source options.

      • packageType

        public com.pulumi.core.Output<java.lang.String> packageType()
        Returns:
        The type of package. Valid values are `TXT-DICTIONARY`, `ZIP-PLUGIN`, `PACKAGE-LICENSE` and `PACKAGE-CONFIG`.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static Package get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          PackageState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.