MDAA TS Docs
    Preparing search index...

    Interface AccountWithNameProps

    QuickSight account configuration controlling edition, authentication, VPC connectivity, and access restrictions. MDAA deploys a service account, security group, and VPC connection for secure data source connectivity.

    Use cases: Account provisioning; VPC data source connectivity; IP-based access control; Glue catalog integration

    AWS: Amazon QuickSight account, VPC connection, security group

    Validation: Required fields: edition, authenticationMethod, notificationEmail, vpcId, subnetIds

    interface AccountWithNameProps {
        accountName: string;
        authenticationMethod: AuthenticationMethod;
        contactNumber?: string;
        edition: Edition;
        emailAddress?: string;
        firstName?: string;
        glueResourceAccess?: string[];
        groups?: string[];
        ipRestrictions?: IpRestrictionProps[];
        lastName?: string;
        notificationEmail: string;
        resourceAccessRolePermissions?: ResourceAccessRolePermissionsProps;
        securityGroupAccess?: MdaaSecurityGroupRuleProps;
        subnetIds: string[];
        vpcId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountName authenticationMethod contactNumber? edition emailAddress? firstName? glueResourceAccess? groups? ipRestrictions? lastName? notificationEmail resourceAccessRolePermissions? securityGroupAccess? subnetIds vpcId

    Properties

    accountName: string
    authenticationMethod: AuthenticationMethod

    Authentication method controlling how users sign in to QuickSight.

    Use cases: IAM federation; Active Directory integration; Mixed authentication

    AWS: QuickSight account authentication configuration

    Validation: Required; 'IAM_AND_QUICKSIGHT' | 'IAM_ONLY' | 'ACTIVE_DIRECTORY'

    contactNumber?: string

    Phone number for the QuickSight account administrator.

    Use cases: Admin contact; Support escalation

    AWS: QuickSight account admin phone

    Validation: Optional; 10 digits

    edition: Edition

    QuickSight edition determining feature set and pricing tier.

    Use cases: Feature tier selection; Q AI capabilities; Enterprise governance

    AWS: QuickSight account edition

    Validation: Required; 'STANDARD' | 'ENTERPRISE' | 'ENTERPRISE_AND_Q'

    emailAddress?: string

    Email address of the QuickSight account administrator.

    Use cases: Admin contact; Account management notifications

    AWS: QuickSight account admin email

    Validation: Optional; valid email format

    firstName?: string

    First name of the QuickSight account administrator.

    Use cases: Account personalization; AWS support communications

    AWS: QuickSight account admin contact

    Validation: Optional; string

    glueResourceAccess?: string[]

    Glue resource patterns granting the QuickSight service role read access to data catalog databases and tables for data source setup and validation.

    Use cases: Glue catalog integration; Athena data source discovery; Schema validation

    AWS: IAM permissions for QuickSight service role on Glue resources

    Validation: Optional; array of Glue resource patterns (e.g., 'database/my-db*')

    groups?: string[]

    Names of QuickSight groups (in the default namespace) to create. Groups are the QuickSight identity construct referenced when granting access to data sources, datasets, and folders. Created idempotently (existing groups are left as-is); not deleted on stack removal. Add users to these groups separately (the console or quicksight create-group-membership).

    Use cases: Reader/Author access tiers referenced by data source and folder permissions

    AWS: QuickSight groups in the default namespace

    Validation: Optional; array of group names

    ipRestrictions?: IpRestrictionProps[]

    IP CIDR restrictions for QuickSight console access. When specified, only requests from these IP ranges can access the QuickSight interface.

    Use cases: Corporate network restrictions; IP allowlisting; Compliance access control

    AWS: QuickSight IP restriction rules

    Validation: Optional; array of IpRestrictionProps with valid CIDR blocks

    lastName?: string

    Last name of the QuickSight account administrator.

    Use cases: Account personalization; AWS support communications

    AWS: QuickSight account admin contact

    Validation: Optional; string

    notificationEmail: string

    Email address for QuickSight account notifications including billing and service alerts.

    Use cases: Account alerts; Billing notifications; Service communications

    AWS: QuickSight account notification email

    Validation: Required; valid email format

    resourceAccessRolePermissions?: ResourceAccessRolePermissionsProps

    Permissions to attach to the account-level QuickSight resource-access role (aws-quicksight-service-role-v0) created by this module, so QuickSight data sources can reach the underlying AWS resources (Athena/S3/KMS). This module owns the role, so it attaches both the AWS-managed policies and the customer-managed S3/KMS policy here in one place. See ResourceAccessRolePermissionsProps.

    Use cases: Granting an Athena data source the AWS-managed Athena policy plus scoped access to its workgroup results bucket and the KMS-encrypted data lake it queries

    AWS: AWS-managed policies plus an IAM ManagedPolicy attached to the QuickSight resource-access role

    Validation: Optional; all sub-properties optional

    securityGroupAccess?: MdaaSecurityGroupRuleProps

    Security group rules controlling which VPC resources QuickSight can connect to. Defines ingress rules for the MDAA-created security group (e.g., Redshift on port 5439).

    Use cases: Redshift access; RDS connectivity; Data source network rules

    AWS: QuickSight security group ingress rules

    Validation: Optional; valid MdaaSecurityGroupRuleProps with sg/ipv4 rules

    subnetIds: string[]

    Subnets for the QuickSight VPC connection. QuickSight requires at least 2 subnets for multi-AZ availability.

    Use cases: Multi-AZ data source connectivity; High availability

    AWS: QuickSight VPC connection subnets

    Validation: Required; array of valid subnet IDs; minimum 2

    vpcId: string

    VPC to associate with the QuickSight account for secure data source connectivity. MDAA creates a security group and VPC connection for QuickSight to reach VPC-based resources like Redshift clusters.

    Use cases: Private data source access; Redshift connectivity; VPC network isolation

    AWS: QuickSight VPC connection

    Validation: Required; valid VPC ID (vpc-xxxxxxxx)

    Settings

    Member Visibility

    On This Page

    Properties