Amazon (AWS) model

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand developing with Atlan. For that, we would suggest starting with either:

• Snippets — small, atomic examples of single-step use cases.
• Patterns — walkthroughs of common multi-step implementation patterns.

Base class for AWS assets.

classDiagram
    direction RL
    class AWS {
        <<abstract>>
    }
    link AWS "../aws"
    class Cloud {
        <<abstract>>
    }
    link Cloud "../entities/cloud"
    Cloud <|-- AWS : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Cloud : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Asset <|-- Catalog : extends
    class BI {
        <<abstract>>
    }
    link BI "bi"
    Catalog <|-- BI : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class ObjectStore {
        <<abstract>>
    }
    link ObjectStore "../entities/objectstore"
    Catalog <|-- ObjectStore : extends
    class S3 {
        <<abstract>>
    }
    link S3 "../s3"
    ObjectStore <|-- S3 : extends
    AWS <|-- S3 : extends
    class S3Bucket
    link S3Bucket "../entities/s3bucket"
    S3 <|-- S3Bucket : extends
    class S3Object
    link S3Object "../entities/s3object"
    S3 <|-- S3Object : extends
    class QuickSight {
        <<abstract>>
    }
    link QuickSight "../quicksight"
    BI <|-- QuickSight : extends
    class QuickSightFolder
    link QuickSightFolder "../entities/quicksightfolder"
    QuickSight <|-- QuickSightFolder : extends
    class QuickSightDashboardVisual
    link QuickSightDashboardVisual "../entities/quicksightdashboardvisual"
    QuickSight <|-- QuickSightDashboardVisual : extends
    class QuickSightAnalysisVisual
    link QuickSightAnalysisVisual "../entities/quicksightanalysisvisual"
    QuickSight <|-- QuickSightAnalysisVisual : extends
    class QuickSightDatasetField
    link QuickSightDatasetField "../entities/quicksightdatasetfield"
    QuickSight <|-- QuickSightDatasetField : extends
    class QuickSightAnalysis
    link QuickSightAnalysis "../entities/quicksightanalysis"
    QuickSight <|-- QuickSightAnalysis : extends
    class QuickSightDashboard
    link QuickSightDashboard "../entities/quicksightdashboard"
    QuickSight <|-- QuickSightDashboard : extends
    class QuickSightDataset
    link QuickSightDataset "../entities/quicksightdataset"
    QuickSight <|-- QuickSightDataset : extends

Properties

These attributes are specific to instances of AWS (and all of its subtypes).

awsAccountId

12-digit number that uniquely identifies an AWS account.

awsArn

Amazon Resource Name (ARN) for this asset. This uniquely identifies the asset in AWS, and thus must be unique across all AWS asset instances.

awsOwnerId

Root user's ID.

awsOwnerName

Root user's name.

awsPartition

Group of AWS region and service objects.

awsRegion

Physical region where the data center in which the asset exists is clustered.

awsResourceId

Unique resource ID assigned when a new resource is created.

awsService

Type of service in which the asset exists.

awsTags

List of tags that have been applied to the asset in AWS.

---