S3 model¶
Base class for S3 assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage S3 assets in Atlan. For that, we would suggest starting with the manage AWS S3 assets pattern.
classDiagram
direction RL
class S3 {
<<abstract>>
}
link S3 "../s3"
class ObjectStore {
<<abstract>>
}
link ObjectStore "../entities/objectstore"
ObjectStore <|-- S3 : extends
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- ObjectStore : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class AWS {
<<abstract>>
}
link AWS "../aws"
AWS <|-- S3 : extends
class Cloud {
<<abstract>>
}
link Cloud "../entities/cloud"
Cloud <|-- AWS : extends
Asset <|-- Cloud : extends
class S3Bucket
link S3Bucket "../entities/s3bucket"
S3 <|-- S3Bucket : extends
class S3Object
link S3Object "../entities/s3object"
S3 <|-- S3Object : extends
Type-specific properties¶
Following are the properties uniquely available on S3
assets in Atlan.
s3ETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata. | |
---|---|
1 2 3 4 |
|
-
Set the
s3ETag
for aS3
. -
Retrieve the
s3ETag
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
s3ETag
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
s3ETag
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
s3Encryption
TBC | |
---|---|
1 2 3 |
|
-
Set the
s3Encryption
for aS3
. -
Retrieve the
s3Encryption
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
s3Encryption
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_account_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_account_id
for aS3
. -
Retrieve the
aws_account_id
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_account_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_arn
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
aws_arn
for aS3
. -
Retrieve the
aws_arn
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_arn
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
aws_arn
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
aws_owner_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_owner_id
for aS3
. -
Retrieve the
aws_owner_id
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_owner_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_owner_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
aws_owner_name
for aS3
. -
Retrieve the
aws_owner_name
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_owner_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
aws_owner_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
aws_partition
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_partition
for aS3
. -
Retrieve the
aws_partition
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_partition
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_region
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_region
for aS3
. -
Retrieve the
aws_region
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_region
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_resource_id
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_resource_id
for aS3
. -
Retrieve the
aws_resource_id
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_resource_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_service
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_service
for aS3
. -
Retrieve the
aws_service
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_service
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
aws_tags
TBC | |
---|---|
1 2 3 |
|
-
Set the
aws_tags
for aS3
. -
Retrieve the
aws_tags
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
aws_tags
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
s3_e_tag
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
s3_e_tag
for aS3
. -
Retrieve the
s3_e_tag
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
s3_e_tag
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
s3_e_tag
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
s3_encryption
TBC | |
---|---|
1 2 3 |
|
-
Set the
s3_encryption
for aS3
. -
Retrieve the
s3_encryption
from aS3
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
s3_encryption
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
s3ETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata. | |
---|---|
1 2 3 4 5 |
|
-
Set the
s3ETag
for aS3
.For more details
For more information, see the asset CRUD snippets.
s3Encryption
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
s3Encryption
for aS3
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various S3 objects inter-relate with each other:
erDiagram
Connection ||..o{ S3Bucket : ""
S3Bucket ||--o{ S3Object : objects