Package software.amazon.awscdk.services.logs

Class CfnDestination

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.logs.CfnDestination
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.072Z") @Stability(Stable) public class CfnDestination extends CfnResource implements IInspectable
A CloudFormation AWS::Logs::Destination.

The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.

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.*;
 CfnDestination cfnDestination = CfnDestination.Builder.create(this, "MyCfnDestination")
         .destinationName("destinationName")
         .roleArn("roleArn")
         .targetArn("targetArn")
         // the properties below are optional
         .destinationPolicy("destinationPolicy")
         .build();

  • 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

    • CfnDestination

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

    • CfnDestination

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

    • CfnDestination

      @Stability(Stable) public CfnDestination(@NotNull Construct scope, @NotNull String id, @NotNull CfnDestinationProps props)
      Create a new AWS::Logs::Destination.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 ARN of the CloudWatch Logs destination, such as arn:aws:logs:us-west-1:123456789012:destination:MyDestination .

    • getCfnProperties

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

    • getDestinationName

      @Stability(Stable) @NotNull public String getDestinationName()
      The name of the destination.

    • setDestinationName

      @Stability(Stable) public void setDestinationName(@NotNull String value)
      The name of the destination.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

    • getTargetArn

      @Stability(Stable) @NotNull public String getTargetArn()
      The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

    • setTargetArn

      @Stability(Stable) public void setTargetArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

    • getDestinationPolicy

      @Stability(Stable) @Nullable public String getDestinationPolicy()
      An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

    • setDestinationPolicy

      @Stability(Stable) public void setDestinationPolicy(@Nullable String value)
      An IAM policy document that governs which AWS accounts can create subscription filters against this destination.