opensearch/aws.sdk.kotlin.services.opensearch.model/PackageDetails/Builder

Builder

Properties

allowListedUserList

var allowListedUserList: List<String>?

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

availablePackageConfiguration

var availablePackageConfiguration: PackageConfiguration?

This represents the available configuration parameters for the package.

availablePackageVersion

var availablePackageVersion: String?

The package version.

availablePluginProperties

var availablePluginProperties: PluginProperties?

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

var createdAt: Instant?

The timestamp when the package was created.

var engineVersion: String?

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

var errorDetails: ErrorDetails?

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

var lastUpdatedAt: Instant?

Date and time when the package was last updated.

packageDescription

var packageDescription: String?

User-specified description of the package.

packageEncryptionOptions

var packageEncryptionOptions: PackageEncryptionOptions?

Encryption options for a package.

var packageId: String?

The unique identifier of the package.

var packageName: String?

The user-specified name of the package.

var packageOwner: String?

The owner of the package who is allowed to create and update a package and add users to the package scope.

var packageStatus: PackageStatus?

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

var packageType: PackageType?

The type of package.

packageVendingOptions

var packageVendingOptions: PackageVendingOptions?

Package Vending Options for a package.

Functions

availablePackageConfiguration

fun availablePackageConfiguration(block: PackageConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.opensearch.model.PackageConfiguration inside the given block

availablePluginProperties

fun availablePluginProperties(block: PluginProperties.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.opensearch.model.PluginProperties inside the given block

fun errorDetails(block: ErrorDetails.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.opensearch.model.ErrorDetails inside the given block

packageEncryptionOptions

fun packageEncryptionOptions(block: PackageEncryptionOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.opensearch.model.PackageEncryptionOptions inside the given block

packageVendingOptions

fun packageVendingOptions(block: PackageVendingOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.opensearch.model.PackageVendingOptions inside the given block