PackageAssociation class
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", {
clusterConfig: {
instanceType: "r4.large.search",
},
domainName: "my-opensearch-domain",
engineVersion: "Elasticsearch_7.10",
});
const example = new aws.opensearch.Package("example", {
packageSource: {
s3BucketName: myOpensearchPackages.bucket,
s3Key: exampleAwsS3Object.key,
},
packageName: "example-txt",
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",
cluster_config={
"instance_type": "r4.large.search",
},
domain_name="my-opensearch-domain",
engine_version="Elasticsearch_7.10")
example = aws.opensearch.Package("example",
package_source={
"s3_bucket_name": my_opensearch_packages["bucket"],
"s3_key": example_aws_s3_object["key"],
},
package_name="example-txt",
package_type="TXT-DICTIONARY")
example_package_association = aws.opensearch.PackageAssociation("example",
package_id=example.id,
domain_name=my_domain.domain_name)
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()
{
ClusterConfig = new Aws.OpenSearch.Inputs.DomainClusterConfigArgs
{
InstanceType = "r4.large.search",
},
DomainName = "my-opensearch-domain",
EngineVersion = "Elasticsearch_7.10",
});
var example = new Aws.OpenSearch.Package("example", new()
{
PackageSource = new Aws.OpenSearch.Inputs.PackagePackageSourceArgs
{
S3BucketName = myOpensearchPackages.Bucket,
S3Key = exampleAwsS3Object.Key,
},
PackageName = "example-txt",
PackageType = "TXT-DICTIONARY",
});
var examplePackageAssociation = new Aws.OpenSearch.PackageAssociation("example", new()
{
PackageId = example.Id,
DomainName = myDomain.DomainName,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
ClusterConfig: &opensearch.DomainClusterConfigArgs{
InstanceType: pulumi.String("r4.large.search"),
},
DomainName: pulumi.String("my-opensearch-domain"),
EngineVersion: pulumi.String("Elasticsearch_7.10"),
})
if err != nil {
return err
}
example, err := opensearch.NewPackage(ctx, "example", &opensearch.PackageArgs{
PackageSource: &opensearch.PackagePackageSourceArgs{
S3BucketName: pulumi.Any(myOpensearchPackages.Bucket),
S3Key: pulumi.Any(exampleAwsS3Object.Key),
},
PackageName: pulumi.String("example-txt"),
PackageType: pulumi.String("TXT-DICTIONARY"),
})
if err != nil {
return err
}
_, err = opensearch.NewPackageAssociation(ctx, "example", &opensearch.PackageAssociationArgs{
PackageId: example.ID().ToIDOutput().ToStringOutput(),
DomainName: myDomain.DomainName,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_opensearch_domain" "my_domain" {
cluster_config = {
instance_type = "r4.large.search"
}
domain_name = "my-opensearch-domain"
engine_version = "Elasticsearch_7.10"
}
resource "aws_opensearch_package" "example" {
package_source = {
s3_bucket_name = myOpensearchPackages.bucket
s3_key = exampleAwsS3Object.key
}
package_name = "example-txt"
package_type = "TXT-DICTIONARY"
}
resource "aws_opensearch_packageassociation" "example" {
package_id = aws_opensearch_package.example.id
domain_name = aws_opensearch_domain.my_domain.domain_name
}
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());
}
}
resources:
myDomain:
type: aws:opensearch:Domain
name: my_domain
properties:
clusterConfig:
instanceType: r4.large.search
domainName: my-opensearch-domain
engineVersion: Elasticsearch_7.10
example:
type: aws:opensearch:Package
properties:
packageSource:
s3BucketName: ${myOpensearchPackages.bucket}
s3Key: ${exampleAwsS3Object.key}
packageName: example-txt
packageType: TXT-DICTIONARY
examplePackageAssociation:
type: aws:opensearch:PackageAssociation
name: example
properties:
packageId: ${example.id}
domainName: ${myDomain.domainName}
Import
Using pulumi import, import aws.opensearch.PackageAssociation using DOMAIN_NAME,PACKAGE_ID. For example:
$ pulumi import aws:opensearch/packageAssociation:PackageAssociation example example-domain,F123456789
Constructors
- PackageAssociation(String name, {PackageAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new PackageAssociation.
nameThe Pulumi resource name.argsArguments used to configure this PackageAssociation. The set of arguments for PackageAssociation.optionsResource options controlling this resource's behavior. - PackageAssociation.reference(String urn)
- Creates a typed reference to an existing PackageAssociation resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
Name of the domain to associate the package with.
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
-
packageId
↔ Output<
String> -
Internal ID of the package to associate with a domain.
latefinal
-
referencePath
↔ Output<
String> -
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, {PackageAssociationState? state, CustomResourceOptions? options}) → PackageAssociation -
Gets an existing PackageAssociation resource's state with the given
nameandid.