DomainPackageDetails

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

AssociationConfiguration

The configuration for associating a package with an Amazon OpenSearch Service domain.

Type: PackageAssociationConfiguration object

Required: No

DomainName

Name of the domain that the package is associated with.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: No

DomainPackageStatus

State of the association.

Type: String

Valid Values: ASSOCIATING | ASSOCIATION_FAILED | ACTIVE | DISSOCIATING | DISSOCIATION_FAILED

Required: No

ErrorDetails

Additional information if the package is in an error state. Null otherwise.

Type: ErrorDetails object

Required: No

LastUpdated

Timestamp of the most recent update to the package association status.

Type: Timestamp

Required: No

PackageID

Internal ID of the package.

Type: String

Pattern: ^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$

Required: No

PackageName

User-specified name of the package.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 256.

Pattern: [a-z][a-z0-9\-]+

Required: No

PackageType

The type of package.

Type: String

Valid Values: TXT-DICTIONARY | ZIP-PLUGIN | PACKAGE-LICENSE | PACKAGE-CONFIG

Required: No

PackageVersion

The current version of the package.

Type: String

Required: No

PrerequisitePackageIDList

A list of package IDs that must be associated with the domain before or with the package can be associated.

Type: Array of strings

Pattern: ^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$

Required: No

ReferencePath

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

Type: String

Required: No

DomainPackageDetails

Contents

See Also