aws-cdk.aws-opensearchservice


Nameaws-cdk.aws-opensearchservice JSON
Version 1.204.0 PyPI version JSON
download
home_pagehttps://github.com/aws/aws-cdk
SummaryThe CDK Construct Library for AWS::OpenSearchService
upload_time2023-06-19 21:06:29
maintainer
docs_urlNone
authorAmazon Web Services
requires_python~=3.7
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Amazon OpenSearch Service Construct Library

<!--BEGIN STABILITY BANNER-->---


![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)

> AWS CDK v1 has reached End-of-Support on 2023-06-01.
> This package is no longer being updated, and users should migrate to AWS CDK v2.
>
> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).

---


Features                           | Stability
-----------------------------------|----------------------------------------------------------------
CFN Resources                      | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge)
Higher level constructs for Domain | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge)

> **CFN Resources:** All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always
> stable and safe to use.

<!-- -->

> **Stable:** Higher level constructs in this module that are marked stable will not undergo any
> breaking changes. They will strictly follow the [Semantic Versioning](https://semver.org/) model.

---
<!--END STABILITY BANNER-->

See [Migrating to OpenSearch](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-elasticsearch-readme.html#migrating-to-opensearch) for migration instructions from `@aws-cdk/aws-elasticsearch` to this module, `@aws-cdk/aws-opensearchservice`.

## Quick start

Create a development cluster by simply specifying the version:

```python
dev_domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0
)
```

To perform version upgrades without replacing the entire domain, specify the `enableVersionUpgrade` property.

```python
dev_domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    enable_version_upgrade=True
)
```

Create a production grade cluster by also specifying things like capacity and az distribution

```python
prod_domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    capacity=opensearch.CapacityConfig(
        master_nodes=5,
        data_nodes=20
    ),
    ebs=opensearch.EbsOptions(
        volume_size=20
    ),
    zone_awareness=opensearch.ZoneAwarenessConfig(
        availability_zone_count=3
    ),
    logging=opensearch.LoggingOptions(
        slow_search_log_enabled=True,
        app_log_enabled=True,
        slow_index_log_enabled=True
    )
)
```

This creates an Amazon OpenSearch Service cluster and automatically sets up log groups for
logging the domain logs and slow search logs.

## A note about SLR

Some cluster configurations (e.g VPC access) require the existence of the [`AWSServiceRoleForAmazonElasticsearchService`](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/slr.html) Service-Linked Role.

When performing such operations via the AWS Console, this SLR is created automatically when needed. However, this is not the behavior when using CloudFormation. If an SLR is needed, but doesn't exist, you will encounter a failure message simlar to:

```console
Before you can proceed, you must enable a service-linked role to give Amazon OpenSearch Service...
```

To resolve this, you need to [create](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#create-service-linked-role) the SLR. We recommend using the AWS CLI:

```console
aws iam create-service-linked-role --aws-service-name es.amazonaws.com
```

You can also create it using the CDK, **but note that only the first application deploying this will succeed**:

```python
slr = iam.CfnServiceLinkedRole(self, "Service Linked Role",
    aws_service_name="es.amazonaws.com"
)
```

## Importing existing domains

To import an existing domain into your CDK application, use the `Domain.fromDomainEndpoint` factory method.
This method accepts a domain endpoint of an already existing domain:

```python
domain_endpoint = "https://my-domain-jcjotrt6f7otem4sqcwbch3c4u.us-east-1.es.amazonaws.com"
domain = opensearch.Domain.from_domain_endpoint(self, "ImportedDomain", domain_endpoint)
```

## Permissions

### IAM

Helper methods also exist for managing access to the domain.

```python
# fn: lambda.Function
# domain: opensearch.Domain


# Grant write access to the app-search index
domain.grant_index_write("app-search", fn)

# Grant read access to the 'app-search/_search' path
domain.grant_path_read("app-search/_search", fn)
```

## Encryption

The domain can also be created with encryption enabled:

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    ebs=opensearch.EbsOptions(
        volume_size=100,
        volume_type=ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    ),
    node_to_node_encryption=True,
    encryption_at_rest=opensearch.EncryptionAtRestOptions(
        enabled=True
    )
)
```

This sets up the domain with node to node encryption and encryption at
rest. You can also choose to supply your own KMS key to use for encryption at
rest.

## VPC Support

Domains can be placed inside a VPC, providing a secure communication between Amazon OpenSearch Service and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection.

> Visit [VPC Support for Amazon OpenSearch Service Domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details.

```python
vpc = ec2.Vpc(self, "Vpc")
domain_props = opensearch.DomainProps(
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    removal_policy=RemovalPolicy.DESTROY,
    vpc=vpc,
    # must be enabled since our VPC contains multiple private subnets.
    zone_awareness=opensearch.ZoneAwarenessConfig(
        enabled=True
    ),
    capacity=opensearch.CapacityConfig(
        # must be an even number since the default az count is 2.
        data_nodes=2
    )
)
opensearch.Domain(self, "Domain", domain_props)
```

In addition, you can use the `vpcSubnets` property to control which specific subnets will be used, and the `securityGroups` property to control
which security groups will be attached to the domain. By default, CDK will select all *private* subnets in the VPC, and create one dedicated security group.

## Metrics

Helper methods exist to access common domain metrics for example:

```python
# domain: opensearch.Domain

free_storage_space = domain.metric_free_storage_space()
master_sys_memory_utilization = domain.metric("MasterSysMemoryUtilization")
```

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

## Fine grained access control

The domain can also be created with a master user configured. The password can
be supplied or dynamically created if not supplied.

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    enforce_https=True,
    node_to_node_encryption=True,
    encryption_at_rest=opensearch.EncryptionAtRestOptions(
        enabled=True
    ),
    fine_grained_access_control=opensearch.AdvancedSecurityOptions(
        master_user_name="master-user"
    )
)

master_user_password = domain.master_user_password
```

## Using unsigned basic auth

For convenience, the domain can be configured to allow unsigned HTTP requests
that use basic auth. Unless the domain is configured to be part of a VPC this
means anyone can access the domain using the configured master username and
password.

To enable unsigned basic auth access the domain is configured with an access
policy that allows anyonmous requests, HTTPS required, node to node encryption,
encryption at rest and fine grained access control.

If the above settings are not set they will be configured as part of enabling
unsigned basic auth. If they are set with conflicting values, an error will be
thrown.

If no master user is configured a default master user is created with the
username `admin`.

If no password is configured a default master user password is created and
stored in the AWS Secrets Manager as secret. The secret has the prefix
`<domain id>MasterUser`.

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    use_unsigned_basic_auth=True
)

master_user_password = domain.master_user_password
```

## Custom access policies

If the domain requires custom access control it can be configured either as a
constructor property, or later by means of a helper method.

For simple permissions the `accessPolicies` constructor may be sufficient:

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    access_policies=[
        iam.PolicyStatement(
            actions=["es:*ESHttpPost", "es:ESHttpPut*"],
            effect=iam.Effect.ALLOW,
            principals=[iam.AccountPrincipal("123456789012")],
            resources=["*"]
        )
    ]
)
```

For more complex use-cases, for example, to set the domain up to receive data from a
[cross-account Kinesis Firehose](https://aws.amazon.com/premiumsupport/knowledge-center/kinesis-firehose-cross-account-streaming/) the `addAccessPolicies` helper method
allows for policies that include the explicit domain ARN.

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0
)
domain.add_access_policies(
    iam.PolicyStatement(
        actions=["es:ESHttpPost", "es:ESHttpPut"],
        effect=iam.Effect.ALLOW,
        principals=[iam.AccountPrincipal("123456789012")],
        resources=[domain.domain_arn, f"{domain.domainArn}/*"]
    ),
    iam.PolicyStatement(
        actions=["es:ESHttpGet"],
        effect=iam.Effect.ALLOW,
        principals=[iam.AccountPrincipal("123456789012")],
        resources=[f"{domain.domainArn}/_all/_settings", f"{domain.domainArn}/_cluster/stats", f"{domain.domainArn}/index-name*/_mapping/type-name", f"{domain.domainArn}/roletest*/_mapping/roletest", f"{domain.domainArn}/_nodes", f"{domain.domainArn}/_nodes/stats", f"{domain.domainArn}/_nodes/*/stats", f"{domain.domainArn}/_stats", f"{domain.domainArn}/index-name*/_stats", f"{domain.domainArn}/roletest*/_stat"
        ]
    ))
```

## Audit logs

Audit logs can be enabled for a domain, but only when fine grained access control is enabled.

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    enforce_https=True,
    node_to_node_encryption=True,
    encryption_at_rest=opensearch.EncryptionAtRestOptions(
        enabled=True
    ),
    fine_grained_access_control=opensearch.AdvancedSecurityOptions(
        master_user_name="master-user"
    ),
    logging=opensearch.LoggingOptions(
        audit_log_enabled=True,
        slow_search_log_enabled=True,
        app_log_enabled=True,
        slow_index_log_enabled=True
    )
)
```

## UltraWarm

UltraWarm nodes can be enabled to provide a cost-effective way to store large amounts of read-only data.

```python
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    capacity=opensearch.CapacityConfig(
        master_nodes=2,
        warm_nodes=2,
        warm_instance_type="ultrawarm1.medium.search"
    )
)
```

## Custom endpoint

Custom endpoints can be configured to reach the domain under a custom domain name.

```python
opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    custom_endpoint=opensearch.CustomEndpointOptions(
        domain_name="search.example.com"
    )
)
```

It is also possible to specify a custom certificate instead of the auto-generated one.

Additionally, an automatic CNAME-Record is created if a hosted zone is provided for the custom endpoint

## Advanced options

[Advanced options](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options.

```python
opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_1_0,
    advanced_options={
        "rest.action.multi.allow_explicit_index": "false",
        "indices.fielddata.cache.size": "25",
        "indices.query.bool.max_clause_count": "2048"
    }
)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aws/aws-cdk",
    "name": "aws-cdk.aws-opensearchservice",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "~=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Amazon Web Services",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/db/d1/9202d2a38f86ed52ca80efe6168665503b61523080a0702d413a98cf7f85/aws-cdk.aws-opensearchservice-1.204.0.tar.gz",
    "platform": null,
    "description": "# Amazon OpenSearch Service Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).\n\n---\n\n\nFeatures                           | Stability\n-----------------------------------|----------------------------------------------------------------\nCFN Resources                      | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge)\nHigher level constructs for Domain | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge)\n\n> **CFN Resources:** All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always\n> stable and safe to use.\n\n<!-- -->\n\n> **Stable:** Higher level constructs in this module that are marked stable will not undergo any\n> breaking changes. They will strictly follow the [Semantic Versioning](https://semver.org/) model.\n\n---\n<!--END STABILITY BANNER-->\n\nSee [Migrating to OpenSearch](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-elasticsearch-readme.html#migrating-to-opensearch) for migration instructions from `@aws-cdk/aws-elasticsearch` to this module, `@aws-cdk/aws-opensearchservice`.\n\n## Quick start\n\nCreate a development cluster by simply specifying the version:\n\n```python\ndev_domain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0\n)\n```\n\nTo perform version upgrades without replacing the entire domain, specify the `enableVersionUpgrade` property.\n\n```python\ndev_domain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    enable_version_upgrade=True\n)\n```\n\nCreate a production grade cluster by also specifying things like capacity and az distribution\n\n```python\nprod_domain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    capacity=opensearch.CapacityConfig(\n        master_nodes=5,\n        data_nodes=20\n    ),\n    ebs=opensearch.EbsOptions(\n        volume_size=20\n    ),\n    zone_awareness=opensearch.ZoneAwarenessConfig(\n        availability_zone_count=3\n    ),\n    logging=opensearch.LoggingOptions(\n        slow_search_log_enabled=True,\n        app_log_enabled=True,\n        slow_index_log_enabled=True\n    )\n)\n```\n\nThis creates an Amazon OpenSearch Service cluster and automatically sets up log groups for\nlogging the domain logs and slow search logs.\n\n## A note about SLR\n\nSome cluster configurations (e.g VPC access) require the existence of the [`AWSServiceRoleForAmazonElasticsearchService`](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/slr.html) Service-Linked Role.\n\nWhen performing such operations via the AWS Console, this SLR is created automatically when needed. However, this is not the behavior when using CloudFormation. If an SLR is needed, but doesn't exist, you will encounter a failure message simlar to:\n\n```console\nBefore you can proceed, you must enable a service-linked role to give Amazon OpenSearch Service...\n```\n\nTo resolve this, you need to [create](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#create-service-linked-role) the SLR. We recommend using the AWS CLI:\n\n```console\naws iam create-service-linked-role --aws-service-name es.amazonaws.com\n```\n\nYou can also create it using the CDK, **but note that only the first application deploying this will succeed**:\n\n```python\nslr = iam.CfnServiceLinkedRole(self, \"Service Linked Role\",\n    aws_service_name=\"es.amazonaws.com\"\n)\n```\n\n## Importing existing domains\n\nTo import an existing domain into your CDK application, use the `Domain.fromDomainEndpoint` factory method.\nThis method accepts a domain endpoint of an already existing domain:\n\n```python\ndomain_endpoint = \"https://my-domain-jcjotrt6f7otem4sqcwbch3c4u.us-east-1.es.amazonaws.com\"\ndomain = opensearch.Domain.from_domain_endpoint(self, \"ImportedDomain\", domain_endpoint)\n```\n\n## Permissions\n\n### IAM\n\nHelper methods also exist for managing access to the domain.\n\n```python\n# fn: lambda.Function\n# domain: opensearch.Domain\n\n\n# Grant write access to the app-search index\ndomain.grant_index_write(\"app-search\", fn)\n\n# Grant read access to the 'app-search/_search' path\ndomain.grant_path_read(\"app-search/_search\", fn)\n```\n\n## Encryption\n\nThe domain can also be created with encryption enabled:\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    ebs=opensearch.EbsOptions(\n        volume_size=100,\n        volume_type=ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD\n    ),\n    node_to_node_encryption=True,\n    encryption_at_rest=opensearch.EncryptionAtRestOptions(\n        enabled=True\n    )\n)\n```\n\nThis sets up the domain with node to node encryption and encryption at\nrest. You can also choose to supply your own KMS key to use for encryption at\nrest.\n\n## VPC Support\n\nDomains can be placed inside a VPC, providing a secure communication between Amazon OpenSearch Service and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection.\n\n> Visit [VPC Support for Amazon OpenSearch Service Domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details.\n\n```python\nvpc = ec2.Vpc(self, \"Vpc\")\ndomain_props = opensearch.DomainProps(\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    removal_policy=RemovalPolicy.DESTROY,\n    vpc=vpc,\n    # must be enabled since our VPC contains multiple private subnets.\n    zone_awareness=opensearch.ZoneAwarenessConfig(\n        enabled=True\n    ),\n    capacity=opensearch.CapacityConfig(\n        # must be an even number since the default az count is 2.\n        data_nodes=2\n    )\n)\nopensearch.Domain(self, \"Domain\", domain_props)\n```\n\nIn addition, you can use the `vpcSubnets` property to control which specific subnets will be used, and the `securityGroups` property to control\nwhich security groups will be attached to the domain. By default, CDK will select all *private* subnets in the VPC, and create one dedicated security group.\n\n## Metrics\n\nHelper methods exist to access common domain metrics for example:\n\n```python\n# domain: opensearch.Domain\n\nfree_storage_space = domain.metric_free_storage_space()\nmaster_sys_memory_utilization = domain.metric(\"MasterSysMemoryUtilization\")\n```\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Fine grained access control\n\nThe domain can also be created with a master user configured. The password can\nbe supplied or dynamically created if not supplied.\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    enforce_https=True,\n    node_to_node_encryption=True,\n    encryption_at_rest=opensearch.EncryptionAtRestOptions(\n        enabled=True\n    ),\n    fine_grained_access_control=opensearch.AdvancedSecurityOptions(\n        master_user_name=\"master-user\"\n    )\n)\n\nmaster_user_password = domain.master_user_password\n```\n\n## Using unsigned basic auth\n\nFor convenience, the domain can be configured to allow unsigned HTTP requests\nthat use basic auth. Unless the domain is configured to be part of a VPC this\nmeans anyone can access the domain using the configured master username and\npassword.\n\nTo enable unsigned basic auth access the domain is configured with an access\npolicy that allows anyonmous requests, HTTPS required, node to node encryption,\nencryption at rest and fine grained access control.\n\nIf the above settings are not set they will be configured as part of enabling\nunsigned basic auth. If they are set with conflicting values, an error will be\nthrown.\n\nIf no master user is configured a default master user is created with the\nusername `admin`.\n\nIf no password is configured a default master user password is created and\nstored in the AWS Secrets Manager as secret. The secret has the prefix\n`<domain id>MasterUser`.\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    use_unsigned_basic_auth=True\n)\n\nmaster_user_password = domain.master_user_password\n```\n\n## Custom access policies\n\nIf the domain requires custom access control it can be configured either as a\nconstructor property, or later by means of a helper method.\n\nFor simple permissions the `accessPolicies` constructor may be sufficient:\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    access_policies=[\n        iam.PolicyStatement(\n            actions=[\"es:*ESHttpPost\", \"es:ESHttpPut*\"],\n            effect=iam.Effect.ALLOW,\n            principals=[iam.AccountPrincipal(\"123456789012\")],\n            resources=[\"*\"]\n        )\n    ]\n)\n```\n\nFor more complex use-cases, for example, to set the domain up to receive data from a\n[cross-account Kinesis Firehose](https://aws.amazon.com/premiumsupport/knowledge-center/kinesis-firehose-cross-account-streaming/) the `addAccessPolicies` helper method\nallows for policies that include the explicit domain ARN.\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0\n)\ndomain.add_access_policies(\n    iam.PolicyStatement(\n        actions=[\"es:ESHttpPost\", \"es:ESHttpPut\"],\n        effect=iam.Effect.ALLOW,\n        principals=[iam.AccountPrincipal(\"123456789012\")],\n        resources=[domain.domain_arn, f\"{domain.domainArn}/*\"]\n    ),\n    iam.PolicyStatement(\n        actions=[\"es:ESHttpGet\"],\n        effect=iam.Effect.ALLOW,\n        principals=[iam.AccountPrincipal(\"123456789012\")],\n        resources=[f\"{domain.domainArn}/_all/_settings\", f\"{domain.domainArn}/_cluster/stats\", f\"{domain.domainArn}/index-name*/_mapping/type-name\", f\"{domain.domainArn}/roletest*/_mapping/roletest\", f\"{domain.domainArn}/_nodes\", f\"{domain.domainArn}/_nodes/stats\", f\"{domain.domainArn}/_nodes/*/stats\", f\"{domain.domainArn}/_stats\", f\"{domain.domainArn}/index-name*/_stats\", f\"{domain.domainArn}/roletest*/_stat\"\n        ]\n    ))\n```\n\n## Audit logs\n\nAudit logs can be enabled for a domain, but only when fine grained access control is enabled.\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    enforce_https=True,\n    node_to_node_encryption=True,\n    encryption_at_rest=opensearch.EncryptionAtRestOptions(\n        enabled=True\n    ),\n    fine_grained_access_control=opensearch.AdvancedSecurityOptions(\n        master_user_name=\"master-user\"\n    ),\n    logging=opensearch.LoggingOptions(\n        audit_log_enabled=True,\n        slow_search_log_enabled=True,\n        app_log_enabled=True,\n        slow_index_log_enabled=True\n    )\n)\n```\n\n## UltraWarm\n\nUltraWarm nodes can be enabled to provide a cost-effective way to store large amounts of read-only data.\n\n```python\ndomain = opensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    capacity=opensearch.CapacityConfig(\n        master_nodes=2,\n        warm_nodes=2,\n        warm_instance_type=\"ultrawarm1.medium.search\"\n    )\n)\n```\n\n## Custom endpoint\n\nCustom endpoints can be configured to reach the domain under a custom domain name.\n\n```python\nopensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    custom_endpoint=opensearch.CustomEndpointOptions(\n        domain_name=\"search.example.com\"\n    )\n)\n```\n\nIt is also possible to specify a custom certificate instead of the auto-generated one.\n\nAdditionally, an automatic CNAME-Record is created if a hosted zone is provided for the custom endpoint\n\n## Advanced options\n\n[Advanced options](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options.\n\n```python\nopensearch.Domain(self, \"Domain\",\n    version=opensearch.EngineVersion.OPENSEARCH_1_0,\n    advanced_options={\n        \"rest.action.multi.allow_explicit_index\": \"false\",\n        \"indices.fielddata.cache.size\": \"25\",\n        \"indices.query.bool.max_clause_count\": \"2048\"\n    }\n)\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "The CDK Construct Library for AWS::OpenSearchService",
    "version": "1.204.0",
    "project_urls": {
        "Homepage": "https://github.com/aws/aws-cdk",
        "Source": "https://github.com/aws/aws-cdk.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "399cb82fb6f307a1ed83364830842073ee5286fdffa0e7d8a3ac6eea17bcbd6d",
                "md5": "086b9ffadc052b0dbc65b102dd6dc8ae",
                "sha256": "c09fe7676f4360b0671ab89d87c726c94cc4ac159510f30d4811f91e0baa0403"
            },
            "downloads": -1,
            "filename": "aws_cdk.aws_opensearchservice-1.204.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "086b9ffadc052b0dbc65b102dd6dc8ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.7",
            "size": 229455,
            "upload_time": "2023-06-19T20:59:57",
            "upload_time_iso_8601": "2023-06-19T20:59:57.902377Z",
            "url": "https://files.pythonhosted.org/packages/39/9c/b82fb6f307a1ed83364830842073ee5286fdffa0e7d8a3ac6eea17bcbd6d/aws_cdk.aws_opensearchservice-1.204.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dbd19202d2a38f86ed52ca80efe6168665503b61523080a0702d413a98cf7f85",
                "md5": "f2ce1fdad66412aa634be9ae55a59702",
                "sha256": "241ab1f6f86fa05d1ea21d3168df9f775994acadac09ee1e026741ffb8867f82"
            },
            "downloads": -1,
            "filename": "aws-cdk.aws-opensearchservice-1.204.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f2ce1fdad66412aa634be9ae55a59702",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 230431,
            "upload_time": "2023-06-19T21:06:29",
            "upload_time_iso_8601": "2023-06-19T21:06:29.501632Z",
            "url": "https://files.pythonhosted.org/packages/db/d1/9202d2a38f86ed52ca80efe6168665503b61523080a0702d413a98cf7f85/aws-cdk.aws-opensearchservice-1.204.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-19 21:06:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aws",
    "github_project": "aws-cdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "aws-cdk.aws-opensearchservice"
}
        
Elapsed time: 0.09979s