Package software.amazon.awscdk.services.guardduty

Class CfnPublishingDestination

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.guardduty.CfnPublishingDestination
All Implemented Interfaces:
IInspectable, IPublishingDestinationRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:07.083Z") @Stability(Stable) public class CfnPublishingDestination extends CfnResource implements IInspectable, IPublishingDestinationRef, ITaggableV2
Creates a publishing destination where you can export your GuardDuty findings.

Before you start exporting the findings, the destination resource must exist.

For more information about considerations and permissions, see Exporting GuardDuty findings to Amazon S3 buckets in the Amazon GuardDuty User Guide .

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.guardduty.*;
 CfnPublishingDestination cfnPublishingDestination = CfnPublishingDestination.Builder.create(this, "MyCfnPublishingDestination")
         .destinationProperties(CFNDestinationPropertiesProperty.builder()
                 .destinationArn("destinationArn")
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .destinationType("destinationType")
         .detectorId("detectorId")
         // the properties below are optional
         .tags(List.of(TagItemProperty.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

    • CfnPublishingDestination

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

    • CfnPublishingDestination

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

    • CfnPublishingDestination

      @Stability(Stable) public CfnPublishingDestination(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPublishingDestinationProps props)
      Create a new AWS::GuardDuty::PublishingDestination.

      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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the publishing destination.

    • getAttrPublishingFailureStartTimestamp

      @Stability(Stable) @NotNull public String getAttrPublishingFailureStartTimestamp()
      The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the publishing destination.

    • 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

    • getPublishingDestinationRef

      @Stability(Stable) @NotNull public PublishingDestinationReference getPublishingDestinationRef()
      A reference to a PublishingDestination resource.
      Specified by:
      getPublishingDestinationRef in interface IPublishingDestinationRef

    • getDestinationProperties

      @Stability(Stable) @NotNull public Object getDestinationProperties()
      Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.

      Returns union: either IResolvable or CfnPublishingDestination.CFNDestinationPropertiesProperty

    • setDestinationProperties

      @Stability(Stable) public void setDestinationProperties(@NotNull IResolvable value)
      Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.

    • setDestinationProperties

      @Stability(Stable) public void setDestinationProperties(@NotNull CfnPublishingDestination.CFNDestinationPropertiesProperty value)
      Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.

    • getDestinationType

      @Stability(Stable) @NotNull public String getDestinationType()
      The type of publishing destination.

    • setDestinationType

      @Stability(Stable) public void setDestinationType(@NotNull String value)
      The type of publishing destination.

    • getDetectorId

      @Stability(Stable) @NotNull public String getDetectorId()
      The ID of the GuardDuty detector where the publishing destination exists.

    • setDetectorId

      @Stability(Stable) public void setDetectorId(@NotNull String value)
      The ID of the GuardDuty detector where the publishing destination exists.

    • getTags

      @Stability(Stable) @Nullable public List<CfnPublishingDestination.TagItemProperty> getTags()
      Describes a tag.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnPublishingDestination.TagItemProperty> value)
      Describes a tag.