MDAA TS Docs
    Preparing search index...

    Interface MdaaOpensearchServerlessCollectionProps

    interface MdaaOpensearchServerlessCollectionProps {
        accessPolicies?: PolicyStatement[];
        collectionType: CollectionType;
        createOutputs?: boolean;
        createParams?: boolean;
        encryptionKey: IKey;
        name: string;
        naming: IMdaaResourceNaming;
        network: VpcNetworkConfig;
        readOnlyArns?: string[];
        readWriteArns?: string[];
        sourceServices: string[];
        standByReplicas: StandByReplicas;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessPolicies? collectionType createOutputs? createParams? encryptionKey name naming network readOnlyArns? readWriteArns? sourceServices standByReplicas

    Properties

    accessPolicies?: PolicyStatement[]

    Domain Access Policies

    collectionType: CollectionType

    The type of collection. Possible values are SEARCH, TIMESERIES, and VECTORSEARCH.

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    encryptionKey: IKey

    ARN of the KMS key to use for encryption of data at rest.

    name: string

    Functional Name of Opensearch Serverless Collection

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    network: VpcNetworkConfig

    VPC network configuration including VPC, subnets, security groups, and VPC endpoint. The VPC endpoint must be created by the caller and shared across collections in the same VPC.

    readOnlyArns?: string[]

    IAM principals (role ARNs) to grant read only data access

    readWriteArns?: string[]

    IAM principals (role ARNs) to grant read write data access

    sourceServices: string[]

    Service principals to allow access to the collection.

    standByReplicas: StandByReplicas

    Indicates whether to use standby replicas for the collection. Valid values: ENABLE | DISABLE. Value can't be updated after collection is created.

    Settings

    Member Visibility

    On This Page

    Properties