Skip to content
v2.273.0

AWS::OpenSearchServerless Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as opensearchserverless from 'aws-cdk-lib/aws-opensearchserverless';
python
import aws_cdk.aws_opensearchserverless as opensearchserverless
java
import software.amazon.awscdk.services.opensearchserverless.*;
csharp
using Amazon.CDK.AWS.OpenSearchServerless;
go
import opensearchserverless "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::OpenSearchServerless.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnAccessPolicyConstruct (L1)Creates a data access policy for OpenSearch Serverless.
CfnCollectionConstruct (L1)Specifies an OpenSearch Serverless collection.
CfnCollectionGroupConstruct (L1)Resource Type definition for AWS::OpenSearchServerless::CollectionGroup.
CfnCollectionIndexConstruct (L1)Resource Type definition for AWS::OpenSearchServerless::CollectionIndex.
CfnIndexConstruct (L1)An OpenSearch Serverless index resource.
CfnLifecyclePolicyConstruct (L1)Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
CfnSecurityConfigConstruct (L1)Specifies a security configuration for OpenSearch Serverless.
CfnSecurityPolicyConstruct (L1)Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.
CfnVpcEndpointConstruct (L1)Creates an OpenSearch Serverless-managed interface VPC endpoint.
CfnAccessPolicyPropsStructProperties for defining a CfnAccessPolicy.
CfnCollection.EncryptionConfigPropertyStructEncryption settings for the collection.
CfnCollection.FipsEndpointsPropertyStruct
CfnCollection.VectorOptionsPropertyStructVector search configuration options for the collection.
CfnCollectionGroup.CapacityLimitsPropertyStruct
CfnCollectionGroupPropsStructProperties for defining a CfnCollectionGroup.
CfnCollectionIndexPropsStructProperties for defining a CfnCollectionIndex.
CfnCollectionPropsStructProperties for defining a CfnCollection.
CfnIndex.AnalysisPropertyStructCustom analysis configuration including analyzers, tokenizers, and filters.
CfnIndex.AnalyzerItemsPropertyStruct
CfnIndex.IndexPropertyStructAn OpenSearch Serverless index resource.
CfnIndex.IndexSettingsPropertyStructIndex settings for the OpenSearch Serverless index.
CfnIndex.MappingsPropertyStructIndex mappings for the OpenSearch Serverless index.
CfnIndex.MethodPropertyStructConfiguration for k-NN search method.
CfnIndex.ParametersPropertyStructAdditional parameters for the k-NN algorithm.
CfnIndex.PropertyMappingPropertyStructProperty mappings for the OpenSearch Serverless index.
CfnIndexPropsStructProperties for defining a CfnIndex.
CfnLifecyclePolicyPropsStructProperties for defining a CfnLifecyclePolicy.
CfnSecurityConfig.IamFederationConfigOptionsPropertyStructDescribes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map.
CfnSecurityConfig.IamIdentityCenterConfigOptionsPropertyStructDescribes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
CfnSecurityConfig.SamlConfigOptionsPropertyStructDescribes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
CfnSecurityConfigPropsStructProperties for defining a CfnSecurityConfig.
CfnSecurityPolicyPropsStructProperties for defining a CfnSecurityPolicy.
CfnVpcEndpointPropsStructProperties for defining a CfnVpcEndpoint.