MDAA TS Docs
    Preparing search index...

    Class InventoryHelper

    Helper class for creating S3 Inventories and associated Glue/Athena resources for querying these inventories.

    Index

    Constructors

    constructor

    Methods

    createGlueInvTable createInvConfig createInventoryBucketPolicyStatement

    Constructors

    Methods

    • Helper method for creating a Glue table which can be used to query inventory data generated by an S3 Inventory config

      Parameters

      • scope: Construct

        The CDK scope in which the table will be created

      • catalogId: string

        The Glue catalog ID

      • tableNamePrefix: string

        Will be used to prefix the table name.

      • database: Database

        The Glue database in which the table will be created

      • locationBucketName: string

        The bucket where the inventory data is stored.

      • bucketInventories: BucketInventory[]

        The set of bucket inventories for which the table will be created.

      • OptionallocationPrefix: string

        The S3 Prefix on the location bucket where the inventory is stored.

      Returns CfnTable

      A Glue table which can be used to query S3 inventory data in an S3 bucket.

    • Helper method for creating an S3 inventory.

      Parameters

      • destinationBucket: IBucket

        The bucket where S3 inventory data will be written

      • inventoryId: string

        The S3 inventory ID

      • OptionalobjectsPrefix: string

        The object prefix from which inventory will be produced (on the bucket to which the inventory config is applied)

      • OptionaldestinationPrefix: string

        The object prefix under which inventory will be written on the destination bucket.

      • OptionaldestinationAccount: string

        The account which owns the destination bucket.

      Returns Inventory

      An S3 Inventory Config which can be applied to a bucket in order to produce periodic inventory data.

    • Helper method to generate an S3 Bucket Policy Statement allowing S3 service to write inventories to a bucket.

      Parameters

      • bucketArn: string

        The bucket arn where inventory will be stored

      • srcAccount: string

        The account which owns the source bucket from which inventory is being produced.

      • OptionalsourceBucketArn: string

        The bucket arn for which inventory data is being produced

      • OptionalinventoryPrefix: string

        The prefix on the destination bucket where inventory data will be stored.

      Returns PolicyStatement

      A policy statement which permits the S3 service principal to write inventory for the source bucket/account to the destination bucket.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods