Package software.amazon.awscdk.services.logs

Class CfnDeliveryDestination

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.CfnDeliveryDestination
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:10.761Z") @Stability(Stable) public class CfnDeliveryDestination extends CfnResource implements IInspectable, ITaggableV2
This structure contains information about one delivery destination in your account.

A delivery destination is an AWS resource that represents an AWS service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.

To configure logs delivery between a supported AWS 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.
  • 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.
  • Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery .

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.

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.*;
 Object deliveryDestinationPolicy;
 CfnDeliveryDestination cfnDeliveryDestination = CfnDeliveryDestination.Builder.create(this, "MyCfnDeliveryDestination")
         .name("name")
         // the properties below are optional
         .deliveryDestinationPolicy(deliveryDestinationPolicy)
         .destinationResourceArn("destinationResourceArn")
         .outputFormat("outputFormat")
         .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

    • CfnDeliveryDestination

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

    • CfnDeliveryDestination

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

    • CfnDeliveryDestination

      @Stability(Stable) public CfnDeliveryDestination(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeliveryDestinationProps props)
      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

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

    • getAttrDeliveryDestinationType

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

    • 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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of this delivery destination.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of this delivery destination.

    • getDeliveryDestinationPolicy

      @Stability(Stable) @Nullable public Object getDeliveryDestinationPolicy()
      A structure that contains information about one delivery destination policy.

    • setDeliveryDestinationPolicy

      @Stability(Stable) public void setDeliveryDestinationPolicy(@Nullable Object value)
      A structure that contains information about one delivery destination policy.

    • getDestinationResourceArn

      @Stability(Stable) @Nullable public String getDestinationResourceArn()
      The ARN of the AWS destination that this delivery destination represents.

    • setDestinationResourceArn

      @Stability(Stable) public void setDestinationResourceArn(@Nullable String value)
      The ARN of the AWS destination that this delivery destination represents.

    • getOutputFormat

      @Stability(Stable) @Nullable public String getOutputFormat()
      The format of the logs that are sent to this delivery destination.

    • setOutputFormat

      @Stability(Stable) public void setOutputFormat(@Nullable String value)
      The format of the logs that are sent to this delivery destination.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags that have been assigned to this delivery destination.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags that have been assigned to this delivery destination.