S3LogsDelivery

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

Bases: object

(experimental) Delivers vended logs to an S3 Bucket.

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
from aws_cdk.interfaces import aws_s3 as interfaces_s3

# bucket_ref: interfaces_s3.IBucketRef
# key_ref: interfaces_kms.IKeyRef

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

(experimental) Creates a new S3 Bucket delivery.

Parameters:

  • bucket (IBucketRef)

  • 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”

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

  • 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.

Stability:

experimental

Methods

bind(scope, log_type, source_resource_arn)

(experimental) Binds S3 Bucket to a source resource for the purposes of log delivery and creates a delivery source, a delivery destination, and a connection between them.

Parameters:

  • scope (IConstruct)

  • log_type (str)

  • source_resource_arn (str)

Stability:

experimental

Return type:

ILogsDeliveryConfig