Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.OpenSearchService

Classes

AdvancedSecurityOptions

Specifies options for fine-grained access control.

CapacityConfig

Configures the capacity of the cluster such as the instance type and the number of instances.

CfnApplication

Creates an OpenSearch UI application.

CfnApplication.AppConfigProperty

Configuration settings for an OpenSearch application.

CfnApplication.DataSourceProperty

Data sources that are associated with an OpenSearch application.

CfnApplication.IamIdentityCenterOptionsProperty

Configuration settings for IAM Identity Center in an OpenSearch application.

CfnApplicationProps

Properties for defining a CfnApplication.

CfnDomain

The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.

CfnDomain.AIMLOptionsProperty
CfnDomain.AdvancedSecurityOptionsInputProperty

Specifies options for fine-grained access control.

CfnDomain.AutomatedSnapshotPauseOptionsProperty
CfnDomain.ClusterConfigProperty

The cluster configuration for the OpenSearch Service domain.

CfnDomain.CognitoOptionsProperty

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

CfnDomain.ColdStorageOptionsProperty

Container for the parameters required to enable cold storage for an OpenSearch Service domain.

CfnDomain.DeploymentStrategyOptionsProperty
CfnDomain.DomainEndpointOptionsProperty

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

CfnDomain.EBSOptionsProperty

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

CfnDomain.EncryptionAtRestOptionsProperty

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

CfnDomain.IAMFederationOptionsProperty
CfnDomain.IdentityCenterOptionsProperty

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

CfnDomain.IdpProperty

The SAML Identity Provider's information.

CfnDomain.JWTOptionsProperty
CfnDomain.LogPublishingOptionProperty

Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.

CfnDomain.MasterUserOptionsProperty

Specifies information about the master user.

CfnDomain.NodeConfigProperty

Configuration options for defining the setup of any node type within the cluster.

CfnDomain.NodeOptionProperty

Configuration settings for defining the node type within a cluster.

CfnDomain.NodeToNodeEncryptionOptionsProperty

Specifies options for node-to-node encryption.

CfnDomain.OffPeakWindowOptionsProperty

Off-peak window settings for the domain.

CfnDomain.OffPeakWindowProperty

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.

CfnDomain.S3VectorsEngineProperty

Options for enabling S3 vectors engine features on the specified domain.

CfnDomain.SAMLOptionsProperty

Container for information about the SAML configuration for OpenSearch Dashboards.

CfnDomain.ServerlessVectorAccelerationProperty
CfnDomain.ServiceSoftwareOptionsProperty

The current status of the service software for an Amazon OpenSearch Service domain.

CfnDomain.SnapshotOptionsProperty

DEPRECATED .

CfnDomain.SoftwareUpdateOptionsProperty

Options for configuring service software updates for a domain.

CfnDomain.VPCOptionsProperty

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

CfnDomain.WindowStartTimeProperty

A custom start time for the off-peak window, in Coordinated Universal Time (UTC).

CfnDomain.ZoneAwarenessConfigProperty

Specifies zone awareness configuration options.

CfnDomainProps

Properties for defining a CfnDomain.

CognitoOptions

Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

CustomEndpointOptions

Configures a custom domain endpoint for the Amazon OpenSearch Service domain.

Domain

Provides an Amazon OpenSearch Service domain.

DomainAttributes

Reference to an Amazon OpenSearch Service domain.

DomainGrants

Collection of grant methods for a IDomainRef.

DomainProps

Properties for an Amazon OpenSearch Service domain.

EbsOptions

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

EncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.

EngineVersion

OpenSearch version.

LoggingOptions

Configures log settings for the domain.

NodeConfig

Configuration for a specific node type in OpenSearch domain.

NodeOptions

Configuration for node options in OpenSearch domain.

SAMLOptionsProperty

Container for information about the SAML configuration for OpenSearch Dashboards.

WindowStartTime
ZoneAwarenessConfig

Specifies zone awareness configuration options.

Interfaces

CfnApplication.IAppConfigProperty

Configuration settings for an OpenSearch application.

