1. Packages
  2. AWS Classic
  3. API Docs
  4. opensearch
  5. PackageAssociation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

aws.opensearch.PackageAssociation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

    Manages an AWS Opensearch Package Association.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const myDomain = new aws.opensearch.Domain("my_domain", {
        domainName: "my-opensearch-domain",
        engineVersion: "Elasticsearch_7.10",
        clusterConfig: {
            instanceType: "r4.large.search",
        },
    });
    const example = new aws.opensearch.Package("example", {
        packageName: "example-txt",
        packageSource: {
            s3BucketName: myOpensearchPackages.bucket,
            s3Key: exampleAwsS3Object.key,
        },
        packageType: "TXT-DICTIONARY",
    });
    const examplePackageAssociation = new aws.opensearch.PackageAssociation("example", {
        packageId: example.id,
        domainName: myDomain.domainName,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    my_domain = aws.opensearch.Domain("my_domain",
        domain_name="my-opensearch-domain",
        engine_version="Elasticsearch_7.10",
        cluster_config=aws.opensearch.DomainClusterConfigArgs(
            instance_type="r4.large.search",
        ))
    example = aws.opensearch.Package("example",
        package_name="example-txt",
        package_source=aws.opensearch.PackagePackageSourceArgs(
            s3_bucket_name=my_opensearch_packages["bucket"],
            s3_key=example_aws_s3_object["key"],
        ),
        package_type="TXT-DICTIONARY")
    example_package_association = aws.opensearch.PackageAssociation("example",
        package_id=example.id,
        domain_name=my_domain.domain_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearch"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myDomain, err := opensearch.NewDomain(ctx, "my_domain", &opensearch.DomainArgs{
    			DomainName:    pulumi.String("my-opensearch-domain"),
    			EngineVersion: pulumi.String("Elasticsearch_7.10"),
    			ClusterConfig: &opensearch.DomainClusterConfigArgs{
    				InstanceType: pulumi.String("r4.large.search"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		example, err := opensearch.NewPackage(ctx, "example", &opensearch.PackageArgs{
    			PackageName: pulumi.String("example-txt"),
    			PackageSource: &opensearch.PackagePackageSourceArgs{
    				S3BucketName: pulumi.Any(myOpensearchPackages.Bucket),
    				S3Key:        pulumi.Any(exampleAwsS3Object.Key),
    			},
    			PackageType: pulumi.String("TXT-DICTIONARY"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = opensearch.NewPackageAssociation(ctx, "example", &opensearch.PackageAssociationArgs{
    			PackageId:  example.ID(),
    			DomainName: myDomain.DomainName,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var myDomain = new Aws.OpenSearch.Domain("my_domain", new()
        {
            DomainName = "my-opensearch-domain",
            EngineVersion = "Elasticsearch_7.10",
            ClusterConfig = new Aws.OpenSearch.Inputs.DomainClusterConfigArgs
            {
                InstanceType = "r4.large.search",
            },
        });
    
        var example = new Aws.OpenSearch.Package("example", new()
        {
            PackageName = "example-txt",
            PackageSource = new Aws.OpenSearch.Inputs.PackagePackageSourceArgs
            {
                S3BucketName = myOpensearchPackages.Bucket,
                S3Key = exampleAwsS3Object.Key,
            },
            PackageType = "TXT-DICTIONARY",
        });
    
        var examplePackageAssociation = new Aws.OpenSearch.PackageAssociation("example", new()
        {
            PackageId = example.Id,
            DomainName = myDomain.DomainName,
        });
    
    });
    
    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.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 myDomain = new Domain("myDomain", DomainArgs.builder()
                .domainName("my-opensearch-domain")
                .engineVersion("Elasticsearch_7.10")
                .clusterConfig(DomainClusterConfigArgs.builder()
                    .instanceType("r4.large.search")
                    .build())
                .build());
    
            var example = new Package("example", PackageArgs.builder()
                .packageName("example-txt")
                .packageSource(PackagePackageSourceArgs.builder()
                    .s3BucketName(myOpensearchPackages.bucket())
                    .s3Key(exampleAwsS3Object.key())
                    .build())
                .packageType("TXT-DICTIONARY")
                .build());
    
            var examplePackageAssociation = new PackageAssociation("examplePackageAssociation", PackageAssociationArgs.builder()
                .packageId(example.id())
                .domainName(myDomain.domainName())
                .build());
    
        }
    }
    
    resources:
      myDomain:
        type: aws:opensearch:Domain
        name: my_domain
        properties:
          domainName: my-opensearch-domain
          engineVersion: Elasticsearch_7.10
          clusterConfig:
            instanceType: r4.large.search
      example:
        type: aws:opensearch:Package
        properties:
          packageName: example-txt
          packageSource:
            s3BucketName: ${myOpensearchPackages.bucket}
            s3Key: ${exampleAwsS3Object.key}
          packageType: TXT-DICTIONARY
      examplePackageAssociation:
        type: aws:opensearch:PackageAssociation
        name: example
        properties:
          packageId: ${example.id}
          domainName: ${myDomain.domainName}
    

    Create PackageAssociation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PackageAssociation(name: string, args: PackageAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def PackageAssociation(resource_name: str,
                           args: PackageAssociationArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def PackageAssociation(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           domain_name: Optional[str] = None,
                           package_id: Optional[str] = None)
    func NewPackageAssociation(ctx *Context, name string, args PackageAssociationArgs, opts ...ResourceOption) (*PackageAssociation, error)
    public PackageAssociation(string name, PackageAssociationArgs args, CustomResourceOptions? opts = null)
    public PackageAssociation(String name, PackageAssociationArgs args)
    public PackageAssociation(String name, PackageAssociationArgs args, CustomResourceOptions options)
    
    type: aws:opensearch:PackageAssociation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PackageAssociationArgs
    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 PackageAssociationArgs
    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 PackageAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PackageAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PackageAssociationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var packageAssociationResource = new Aws.OpenSearch.PackageAssociation("packageAssociationResource", new()
    {
        DomainName = "string",
        PackageId = "string",
    });
    
    example, err := opensearch.NewPackageAssociation(ctx, "packageAssociationResource", &opensearch.PackageAssociationArgs{
    	DomainName: pulumi.String("string"),
    	PackageId:  pulumi.String("string"),
    })
    
    var packageAssociationResource = new PackageAssociation("packageAssociationResource", PackageAssociationArgs.builder()        
        .domainName("string")
        .packageId("string")
        .build());
    
    package_association_resource = aws.opensearch.PackageAssociation("packageAssociationResource",
        domain_name="string",
        package_id="string")
    
    const packageAssociationResource = new aws.opensearch.PackageAssociation("packageAssociationResource", {
        domainName: "string",
        packageId: "string",
    });
    
    type: aws:opensearch:PackageAssociation
    properties:
        domainName: string
        packageId: string
    

    PackageAssociation 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 PackageAssociation resource accepts the following input properties:

    DomainName string
    Name of the domain to associate the package with.
    PackageId string
    Internal ID of the package to associate with a domain.
    DomainName string
    Name of the domain to associate the package with.
    PackageId string
    Internal ID of the package to associate with a domain.
    domainName String
    Name of the domain to associate the package with.
    packageId String
    Internal ID of the package to associate with a domain.
    domainName string
    Name of the domain to associate the package with.
    packageId string
    Internal ID of the package to associate with a domain.
    domain_name str
    Name of the domain to associate the package with.
    package_id str
    Internal ID of the package to associate with a domain.
    domainName String
    Name of the domain to associate the package with.
    packageId String
    Internal ID of the package to associate with a domain.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PackageAssociation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ReferencePath string
    Id string
    The provider-assigned unique ID for this managed resource.
    ReferencePath string
    id String
    The provider-assigned unique ID for this managed resource.
    referencePath String
    id string
    The provider-assigned unique ID for this managed resource.
    referencePath string
    id str
    The provider-assigned unique ID for this managed resource.
    reference_path str
    id String
    The provider-assigned unique ID for this managed resource.
    referencePath String

    Look up Existing PackageAssociation Resource

    Get an existing PackageAssociation 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?: PackageAssociationState, opts?: CustomResourceOptions): PackageAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain_name: Optional[str] = None,
            package_id: Optional[str] = None,
            reference_path: Optional[str] = None) -> PackageAssociation
    func GetPackageAssociation(ctx *Context, name string, id IDInput, state *PackageAssociationState, opts ...ResourceOption) (*PackageAssociation, error)
    public static PackageAssociation Get(string name, Input<string> id, PackageAssociationState? state, CustomResourceOptions? opts = null)
    public static PackageAssociation get(String name, Output<String> id, PackageAssociationState 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.
    The following state arguments are supported:
    DomainName string
    Name of the domain to associate the package with.
    PackageId string
    Internal ID of the package to associate with a domain.
    ReferencePath string
    DomainName string
    Name of the domain to associate the package with.
    PackageId string
    Internal ID of the package to associate with a domain.
    ReferencePath string
    domainName String
    Name of the domain to associate the package with.
    packageId String
    Internal ID of the package to associate with a domain.
    referencePath String
    domainName string
    Name of the domain to associate the package with.
    packageId string
    Internal ID of the package to associate with a domain.
    referencePath string
    domain_name str
    Name of the domain to associate the package with.
    package_id str
    Internal ID of the package to associate with a domain.
    reference_path str
    domainName String
    Name of the domain to associate the package with.
    packageId String
    Internal ID of the package to associate with a domain.
    referencePath String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi