MDAA TS Docs
    Preparing search index...

    Interface MdaaOpensearchDomainProps

    interface MdaaOpensearchDomainProps {
        accessPolicies?: PolicyStatement[];
        automatedSnapshotStartHour: number;
        capacity: CapacityConfig;
        createOutputs?: boolean;
        createParams?: boolean;
        customEndpoint?: CustomEndpointOptions;
        ebs: EbsOptions;
        enableVersionUpgrade: boolean;
        encryptionKey: IKey;
        logGroup: MdaaLogGroup;
        masterUserRoleArn: string;
        naming: IMdaaResourceNaming;
        opensearchDomainName: string;
        samlOptions?: SAMLOptionsProperty;
        securityGroups: ISecurityGroup[];
        version: EngineVersion;
        vpc: IVpc;
        vpcSubnets: SubnetSelection[];
        zoneAwareness?: ZoneAwarenessConfig;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessPolicies? automatedSnapshotStartHour capacity createOutputs? createParams? customEndpoint? ebs enableVersionUpgrade encryptionKey logGroup masterUserRoleArn naming opensearchDomainName samlOptions? securityGroups version vpc vpcSubnets zoneAwareness?

    Properties

    accessPolicies?: PolicyStatement[]

    Array of IAM policy statements for domain access control beyond VPC security

    automatedSnapshotStartHour: number

    Hour (0-23) for automated snapshot start time ensuring regular backup operations

    capacity: CapacityConfig

    Capacity configuration defining cluster size, instance types, and scaling characteristics

    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

    customEndpoint?: CustomEndpointOptions

    Custom endpoint configuration for domain access using organization-specific FQDNs

    ebs: EbsOptions

    EBS storage configuration defining volume types, sizes, and performance characteristics

    enableVersionUpgrade: boolean

    Flag enabling automatic version upgrades for security patches and feature updates

    encryptionKey: IKey
    logGroup: MdaaLogGroup
    masterUserRoleArn: string
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    opensearchDomainName: string

    Functional name for the OpenSearch domain that will be processed through MDAA naming conventions

    samlOptions?: SAMLOptionsProperty

    SAML authentication configuration for SSO integration enabling centralized identity management

    securityGroups: ISecurityGroup[]

    Array of security groups for domain network access control defining inbound and outbound traffic rules

    version: EngineVersion

    OpenSearch engine version for the domain deployment controlling available features and compatibility

    vpc: IVpc

    VPC for OpenSearch domain deployment providing network isolation and security controls

    vpcSubnets: SubnetSelection[]
    zoneAwareness?: ZoneAwarenessConfig

    Zone awareness configuration for multi-availability zone deployment improving fault tolerance and availability

    Settings

    Member Visibility

    On This Page

    Properties