S3LogsDeliveryProps

class aws_cdk.mixins_preview.aws_logs.S3LogsDeliveryProps(*, mandatory_fields=None, provided_fields=None, output_format=None, kms_key=None, permissions_version=None)

Bases: DeliveryProps

(experimental) Props for S3LogsDelivery.

Parameters:

  • mandatory_fields (Optional[Sequence[str]]) – (experimental) Any recordFields that a mandatory to be included in a log delivery of a certain log type. Default: - log type has no mandatory fields

  • provided_fields (Optional[Sequence[str]]) – (experimental) RecordFields the user has defined to be used in log delivery.

  • output_format (Optional[str]) – (experimental) Format of the logs that are sent to the delivery destination specified.

  • kms_key (Optional[IKeyRef]) – (experimental) KMS key to use for encrypting logs in the S3 bucket. When provided, grants the logs delivery service permissions to use the key. Default: - No encryption key is configured

  • permissions_version (Optional[S3LogsDeliveryPermissionsVersion]) – (experimental) The permissions version (‘V1’ or ‘V2’) to be used for this delivery. Depending on the source of the logs, different permissions are required. Default: “V2”

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import aws_logs as logs
from aws_cdk.interfaces import aws_kms as interfaces_kms

# key_ref: interfaces_kms.IKeyRef

s3_logs_delivery_props = logs.S3LogsDeliveryProps(
    kms_key=key_ref,
    mandatory_fields=["mandatoryFields"],
    output_format="outputFormat",
    permissions_version=logs.S3LogsDeliveryPermissionsVersion.V1,
    provided_fields=["providedFields"]
)

Attributes

kms_key

(experimental) KMS key to use for encrypting logs in the S3 bucket.

When provided, grants the logs delivery service permissions to use the key.

Default:

  • No encryption key is configured

Stability:

experimental

mandatory_fields

(experimental) Any recordFields that a mandatory to be included in a log delivery of a certain log type.

Default:

  • log type has no mandatory fields

Stability:

experimental

output_format

(experimental) Format of the logs that are sent to the delivery destination specified.

Stability:

experimental

Defualt:

  • undefined, use whatever default the delivery destination specifies

permissions_version

(experimental) The permissions version (‘V1’ or ‘V2’) to be used for this delivery.

Depending on the source of the logs, different permissions are required.

Default:

“V2”

Stability:

experimental

provided_fields

(experimental) RecordFields the user has defined to be used in log delivery.

Stability:

experimental

Defualt:

  • no fields were provided