Class CfnDeliverySource
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.logs.CfnDeliverySource
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:04.254Z")
@Stability(Stable)
public class CfnDeliverySource
extends CfnResource
implements IInspectable, ITaggableV2
This structure contains information about one delivery source in your account.
A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from AWS services.
To configure logs delivery between a supported AWS service and a destination, you must do the following:
- Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource .
- Create a delivery destination , which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination .
- If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
- Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery .
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
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.logs.*; CfnDeliverySource cfnDeliverySource = CfnDeliverySource.Builder.create(this, "MyCfnDeliverySource") .name("name") // the properties below are optional .logType("logType") .resourceArn("resourceArn") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDeliverySource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDeliverySource
(software.amazon.jsii.JsiiObjectRef objRef) CfnDeliverySource
(software.constructs.Construct scope, String id, CfnDeliverySourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source.The AWS service that is sending logs.Tag Manager which manages the tags for this resource.The type of log that the source is sending.getName()
The unique name of the delivery source.The Amazon Resource Name (ARN) that uniquely identifies this delivery source.getTags()
The tags that have been assigned to this delivery source.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setLogType
(String value) The type of log that the source is sending.void
The unique name of the delivery source.void
setResourceArn
(String value) The Amazon Resource Name (ARN) that uniquely identifies this delivery source.void
The tags that have been assigned to this delivery source.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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
-
CfnDeliverySource
protected CfnDeliverySource(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDeliverySource
protected CfnDeliverySource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDeliverySource
@Stability(Stable) public CfnDeliverySource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeliverySourceProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) that uniquely identifies this delivery source. -
getAttrResourceArns
This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source.Currently, only one ARN can be in the array.
-
getAttrService
The AWS service that is sending logs. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The unique name of the delivery source. -
setName
The unique name of the delivery source. -
getLogType
The type of log that the source is sending. -
setLogType
The type of log that the source is sending. -
getResourceArn
The Amazon Resource Name (ARN) that uniquely identifies this delivery source. -
setResourceArn
The Amazon Resource Name (ARN) that uniquely identifies this delivery source. -
getTags
The tags that have been assigned to this delivery source. -
setTags
The tags that have been assigned to this delivery source.
-