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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:46.626Z")
@Stability(Stable)
public class CfnSink
extends CfnResource
implements IInspectable, 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:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnSink
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSink
(software.amazon.jsii.JsiiObjectRef objRef) CfnSink
(software.constructs.Construct scope, String id, CfnSinkProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the sink.getName()
A name for the sink.The IAM policy that grants permissions to source accounts to link to this sink.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to the sink.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
A name for the sink.void
The IAM policy that grants permissions to source accounts to link to this sink.void
setTagsRaw
(Map<String, String> value) An array of key-value pairs to apply to the sink.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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) - 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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the sink.For example,
arn:aws:oam:us-west-1:111111111111:sink:abcd1234-a123-456a-a12b-a123b456c789
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
A name for the sink. -
setName
A name for the sink. -
getPolicy
The IAM policy that grants permissions to source accounts to link to this sink. -
setPolicy
The IAM policy that grants permissions to source accounts to link to this sink. -
getTagsRaw
An array of key-value pairs to apply to the sink. -
setTagsRaw
An array of key-value pairs to apply to the sink.
-