Skip to content

UpdateDestinationInput

Source code in docs_src/capo_firehose/types/update_destination_input.py
class UpdateDestinationInput(TypedDict, closed=True):
    delivery_stream_name: "capo_firehose.types.delivery_stream_name.DeliveryStreamName"
    """<p>The name of the Firehose stream.</p>"""
    current_delivery_stream_version_id: (
        "capo_firehose.types.delivery_stream_version_id.DeliveryStreamVersionId"
    )
    """<p>Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"""
    destination_id: "capo_firehose.types.destination_id.DestinationId"
    """<p>The ID of the destination.</p>"""
    s3_destination_update: NotRequired[
        "capo_firehose.types.s3_destination_update.S3DestinationUpdate"
    ]
    """<p>[Deprecated] Describes an update for a destination in Amazon S3.</p>"""
    extended_s3_destination_update: NotRequired[
        "capo_firehose.types.extended_s3_destination_update.ExtendedS3DestinationUpdate"
    ]
    """<p>Describes an update for a destination in Amazon S3.</p>"""
    redshift_destination_update: NotRequired[
        "capo_firehose.types.redshift_destination_update.RedshiftDestinationUpdate"
    ]
    """<p>Describes an update for a destination in Amazon Redshift.</p>"""
    elasticsearch_destination_update: NotRequired[
        "capo_firehose.types.elasticsearch_destination_update.ElasticsearchDestinationUpdate"
    ]
    """<p>Describes an update for a destination in Amazon OpenSearch Service.</p>"""
    amazonopensearchservice_destination_update: NotRequired[
        "capo_firehose.types.amazonopensearchservice_destination_update.AmazonopensearchserviceDestinationUpdate"
    ]
    """<p>Describes an update for a destination in Amazon OpenSearch Service.</p>"""
    splunk_destination_update: NotRequired[
        "capo_firehose.types.splunk_destination_update.SplunkDestinationUpdate"
    ]
    """<p>Describes an update for a destination in Splunk.</p>"""
    http_endpoint_destination_update: NotRequired[
        "capo_firehose.types.http_endpoint_destination_update.HttpEndpointDestinationUpdate"
    ]
    """<p>Describes an update to the specified HTTP endpoint destination.</p>"""
    amazon_open_search_serverless_destination_update: NotRequired[
        "capo_firehose.types.amazon_open_search_serverless_destination_update.AmazonOpenSearchServerlessDestinationUpdate"
    ]
    """<p>Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.</p>"""
    snowflake_destination_update: NotRequired[
        "capo_firehose.types.snowflake_destination_update.SnowflakeDestinationUpdate"
    ]
    """<p>Update to the Snowflake destination configuration settings.</p>"""
    iceberg_destination_update: NotRequired[
        "capo_firehose.types.iceberg_destination_update.IcebergDestinationUpdate"
    ]
    """<p> Describes an update for a destination in Apache Iceberg Tables. </p>"""

amazon_open_search_serverless_destination_update instance-attribute

amazon_open_search_serverless_destination_update: NotRequired[
    AmazonOpenSearchServerlessDestinationUpdate
]

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

amazonopensearchservice_destination_update instance-attribute

amazonopensearchservice_destination_update: NotRequired[
    AmazonopensearchserviceDestinationUpdate
]

Describes an update for a destination in Amazon OpenSearch Service.

current_delivery_stream_version_id instance-attribute

current_delivery_stream_version_id: DeliveryStreamVersionId

Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

delivery_stream_name instance-attribute

delivery_stream_name: DeliveryStreamName

The name of the Firehose stream.

destination_id instance-attribute

destination_id: DestinationId

The ID of the destination.

elasticsearch_destination_update instance-attribute

elasticsearch_destination_update: NotRequired[ElasticsearchDestinationUpdate]

Describes an update for a destination in Amazon OpenSearch Service.

extended_s3_destination_update instance-attribute

extended_s3_destination_update: NotRequired[ExtendedS3DestinationUpdate]

Describes an update for a destination in Amazon S3.

http_endpoint_destination_update instance-attribute

http_endpoint_destination_update: NotRequired[HttpEndpointDestinationUpdate]

Describes an update to the specified HTTP endpoint destination.

iceberg_destination_update instance-attribute

iceberg_destination_update: NotRequired[IcebergDestinationUpdate]

Describes an update for a destination in Apache Iceberg Tables.

redshift_destination_update instance-attribute

redshift_destination_update: NotRequired[RedshiftDestinationUpdate]

Describes an update for a destination in Amazon Redshift.

s3_destination_update instance-attribute

s3_destination_update: NotRequired[S3DestinationUpdate]

[Deprecated] Describes an update for a destination in Amazon S3.

snowflake_destination_update instance-attribute

snowflake_destination_update: NotRequired[SnowflakeDestinationUpdate]

Update to the Snowflake destination configuration settings.

splunk_destination_update instance-attribute

splunk_destination_update: NotRequired[SplunkDestinationUpdate]

Describes an update for a destination in Splunk.