Class CfnSink
A CloudFormation AWS::Oam::Sink
.
Inherited Members
Namespace: Amazon.CDK.AWS.Oam
Assembly: Amazon.CDK.AWS.Oam.dll
Syntax (csharp)
public class CfnSink : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSink
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Oam::Sink
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html
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(Construct, String, ICfnSinkProps) | Create a new |
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 |
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 | 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(Construct, String, ICfnSinkProps)
Create a new AWS::Oam::Sink
.
public CfnSink(Construct scope, string id, ICfnSinkProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSinkProps
- resource properties.
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
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
Remarks
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
Remarks
The policy can grant permission in the following ways:
Tags
An array of key-value pairs to apply to the sink.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>