Package com.pulumi.aws.opensearch

Class PackageAssociation

  • public class PackageAssociation
extends com.pulumi.resources.CustomResource
    Manages an AWS Opensearch Package Association. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.opensearch.Domain;
 import com.pulumi.aws.opensearch.DomainArgs;
 import com.pulumi.aws.opensearch.inputs.DomainClusterConfigArgs;
 import com.pulumi.aws.opensearch.Package;
 import com.pulumi.aws.opensearch.PackageArgs;
 import com.pulumi.aws.opensearch.inputs.PackagePackageSourceArgs;
 import com.pulumi.aws.opensearch.PackageAssociation;
 import com.pulumi.aws.opensearch.PackageAssociationArgs;
 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 myDomain = new Domain("myDomain", DomainArgs.builder()
             .clusterConfig(DomainClusterConfigArgs.builder()
                 .instanceType("r4.large.search")
                 .build())
             .domainName("my-opensearch-domain")
             .engineVersion("Elasticsearch_7.10")
             .build());
 
         var example = new Package("example", PackageArgs.builder()
             .packageSource(PackagePackageSourceArgs.builder()
                 .s3BucketName(myOpensearchPackages.bucket())
                 .s3Key(exampleAwsS3Object.key())
                 .build())
             .packageName("example-txt")
             .packageType("TXT-DICTIONARY")
             .build());
 
         var examplePackageAssociation = new PackageAssociation("examplePackageAssociation", PackageAssociationArgs.builder()
             .packageId(example.id())
             .domainName(myDomain.domainName())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.opensearch.PackageAssociation` using `DOMAIN_NAME,PACKAGE_ID`. For example: ```sh $ pulumi import aws:opensearch/packageAssociation:PackageAssociation example example-domain,F123456789 ```

    • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> domainName()  
      static PackageAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PackageAssociationState 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.lang.String> packageId()  
      com.pulumi.core.Output<java.lang.String> referencePath()  
      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

      • PackageAssociation

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

      • PackageAssociation

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

      • PackageAssociation

        public PackageAssociation​(java.lang.String name,
                          PackageAssociationArgs 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

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Name of the domain to associate the package with.

      • packageId

        public com.pulumi.core.Output<java.lang.String> packageId()
        Returns:
        Internal ID of the package to associate with a domain.

      • referencePath

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

      • 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 PackageAssociation get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     PackageAssociationState 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.