Represents an OSML (Object Storage with Access Logging) Bucket construct.

Hierarchy

  • Construct
    • OSMLBucket

Constructors

  • Creates an OSML Bucket and optionally an Access Logging Bucket.

    Parameters

    • scope: Construct

      The scope/stack in which to define this construct.

    • id: string

      The id of this construct within the current scope.

    • props: OSMLBucketProps

      The properties of this construct.

    Returns OSMLBucket

    OSMLBucket - The OSMLBucket construct.

Properties

accessLogsBucket?: IBucket

An optional access logging bucket for storing access logs.

bucket: Bucket

The core bucket for storing objects.

node: Node

The tree node.

Methods

  • Returns a string representation of this construct.

    Returns string

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Generated using TypeDoc