MDAA TS Docs
    Preparing search index...

    Interface MdaaRdsServerlessClusterProps

    interface MdaaRdsServerlessClusterProps {
        adminPasswordRotationDays?: number;
        backtrackWindowInSeconds?: number;
        backupRetention?: number;
        clusterIdentifier?: string;
        copyTagsToSnapshot?: boolean;
        createOutputs?: boolean;
        createParams?: boolean;
        defaultDatabaseName?: string;
        enableCloudwatchLogsExports?: boolean;
        enableDataApi?: boolean;
        enableIamDatabaseAuthentication?: boolean;
        encryptionKey: IKey;
        engine: "aurora-mysql" | "aurora-postgresql";
        engineVersion: AuroraPostgresEngineVersion | AuroraMysqlEngineVersion;
        masterUsername: string;
        monitoringIntervalsInSeconds?: number;
        monitoringRole: IRole;
        naming: IMdaaResourceNaming;
        parameterGroup?: IParameterGroup;
        port: number;
        removalPolicy?: RemovalPolicy;
        scaling?: ServerlessScalingOptions;
        securityGroups?: ISecurityGroup[];
        vpc: IVpc;
        vpcSubnets: SubnetSelection;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adminPasswordRotationDays?: number

    The number of days between automatic admin/master password rotation. @default: 30 days

    backtrackWindowInSeconds?: number

    The target backtrack window, in seconds NOTE: Currently, Backtrack is only supported for Aurora MySQL DB clusters @default: 86400 (i.e. 24 hours)

    backupRetention?: number
    clusterIdentifier?: string
    copyTagsToSnapshot?: boolean
    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

    defaultDatabaseName?: string
    enableCloudwatchLogsExports?: boolean

    Flag to indicate DB Engine specific log types for exporting to CloudWatch Logs. @default: true Valid values for Aurora MySQL: audit, error, general, slowquery Valid values for Aurora PostgreSQL: postgresql @see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports

    enableDataApi?: boolean
    enableIamDatabaseAuthentication?: boolean

    Indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts @default: true for Aurora MySQL and Aurora PostgreSQL

    encryptionKey: IKey
    engine: "aurora-mysql" | "aurora-postgresql"
    engineVersion: AuroraPostgresEngineVersion | AuroraMysqlEngineVersion

    Engine version specification controlling Aurora database version and feature availability

    masterUsername: string
    monitoringIntervalsInSeconds?: number
    monitoringRole: IRole
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    parameterGroup?: IParameterGroup
    port: number

    The database port. Port obfuscation (using a non default endpoint port) adds an additional layer of defense against non-targeted attacks Avoid using the following port: MySQL/Aurora 3306, SQL Server port 1433, PostgreSQL port 5432

    removalPolicy?: RemovalPolicy

    The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. @default: RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)

    scaling?: ServerlessScalingOptions
    securityGroups?: ISecurityGroup[]

    Array of security groups for Aurora cluster network access control defining inbound and

    vpc: IVpc

    VPC for Aurora cluster deployment providing network isolation and security controls for

    vpcSubnets: SubnetSelection