معرفی شرکت ها
aws-cdk.aws-opensearchservice-1.178.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
The CDK Construct Library for AWS::OpenSearchService
| ویژگی | مقدار |
|---|---|
| سیستم عامل | OS Independent |
| نام فایل | aws-cdk.aws-opensearchservice-1.178.0 |
| نام | aws-cdk.aws-opensearchservice |
| نسخه کتابخانه | 1.178.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Amazon Web Services |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | https://github.com/aws/aws-cdk |
| آدرس اینترنتی | https://pypi.org/project/aws-cdk.aws-opensearchservice/ |
| مجوز | Apache-2.0 |
# Amazon OpenSearch Service Construct Library
<!--BEGIN STABILITY BANNER-->---
Features | Stability
-----------------------------------|----------------------------------------------------------------
CFN Resources | 
Higher level constructs for Domain | 
> **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-->
Amazon OpenSearch Service is the successor to Amazon Elasticsearch Service.
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"
}
)
```
نیازمندی
| مقدار | نام |
|---|---|
| ==1.178.0 | aws-cdk.aws-certificatemanager |
| ==1.178.0 | aws-cdk.aws-cloudwatch |
| ==1.178.0 | aws-cdk.aws-ec2 |
| ==1.178.0 | aws-cdk.aws-iam |
| ==1.178.0 | aws-cdk.aws-kms |
| ==1.178.0 | aws-cdk.aws-logs |
| ==1.178.0 | aws-cdk.aws-route53 |
| ==1.178.0 | aws-cdk.aws-secretsmanager |
| ==1.178.0 | aws-cdk.core |
| ==1.178.0 | aws-cdk.custom-resources |
| <4.0.0,>=3.3.69 | constructs |
| <2.0.0,>=1.69.0 | jsii |
| >=0.0.3 | publication |
| ~=2.13.3 | typeguard |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| ~=3.7 | Python |
نحوه نصب
نصب پکیج whl aws-cdk.aws-opensearchservice-1.178.0:
pip install aws-cdk.aws-opensearchservice-1.178.0.whl
نصب پکیج tar.gz aws-cdk.aws-opensearchservice-1.178.0:
pip install aws-cdk.aws-opensearchservice-1.178.0.tar.gz