Skip to content

PutDeliveryDestinationRequest

Source code in docs_src/capo_cloudwatch_logs/types/put_delivery_destination_request.py
class PutDeliveryDestinationRequest(TypedDict, closed=True):
    name: "capo_cloudwatch_logs.types.delivery_destination_name.DeliveryDestinationName"
    """<p>A name for this delivery destination. This name must be unique for all delivery destinations in your account.</p>"""
    output_format: NotRequired["capo_cloudwatch_logs.types.output_format.OutputFormat"]
    """<p>The format for the logs that this delivery destination will receive.</p>"""
    delivery_destination_configuration: NotRequired[
        "capo_cloudwatch_logs.types.delivery_destination_configuration.DeliveryDestinationConfiguration"
    ]
    """<p>A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.</p> <note> <p> <code>deliveryDestinationConfiguration</code> is required for CloudWatch Logs, Amazon S3, Firehose log delivery destinations and not required for X-Ray trace delivery destinations. <code>deliveryDestinationType</code> is needed for X-Ray trace delivery destinations but not required for other logs delivery destinations.</p> </note>"""
    delivery_destination_type: NotRequired[
        "capo_cloudwatch_logs.types.delivery_destination_type.DeliveryDestinationType"
    ]
    """<p>The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:</p> <ul> <li> <p> <code>S3</code> - Amazon S3 for long-term storage and analytics</p> </li> <li> <p> <code>CWL</code> - CloudWatch Logs for centralized log management</p> </li> <li> <p> <code>FH</code> - Amazon Kinesis Data Firehose for real-time data streaming</p> </li> <li> <p> <code>XRAY</code> - Amazon Web Services X-Ray for distributed tracing and application monitoring</p> </li> </ul> <p>The delivery destination type determines the format and configuration options available for log delivery.</p>"""
    role_arn: NotRequired["capo_cloudwatch_logs.types.arn.Arn"]
    """<p>The ARN of an IAM role in your account that CloudWatch Logs assumes to deliver to this delivery destination. The trust policy of the role must allow CloudWatch Logs to assume it. This parameter is supported only for X-Ray trace delivery destinations.</p>"""
    tags: NotRequired["capo_cloudwatch_logs.types.tags.Tags"]
    """<p>An optional list of key-value pairs to associate with the resource.</p> <p>For more information about tagging, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> </p>"""

delivery_destination_configuration instance-attribute

delivery_destination_configuration: NotRequired[DeliveryDestinationConfiguration]

A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

deliveryDestinationConfiguration is required for CloudWatch Logs, Amazon S3, Firehose log delivery destinations and not required for X-Ray trace delivery destinations. deliveryDestinationType is needed for X-Ray trace delivery destinations but not required for other logs delivery destinations.

delivery_destination_type instance-attribute

delivery_destination_type: NotRequired[DeliveryDestinationType]

The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

  • S3 - Amazon S3 for long-term storage and analytics

  • CWL - CloudWatch Logs for centralized log management

  • FH - Amazon Kinesis Data Firehose for real-time data streaming

  • XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

The delivery destination type determines the format and configuration options available for log delivery.

name instance-attribute

A name for this delivery destination. This name must be unique for all delivery destinations in your account.

output_format instance-attribute

output_format: NotRequired[OutputFormat]

The format for the logs that this delivery destination will receive.

role_arn instance-attribute

role_arn: NotRequired[Arn]

The ARN of an IAM role in your account that CloudWatch Logs assumes to deliver to this delivery destination. The trust policy of the role must allow CloudWatch Logs to assume it. This parameter is supported only for X-Ray trace delivery destinations.

tags instance-attribute

tags: NotRequired[Tags]

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources