Skip to content

DDBELTConnectionOptions

Source code in docs_src/capo_glue/types/ddbelt_connection_options.py
class DDBELTConnectionOptions(TypedDict, closed=True):
    dynamodb_export: NotRequired["capo_glue.types.ddb_export_type.DdbExportType"]
    """<p>Specifies the export type for DynamoDB data extraction. This parameter determines how data is exported from the DynamoDB table during the ELT process.</p>"""
    dynamodb_unnest_ddb_json: "capo_glue.types.boolean_value.BooleanValue"
    """<p>A boolean value that specifies whether to unnest DynamoDB JSON format during data extraction. When set to <code>true</code>, the connector will flatten nested JSON structures from DynamoDB items. When set to <code>false</code>, the original DynamoDB JSON structure is preserved.</p>"""
    dynamodb_table_arn: (
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    )
    """<p>The Amazon Resource Name (ARN) of the DynamoDB table to extract data from. This parameter specifies the source table for the ELT operation. </p>"""
    dynamodb_s3_bucket: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The name of the Amazon S3 bucket used for intermediate storage during the DynamoDB ELT process. This bucket is used to temporarily store exported DynamoDB data before it is processed by the ELT job.</p>"""
    dynamodb_s3_prefix: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The S3 object key prefix for files stored in the intermediate S3 bucket during the DynamoDB ELT process. This prefix helps organize and identify the temporary files created during data extraction.</p>"""
    dynamodb_s3_bucket_owner: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The Amazon Web Services account ID of the owner of the S3 bucket specified in <code>DynamodbS3Bucket</code>. This parameter is required when the S3 bucket is owned by a different Amazon Web Services account than the one running the ELT job, enabling cross-account access to the intermediate storage bucket.</p>"""
    dynamodb_sts_role_arn: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services Security Token Service (STS) role to assume for accessing DynamoDB and S3 resources during the ELT operation. This role must have the necessary permissions to read from the DynamoDB table and write to the intermediate S3 bucket. </p>"""

dynamodb_export instance-attribute

dynamodb_export: NotRequired[DdbExportType]

Specifies the export type for DynamoDB data extraction. This parameter determines how data is exported from the DynamoDB table during the ELT process.

dynamodb_s3_bucket instance-attribute

dynamodb_s3_bucket: NotRequired[EnclosedInStringProperty]

The name of the Amazon S3 bucket used for intermediate storage during the DynamoDB ELT process. This bucket is used to temporarily store exported DynamoDB data before it is processed by the ELT job.

dynamodb_s3_bucket_owner instance-attribute

dynamodb_s3_bucket_owner: NotRequired[EnclosedInStringProperty]

The Amazon Web Services account ID of the owner of the S3 bucket specified in DynamodbS3Bucket. This parameter is required when the S3 bucket is owned by a different Amazon Web Services account than the one running the ELT job, enabling cross-account access to the intermediate storage bucket.

dynamodb_s3_prefix instance-attribute

dynamodb_s3_prefix: NotRequired[EnclosedInStringProperty]

The S3 object key prefix for files stored in the intermediate S3 bucket during the DynamoDB ELT process. This prefix helps organize and identify the temporary files created during data extraction.

dynamodb_sts_role_arn instance-attribute

dynamodb_sts_role_arn: NotRequired[EnclosedInStringProperty]

The Amazon Resource Name (ARN) of the Amazon Web Services Security Token Service (STS) role to assume for accessing DynamoDB and S3 resources during the ELT operation. This role must have the necessary permissions to read from the DynamoDB table and write to the intermediate S3 bucket.

dynamodb_table_arn instance-attribute

dynamodb_table_arn: EnclosedInStringProperty

The Amazon Resource Name (ARN) of the DynamoDB table to extract data from. This parameter specifies the source table for the ELT operation.

dynamodb_unnest_ddb_json instance-attribute

dynamodb_unnest_ddb_json: BooleanValue

A boolean value that specifies whether to unnest DynamoDB JSON format during data extraction. When set to true, the connector will flatten nested JSON structures from DynamoDB items. When set to false, the original DynamoDB JSON structure is preserved.