S3Location
Defined in: src/types/media.ts:102
S3 location for media and document sources.
Implements
Section titled “Implements”S3LocationDataJSONSerializable<S3LocationData>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new S3Location(data): S3Location;Defined in: src/types/media.ts:107
Parameters
Section titled “Parameters”| Parameter | Type |
| --------- | --------------------------------------------------------------------------------- |
| data | Omit<S3LocationData, "type"> & { type?: "s3"; } |
Returns
Section titled “Returns”S3Location
Properties
Section titled “Properties”readonly type: "s3";Defined in: src/types/media.ts:103
Location type — always “s3”.
Implementation of
Section titled “Implementation of”readonly uri: string;Defined in: src/types/media.ts:104
S3 URI in format: s3://bucket-name/key-name
Implementation of
Section titled “Implementation of”bucketOwner?
Section titled “bucketOwner?”readonly optional bucketOwner?: string;Defined in: src/types/media.ts:105
AWS account ID of the S3 bucket owner (12-digit). Required if the bucket belongs to another AWS account.
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): S3LocationData;Defined in: src/types/media.ts:118
Serializes the S3Location to a JSON-compatible S3LocationData object. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”JSONSerializable.toJSONfromJSON()
Section titled “fromJSON()”static fromJSON(data): S3Location;Defined in: src/types/media.ts:132
Creates an S3Location instance from S3LocationData.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
| --------- | -------------------------------------- | ----------------------------- |
| data | S3LocationData | S3LocationData to deserialize |
Returns
Section titled “Returns”S3Location
S3Location instance