[ aws . logs ]

create-delivery

Description

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

Synopsis

  create-delivery
--delivery-source-name <value>
--delivery-destination-arn <value>
[--record-fields <value>]
[--field-delimiter <value>]
[--s3-delivery-configuration <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--delivery-source-name (string)

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

--delivery-destination-arn (string)

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

--record-fields (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)

Syntax:

"string" "string" ...

--field-delimiter (string)

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

--s3-delivery-configuration (structure)

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.

Shorthand Syntax:

suffixPath=string,enableHiveCompatiblePath=boolean

JSON Syntax:

{
  "suffixPath": "string",
  "enableHiveCompatiblePath": true|false
}

--tags (map)

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

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

delivery -> (structure)

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 -> (structure)

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 -> (map)

The tags that have been assigned to this delivery.

key -> (string)

value -> (string)