Package software.amazon.awscdk.services.oam

Class CfnSink

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.oam.CfnSink
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISinkRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:25.137Z") @Stability(Stable) public class CfnSink extends CfnResource implements IInspectable, ISinkRef, ITaggable
Creates or updates a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability.

A sink is a resource that represents an attachment point in a monitoring account, which source accounts can link to to be able to send observability data.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy .

An account can have one sink.

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.oam.*;
 Object policy;
 CfnSink cfnSink = CfnSink.Builder.create(this, "MyCfnSink")
         .name("name")
         // the properties below are optional
         .policy(policy)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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

    • CfnSink

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

    • CfnSink

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

    • CfnSink

      @Stability(Stable) public CfnSink(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSinkProps props)
      Create a new AWS::Oam::Sink.

      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

    • arnForSink

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

    • isCfnSink

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

      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 ARN of the sink.

      For example, arn:aws:oam:us-west-1:111111111111:sink:abcd1234-a123-456a-a12b-a123b456c789

    • getCfnProperties

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

    • getSinkRef

      @Stability(Stable) @NotNull public SinkReference getSinkRef()
      A reference to a Sink resource.
      Specified by:
      getSinkRef in interface ISinkRef

    • getTags

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name for the sink.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name for the sink.

    • getPolicy

      @Stability(Stable) @Nullable public Object getPolicy()
      The IAM policy that grants permissions to source accounts to link to this sink.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable Object value)
      The IAM policy that grants permissions to source accounts to link to this sink.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      An array of key-value pairs to apply to the sink.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      An array of key-value pairs to apply to the sink.