Package software.amazon.awscdk.services.logs

Class CfnDelivery

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.logs.CfnDelivery
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDeliveryRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:39.818Z") @Stability(Stable) public class CfnDelivery extends CfnResource implements IInspectable, IDeliveryRef, ITaggableV2
This structure contains information about one delivery in your account.

A delivery is a connection between a logical delivery source and a logical delivery destination .

For more information, see CreateDelivery .

To update an existing delivery configuration, use UpdateDeliveryConfiguration .

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.*;
 CfnDelivery cfnDelivery = CfnDelivery.Builder.create(this, "MyCfnDelivery")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDelivery

      protected CfnDelivery(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDelivery

      protected CfnDelivery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDelivery

      @Stability(Stable) public CfnDelivery(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeliveryProps props)
      Create a new AWS::Logs::Delivery.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDelivery

      @Stability(Stable) @NotNull public static String arnForDelivery(@NotNull IDeliveryRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDelivery

      @Stability(Stable) @NotNull public static Boolean isCfnDelivery(@NotNull Object x)
      Checks whether the given object is a CfnDelivery.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) that uniquely identifies this delivery.

    • getAttrDeliveryDestinationType

      @Stability(Stable) @NotNull public String getAttrDeliveryDestinationType()
      Displays whether the delivery destination associated with this delivery is CloudWatch Logs , Amazon S3 , or Firehose .

    • getAttrDeliveryId

      @Stability(Stable) @NotNull public String getAttrDeliveryId()
      The unique ID that identifies this delivery in your account.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeliveryRef

      @Stability(Stable) @NotNull public DeliveryReference getDeliveryRef()
      A reference to a Delivery resource.
      Specified by:
      getDeliveryRef in interface IDeliveryRef

    • getDeliveryDestinationArn

      @Stability(Stable) @NotNull public String getDeliveryDestinationArn()
      The ARN of the delivery destination that is associated with this delivery.

    • setDeliveryDestinationArn

      @Stability(Stable) public void setDeliveryDestinationArn(@NotNull String value)
      The ARN of the delivery destination that is associated with this delivery.

    • getDeliverySourceName

      @Stability(Stable) @NotNull public String getDeliverySourceName()
      The name of the delivery source that is associated with this delivery.

    • setDeliverySourceName

      @Stability(Stable) public void setDeliverySourceName(@NotNull String value)
      The name of the delivery source that is associated with this delivery.

    • getFieldDelimiter

      @Stability(Stable) @Nullable public 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.

    • setFieldDelimiter

      @Stability(Stable) public void setFieldDelimiter(@Nullable String value)
      The field delimiter that is used between record fields when the final output format of a delivery is in Plain , W3C , or Raw format.

    • getRecordFields

      @Stability(Stable) @Nullable public List<String> getRecordFields()
      The list of record fields to be delivered to the destination, in order.

    • setRecordFields

      @Stability(Stable) public void setRecordFields(@Nullable List<String> value)
      The list of record fields to be delivered to the destination, in order.

    • getS3EnableHiveCompatiblePath

      @Stability(Stable) @Nullable public Object getS3EnableHiveCompatiblePath()
      Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      Returns union: either Boolean or IResolvable

    • setS3EnableHiveCompatiblePath

      @Stability(Stable) public void setS3EnableHiveCompatiblePath(@Nullable Boolean value)
      Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

    • setS3EnableHiveCompatiblePath

      @Stability(Stable) public void setS3EnableHiveCompatiblePath(@Nullable IResolvable value)
      Use this parameter to cause the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

    • getS3SuffixPath

      @Stability(Stable) @Nullable public String getS3SuffixPath()
      Use this to reconfigure the S3 object prefix to contain either static or variable sections.

    • setS3SuffixPath

      @Stability(Stable) public void setS3SuffixPath(@Nullable String value)
      Use this to reconfigure the S3 object prefix to contain either static or variable sections.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to the delivery.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to the delivery.