Class CfnChannel
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::CloudTrail::Channel
.
Contains information about a returned CloudTrail channel.
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.cloudtrail.*; CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel") .destinations(List.of(DestinationProperty.builder() .location("location") .type("type") .build())) .name("name") .source("source") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnChannel
.static interface
Contains information about the destination receiving events.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnChannel
(Construct scope, String id) Create a newAWS::CloudTrail::Channel
.CfnChannel
(Construct scope, String id, CfnChannelProps props) Create a newAWS::CloudTrail::Channel
.protected
CfnChannel
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnChannel
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionRef
returns the ARN of the CloudTrail channel, such asarn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
.One or more event data stores to which events arriving through a channel will be logged.getName()
The name of the channel.The name of the partner or external event source.getTags()
A list of tags.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDestinations
(List<Object> value) One or more event data stores to which events arriving through a channel will be logged.void
setDestinations
(IResolvable value) One or more event data stores to which events arriving through a channel will be logged.void
The name of the channel.void
The name of the partner or external event source.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 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
-
CfnChannel
protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef) -
CfnChannel
protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnChannel
@Stability(Stable) public CfnChannel(@NotNull Construct scope, @NotNull String id, @Nullable CfnChannelProps props) Create a newAWS::CloudTrail::Channel
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnChannel
Create a newAWS::CloudTrail::Channel
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrChannelArn
Ref
returns the ARN of the CloudTrail channel, such asarn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
A list of tags. -
getDestinations
One or more event data stores to which events arriving through a channel will be logged. -
setDestinations
One or more event data stores to which events arriving through a channel will be logged. -
setDestinations
One or more event data stores to which events arriving through a channel will be logged. -
getName
The name of the channel. -
setName
The name of the channel. -
getSource
The name of the partner or external event source.You cannot change this name after you create the channel. A maximum of one channel is allowed per source.
A source can be either
Custom
for all valid non- AWS events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide. -
setSource
The name of the partner or external event source.You cannot change this name after you create the channel. A maximum of one channel is allowed per source.
A source can be either
Custom
for all valid non- AWS events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.
-