Package software.amazon.awscdk.services.logs

Interface CfnDeliveryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:10.762Z")
@Stability(Stable)
public interface CfnDeliveryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDelivery.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnDeliveryProps cfnDeliveryProps = CfnDeliveryProps.builder()
         .deliveryDestinationArn("deliveryDestinationArn")
         .deliverySourceName("deliverySourceName")
         // the properties below are optional
         .fieldDelimiter("fieldDelimiter")
         .recordFields(List.of("recordFields"))
         .s3EnableHiveCompatiblePath(false)
         .s3SuffixPath("s3SuffixPath")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryProps.Builder	A builder for CfnDeliveryProps
static final class	CfnDeliveryProps.Jsii$Proxy	An implementation for CfnDeliveryProps

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryProps.Builder	builder()
String	getDeliveryDestinationArn()	The ARN of the delivery destination that is associated with this delivery.
String	getDeliverySourceName()	The name of the delivery source that is associated with this delivery.
default String	getFieldDelimiter()	The field delimiter that is used between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.
default List<String>	getRecordFields()	The record fields used in this delivery.
default Object	getS3EnableHiveCompatiblePath()	This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
default String	getS3SuffixPath()	This string allows re-configuring the S3 object prefix to contain either static or variable sections.
default List<CfnTag>	getTags()	The tags that have been assigned to this delivery.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeliveryDestinationArn

@Stability(Stable)
@NotNull
String getDeliveryDestinationArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverydestinationarn

getDeliverySourceName

@Stability(Stable)
@NotNull
String getDeliverySourceName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-deliverysourcename

getFieldDelimiter

@Stability(Stable)
@Nullable
default String getFieldDelimiter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-fielddelimiter

getRecordFields

@Stability(Stable)
@Nullable
default List<String> getRecordFields()

The record fields used in this delivery.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-recordfields

getS3EnableHiveCompatiblePath

@Stability(Stable)
@Nullable
default Object getS3EnableHiveCompatiblePath()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3enablehivecompatiblepath

getS3SuffixPath

@Stability(Stable)
@Nullable
default String getS3SuffixPath()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-s3suffixpath

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags that have been assigned to this delivery.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-delivery.html#cfn-logs-delivery-tags

builder

@Stability(Stable)
static CfnDeliveryProps.Builder builder()

Returns:

a CfnDeliveryProps.Builder of CfnDeliveryProps