@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.999Z") public class CfnDestination extends CfnResource implements IInspectable
The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
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.*; CfnDestination cfnDestination = CfnDestination.Builder.create(this, "MyCfnDestination") .destinationName("destinationName") .roleArn("roleArn") .targetArn("targetArn") // the properties below are optional .destinationPolicy("destinationPolicy") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDestination.Builder
A fluent builder for
CfnDestination . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDestination(Construct scope,
java.lang.String id,
CfnDestinationProps props)
Create a new `AWS::Logs::Destination`.
|
protected |
CfnDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDestination(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-west-1:123456789012:destination:MyDestination` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDestinationName()
The name of the destination.
|
java.lang.String |
getDestinationPolicy()
An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
|
java.lang.String |
getRoleArn()
The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.
|
java.lang.String |
getTargetArn()
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDestinationName(java.lang.String value)
The name of the destination.
|
void |
setDestinationPolicy(java.lang.String value)
An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
|
void |
setRoleArn(java.lang.String value)
The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.
|
void |
setTargetArn(java.lang.String value)
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDestination(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDestination(Construct scope, java.lang.String id, CfnDestinationProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDestinationName()
public void setDestinationName(java.lang.String value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.String getTargetArn()
public void setTargetArn(java.lang.String value)
public java.lang.String getDestinationPolicy()
public void setDestinationPolicy(java.lang.String value)