software.amazon.awscdk.services.oam

Class CfnSink

java.lang.Object

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.oam.CfnSink

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.979Z")
public class CfnSink
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Oam::Sink`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSink.Builder A fluent builder for CfnSink.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSink(Construct scope, java.lang.String id, CfnSinkProps props) Create a new `AWS::Oam::Sink`.
protected	CfnSink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSink(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The ARN of the sink.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() A name for the sink.
java.lang.Object	getPolicy() The IAM policy that grants permissions to source accounts to link to this sink.
TagManager	getTags() An array of key-value pairs to apply to the sink.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) A name for the sink.
void	setPolicy(java.lang.Object value) The IAM policy that grants permissions to source accounts to link to this sink.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSink

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

CfnSink

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

CfnSink

public CfnSink(Construct scope,
               java.lang.String id,
               CfnSinkProps props)

Create a new `AWS::Oam::Sink`.

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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the sink.

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to the sink.

For more information, see Tag .

getName

public java.lang.String getName()

A name for the sink.

setName

public void setName(java.lang.String value)

A name for the sink.

getPolicy

public java.lang.Object getPolicy()

The IAM policy that grants permissions to source accounts to link to this sink.

The policy can grant permission in the following ways:

• Include organization IDs or organization paths to permit all accounts in an organization
• Include account IDs to permit the specified accounts

setPolicy

public void setPolicy(java.lang.Object value)

The IAM policy that grants permissions to source accounts to link to this sink.

The policy can grant permission in the following ways:

• Include organization IDs or organization paths to permit all accounts in an organization
• Include account IDs to permit the specified accounts