Class CfnSink

Creates or updates a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnSink
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Oam
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSink : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSink
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html

CloudformationResource: AWS::Oam::Sink

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Oam;

var policy;

var cfnSink = new CfnSink(this, "MyCfnSink", new CfnSinkProps {
    Name = "name",

    // the properties below are optional
    Policy = policy,
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
});

Synopsis

Constructors

CfnSink(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnSink(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnSink(Construct, String, ICfnSinkProps)

Properties

AttrArn

The ARN of the sink.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Name

A name for the sink.
Policy

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

Tag Manager which manages the tags for this resource.
TagsRaw

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnSink(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnSink(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnSink(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnSink(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnSink(Construct, String, ICfnSinkProps)

public CfnSink(Construct scope, string id, ICfnSinkProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnSinkProps

Resource properties.

Properties

AttrArn

The ARN of the sink.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

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

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Name

A name for the sink.

public virtual string Name { get; set; }
Property Value

System.String

Policy

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

public virtual object Policy { get; set; }
Property Value

System.Object

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

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

public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements