One Observability Workshop / constructs/opensearch-collection / OpenSearchCollection

Class: OpenSearchCollection¶

Defined in: constructs/opensearch-collection.ts:68

AWS CDK Construct that creates OpenSearch Serverless collection with CloudWatch alarms for pet adoption OpenSearchCollection

Extends¶

Construct

Constructors¶

Constructor¶

new OpenSearchCollection(scope, id, properties?): OpenSearchCollection

Defined in: constructs/opensearch-collection.ts:93

Creates a new OpenSearchCollection construct with collection

Parameters¶

scope¶

Construct

The parent construct

id¶

string

The construct ID

properties?¶

OpenSearchCollectionProperties

Configuration properties for the construct (optional)

Returns¶

OpenSearchCollection

Overrides¶

Construct.constructor

Properties¶

collection¶

collection: CfnCollection

Defined in: constructs/opensearch-collection.ts:73

The OpenSearch Serverless collection for storing pet adoption data

securityPolicy¶

securityPolicy: CfnSecurityPolicy

Defined in: constructs/opensearch-collection.ts:79

The security policy for the collection

accessPolicy¶

accessPolicy: CfnAccessPolicy

Defined in: constructs/opensearch-collection.ts:85

The access policy for the collection

Methods¶

importFromExports()¶

static importFromExports(): object

Defined in: constructs/opensearch-collection.ts:222

Returns¶

object

collectionArn¶

collectionArn: string

collectionId¶

collectionId: string

collectionEndpoint¶

collectionEndpoint: string

addIngestionRoles()¶

addIngestionRoles(roles): void

Defined in: constructs/opensearch-collection.ts:242

Add additional ingestion roles to the access policy

Parameters¶

roles¶

IRole[]

Array of IAM roles to grant access

Returns¶

void

createOutputs()¶

createOutputs(): void

Defined in: constructs/opensearch-collection.ts:288

Returns¶

void