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

Builder

Properties

var accessPolicies: String?

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

advancedOptions

var advancedOptions: Map<String, String>?

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

advancedSecurityOptions

var advancedSecurityOptions: AdvancedSecurityOptionsInput?

Options for fine-grained access control.

var aimlOptions: AimlOptionsInput?

Options for all machine learning features for the specified domain.

autoTuneOptions

var autoTuneOptions: AutoTuneOptionsInput?

Options for Auto-Tune.

var clusterConfig: ClusterConfig?

Container for the cluster configuration of a domain.

var cognitoOptions: CognitoOptions?

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

domainEndpointOptions

var domainEndpointOptions: DomainEndpointOptions?

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

var domainName: String?

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

var ebsOptions: EbsOptions?

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

encryptionAtRestOptions

var encryptionAtRestOptions: EncryptionAtRestOptions?

Key-value pairs to enable encryption at rest.

var engineVersion: String?

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

identityCenterOptions

var identityCenterOptions: IdentityCenterOptionsInput?

Configuration options for enabling and managing IAM Identity Center integration within a domain.

var ipAddressType: IpAddressType?

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

logPublishingOptions

var logPublishingOptions: Map<LogType, LogPublishingOption>?

Key-value pairs to configure log publishing.

nodeToNodeEncryptionOptions

var nodeToNodeEncryptionOptions: NodeToNodeEncryptionOptions?

Enables node-to-node encryption.

offPeakWindowOptions

var offPeakWindowOptions: OffPeakWindowOptions?

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

snapshotOptions

var snapshotOptions: SnapshotOptions?

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

softwareUpdateOptions

var softwareUpdateOptions: SoftwareUpdateOptions?

Software update options for the domain.

var tagList: List<Tag>?

List of tags to add to the domain upon creation.

var vpcOptions: VpcOptions?

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

Functions

advancedSecurityOptions

fun advancedSecurityOptions(block: AdvancedSecurityOptionsInput.Builder.() -> Unit)

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

fun aimlOptions(block: AimlOptionsInput.Builder.() -> Unit)

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

autoTuneOptions

fun autoTuneOptions(block: AutoTuneOptionsInput.Builder.() -> Unit)

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

fun clusterConfig(block: ClusterConfig.Builder.() -> Unit)

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

fun cognitoOptions(block: CognitoOptions.Builder.() -> Unit)

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

domainEndpointOptions

fun domainEndpointOptions(block: DomainEndpointOptions.Builder.() -> Unit)

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

fun ebsOptions(block: EbsOptions.Builder.() -> Unit)

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

encryptionAtRestOptions

fun encryptionAtRestOptions(block: EncryptionAtRestOptions.Builder.() -> Unit)

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

identityCenterOptions

fun identityCenterOptions(block: IdentityCenterOptionsInput.Builder.() -> Unit)

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

nodeToNodeEncryptionOptions

fun nodeToNodeEncryptionOptions(block: NodeToNodeEncryptionOptions.Builder.() -> Unit)

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

offPeakWindowOptions

fun offPeakWindowOptions(block: OffPeakWindowOptions.Builder.() -> Unit)

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

snapshotOptions

fun snapshotOptions(block: SnapshotOptions.Builder.() -> Unit)

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

softwareUpdateOptions

fun softwareUpdateOptions(block: SoftwareUpdateOptions.Builder.() -> Unit)

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

fun vpcOptions(block: VpcOptions.Builder.() -> Unit)

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