AmazonopensearchserviceDestinationDescription ¶

class AmazonopensearchserviceDestinationDescription(TypedDict, closed=True):
    role_arn: NotRequired["capo_firehose.types.role_arn.RoleARN"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. </p>"""
    domain_arn: NotRequired[
        "capo_firehose.types.amazonopensearchservice_domain_arn.AmazonopensearchserviceDomainARN"
    ]
    """<p>The ARN of the Amazon OpenSearch Service domain.</p>"""
    cluster_endpoint: NotRequired[
        "capo_firehose.types.amazonopensearchservice_cluster_endpoint.AmazonopensearchserviceClusterEndpoint"
    ]
    """<p>The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service. </p>"""
    index_name: NotRequired[
        "capo_firehose.types.amazonopensearchservice_index_name.AmazonopensearchserviceIndexName"
    ]
    """<p>The Amazon OpenSearch Service index name.</p>"""
    type_name: NotRequired[
        "capo_firehose.types.amazonopensearchservice_type_name.AmazonopensearchserviceTypeName"
    ]
    """<p>The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName. </p>"""
    index_rotation_period: NotRequired[
        "capo_firehose.types.amazonopensearchservice_index_rotation_period.AmazonopensearchserviceIndexRotationPeriod"
    ]
    """<p>The Amazon OpenSearch Service index rotation period</p>"""
    buffering_hints: NotRequired[
        "capo_firehose.types.amazonopensearchservice_buffering_hints.AmazonopensearchserviceBufferingHints"
    ]
    """<p>The buffering options.</p>"""
    retry_options: NotRequired[
        "capo_firehose.types.amazonopensearchservice_retry_options.AmazonopensearchserviceRetryOptions"
    ]
    """<p>The Amazon OpenSearch Service retry options.</p>"""
    s3_backup_mode: NotRequired[
        "capo_firehose.types.amazonopensearchservice_s3_backup_mode.AmazonopensearchserviceS3BackupMode"
    ]
    """<p>The Amazon S3 backup mode.</p>"""
    s3_destination_description: NotRequired[
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    ]
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    vpc_configuration_description: NotRequired[
        "capo_firehose.types.vpc_configuration_description.VpcConfigurationDescription"
    ]
    document_id_options: NotRequired[
        "capo_firehose.types.document_id_options.DocumentIdOptions"
    ]
    """<p>Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.</p>"""