CloudWatchLogs / Client / create_delivery

create_delivery#

CloudWatchLogs.Client.create_delivery(**kwargs)#

Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.

Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

  • Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

  • Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

  • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

See also: AWS API Documentation

Request Syntax

response = client.create_delivery(
    deliverySourceName='string',
    deliveryDestinationArn='string',
    recordFields=[
        'string',
    ],
    fieldDelimiter='string',
    s3DeliveryConfiguration={
        'suffixPath': 'string',
        'enableHiveCompatiblePath': True|False
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • deliverySourceName (string) –

    [REQUIRED]

    The name of the delivery source to use for this delivery.

  • deliveryDestinationArn (string) –

    [REQUIRED]

    The ARN of the delivery destination to use for this delivery.

  • recordFields (list) –

    The list of record fields to be delivered to the destination, in order. If the delivery’s log source has mandatory fields, they must be included in this list.

    • (string) –

  • fieldDelimiter (string) – The field delimiter to use between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

  • s3DeliveryConfiguration (dict) –

    This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

    • suffixPath (string) –

      This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

    • enableHiveCompatiblePath (boolean) –

      This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

  • tags (dict) –

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

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'delivery': {
        'id': 'string',
        'arn': 'string',
        'deliverySourceName': 'string',
        'deliveryDestinationArn': 'string',
        'deliveryDestinationType': 'S3'|'CWL'|'FH',
        'recordFields': [
            'string',
        ],
        'fieldDelimiter': 'string',
        's3DeliveryConfiguration': {
            'suffixPath': 'string',
            'enableHiveCompatiblePath': True|False
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • delivery (dict) –

      A structure that contains information about the delivery that you just created.

      • id (string) –

        The unique ID that identifies this delivery in your account.

      • arn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies this delivery.

      • deliverySourceName (string) –

        The name of the delivery source that is associated with this delivery.

      • deliveryDestinationArn (string) –

        The ARN of the delivery destination that is associated with this delivery.

      • deliveryDestinationType (string) –

        Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.

      • recordFields (list) –

        The record fields used in this delivery.

        • (string) –

      • fieldDelimiter (string) –

        The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

      • s3DeliveryConfiguration (dict) –

        This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

        • suffixPath (string) –

          This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

        • enableHiveCompatiblePath (boolean) –

          This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      • tags (dict) –

        The tags that have been assigned to this delivery.

        • (string) –

          • (string) –

Exceptions