Package software.amazon.awscdk.services.oam

Interface CfnSinkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSinkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:29.745Z")
@Stability(Stable)
public interface CfnSinkProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSink.

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;
 CfnSinkProps cfnSinkProps = CfnSinkProps.builder()
         .name("name")
         // the properties below are optional
         .policy(policy)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSinkProps.Builder	A builder for CfnSinkProps
static final class	CfnSinkProps.Jsii$Proxy	An implementation for CfnSinkProps

Method Summary

Modifier and Type	Method	Description
static CfnSinkProps.Builder	builder()
String	getName()	A name for the sink.
default Object	getPolicy()	The IAM policy that grants permissions to source accounts to link to this sink.
default Map<String,String>	getTags()	An array of key-value pairs to apply to the sink.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A name for the sink.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-name

getPolicy

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-policy

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-sink.html#cfn-oam-sink-tags

builder

@Stability(Stable)
static CfnSinkProps.Builder builder()

Returns:

a CfnSinkProps.Builder of CfnSinkProps