MDAA TS Docs
    Preparing search index...

    S3-compatible object storage location configuration for DataSync transfers from third-party cloud storage (e.g. Google Cloud Storage, Azure Blob). Credentials (accessKey/secretKey) must be pre-stored in a Secrets Manager secret in the format: {"accessKey":"<access_key>","secretKey":"<secret_key>"}. If secretName is omitted, MDAA creates an empty secret to populate after deployment.

    Use cases: Google Cloud Storage to S3 migration; Third-party object storage synchronization; Multi-cloud data transfer

    AWS: DataSync LocationObjectStorage resource (CfnLocationObjectStorage)

    Validation: bucketName, serverHostname, and secretName required; one of agentNames or agentArns required (mutually exclusive)

    interface LocationObjectStorageProps {
        agentArns?: string[];
        agentNames?: string[];
        bucketName: string;
        secretName: string;
        serverHostname: string;
        serverPort?: number;
        serverProtocol?: string;
        subdirectory?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agentArns?: string[]

    ARNs of DataSync agents for object storage connectivity. Use when agents are registered outside MDAA. Mutually exclusive with agentNames.

    Use cases: Externally managed agent references; Pre-existing agent reuse

    AWS: DataSync agent ARNs for object storage location configuration

    Validation: Optional; mutually exclusive with agentNames; must be valid DataSync agent ARNs

    agentNames?: string[]

    Names of MDAA-generated DataSync agents from the agents config section. Resolved to agent ARNs automatically. Mutually exclusive with agentArns.

    Use cases: Referencing MDAA-managed agents by name; Simplified agent configuration

    AWS: Resolved to DataSync agent ARNs for object storage location

    Validation: Optional; mutually exclusive with agentArns; must reference valid generated agent names

    bucketName: string

    Name of the object storage bucket (e.g. GCS bucket name).

    Use cases: Third-party cloud storage bucket identification

    AWS: Object storage bucket name for DataSync LocationObjectStorage

    Validation: Required; must be valid object storage bucket name

    secretName: string

    Secrets Manager secret name storing object storage credentials. Secret must contain "accessKey" and "secretKey" fields. If omitted, MDAA creates an empty secret to populate after deployment.

    Use cases: Object storage authentication; Secure credential management for third-party storage

    AWS: Secrets Manager secret for object storage authentication

    Validation: Required; secret must contain accessKey and secretKey fields

    serverHostname: string

    Domain name or IP address of the object storage server endpoint. The DataSync agent uses this to connect to the storage service.

    Use cases: Third-party storage endpoint connectivity; Custom object storage servers

    AWS: Object storage server hostname for DataSync agent connectivity

    Validation: Required; must be valid domain name or IP address

    serverPort?: number

    Port number for the object storage server (e.g. 443 for HTTPS, 80 for HTTP).

    Use cases: Custom port configuration; Non-standard object storage endpoints

    AWS: Object storage server port for DataSync connectivity

    Validation: Optional; must be valid port number

    443
    
    serverProtocol?: string

    Protocol for object storage server communication (e.g. HTTPS, HTTP).

    Use cases: Protocol selection for object storage endpoints; Secure vs. non-secure transfers

    AWS: Object storage server protocol for DataSync communication

    Validation: Optional; typically HTTPS or HTTP

    HTTPS
    
    subdirectory?: string

    Object prefix (subdirectory) within the bucket for scoped data access. Must use forward slashes (e.g. /some/prefix).

    Use cases: Scoped transfers to a specific object prefix; Organized data placement

    AWS: Object storage prefix for DataSync location

    Validation: Optional; must use forward slash format if specified