CfnApplication.IDataSourceProperty

Data sources that are associated with an OpenSearch application.

CfnApplication.IIamIdentityCenterOptionsProperty

Configuration settings for IAM Identity Center in an OpenSearch application.

CfnDomain.IAIMLOptionsProperty
CfnDomain.IAdvancedSecurityOptionsInputProperty

Specifies options for fine-grained access control.

CfnDomain.IAutomatedSnapshotPauseOptionsProperty
CfnDomain.IClusterConfigProperty

The cluster configuration for the OpenSearch Service domain.

CfnDomain.ICognitoOptionsProperty

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

CfnDomain.IColdStorageOptionsProperty

Container for the parameters required to enable cold storage for an OpenSearch Service domain.

CfnDomain.IDeploymentStrategyOptionsProperty
CfnDomain.IDomainEndpointOptionsProperty

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

CfnDomain.IEBSOptionsProperty

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

CfnDomain.IEncryptionAtRestOptionsProperty

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

CfnDomain.IIAMFederationOptionsProperty
CfnDomain.IIdentityCenterOptionsProperty

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

CfnDomain.IIdpProperty

The SAML Identity Provider's information.

CfnDomain.IJWTOptionsProperty
CfnDomain.ILogPublishingOptionProperty

Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.

CfnDomain.IMasterUserOptionsProperty

Specifies information about the master user.

CfnDomain.INodeConfigProperty

Configuration options for defining the setup of any node type within the cluster.

CfnDomain.INodeOptionProperty

Configuration settings for defining the node type within a cluster.

CfnDomain.INodeToNodeEncryptionOptionsProperty

Specifies options for node-to-node encryption.

CfnDomain.IOffPeakWindowOptionsProperty

Off-peak window settings for the domain.

CfnDomain.IOffPeakWindowProperty

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.

CfnDomain.IS3VectorsEngineProperty

Options for enabling S3 vectors engine features on the specified domain.

CfnDomain.ISAMLOptionsProperty

Container for information about the SAML configuration for OpenSearch Dashboards.

CfnDomain.IServerlessVectorAccelerationProperty
CfnDomain.IServiceSoftwareOptionsProperty

The current status of the service software for an Amazon OpenSearch Service domain.

CfnDomain.ISnapshotOptionsProperty

DEPRECATED .

CfnDomain.ISoftwareUpdateOptionsProperty

Options for configuring service software updates for a domain.

CfnDomain.IVPCOptionsProperty

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

CfnDomain.IWindowStartTimeProperty

A custom start time for the off-peak window, in Coordinated Universal Time (UTC).

CfnDomain.IZoneAwarenessConfigProperty

Specifies zone awareness configuration options.

IAdvancedSecurityOptions

Specifies options for fine-grained access control.

ICapacityConfig

Configures the capacity of the cluster such as the instance type and the number of instances.

ICfnApplicationProps

Properties for defining a CfnApplication.

ICfnDomainProps

Properties for defining a CfnDomain.

ICognitoOptions

Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

ICustomEndpointOptions

Configures a custom domain endpoint for the Amazon OpenSearch Service domain.

IDomain

An interface that represents an Amazon OpenSearch Service domain - either created with the CDK, or an existing one.

IDomainAttributes

Reference to an Amazon OpenSearch Service domain.

IDomainProps

Properties for an Amazon OpenSearch Service domain.

IEbsOptions

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain.

IEncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.

ILoggingOptions

Configures log settings for the domain.

INodeConfig

Configuration for a specific node type in OpenSearch domain.

INodeOptions

Configuration for node options in OpenSearch domain.

ISAMLOptionsProperty

Container for information about the SAML configuration for OpenSearch Dashboards.

IWindowStartTime
IZoneAwarenessConfig

Specifies zone awareness configuration options.

Enums

IpAddressType

The IP address type for the domain.

NodeType

NodeType is a string enum of the node types in OpenSearch domain.

TLSSecurityPolicy

The minimum TLS version required for traffic to the domain.

Back to top Generated by DocFX