software.amazon.awscdk.services.logs

Class CfnDestination

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.CfnDestination

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.695Z")
 @Stability(value=Stable)
public class CfnDestination
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Logs::Destination`.

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")
         .destinationPolicy("destinationPolicy")
         .roleArn("roleArn")
         .targetArn("targetArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDestination.Builder A fluent builder for CfnDestination.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDestination(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-west-1:123456789012:destination:MyDestination` .
protected Map<String,Object>	getCfnProperties()
String	getDestinationName() The name of the destination.
String	getDestinationPolicy() An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
String	getRoleArn() The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestinationName(String value) The name of the destination.
void	setDestinationPolicy(String value) An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
void	setRoleArn(String value) The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.
void	setTargetArn(String value) The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDestination

protected CfnDestination(software.amazon.jsii.JsiiObjectRef objRef)

CfnDestination

protected CfnDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDestination

@Stability(value=Stable)
public CfnDestination(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnDestinationProps props)

Create a new `AWS::Logs::Destination`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-west-1:123456789012:destination:MyDestination` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDestinationName

@Stability(value=Stable)
 @NotNull
public String getDestinationName()

The name of the destination.

setDestinationName

@Stability(value=Stable)
public void setDestinationName(@NotNull
                                                        String value)

The name of the destination.

getDestinationPolicy

@Stability(value=Stable)
 @NotNull
public String getDestinationPolicy()

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

setDestinationPolicy

@Stability(value=Stable)
public void setDestinationPolicy(@NotNull
                                                          String value)

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

getTargetArn

@Stability(value=Stable)
 @NotNull
public String getTargetArn()

The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

setTargetArn

@Stability(value=Stable)
public void setTargetArn(@NotNull
                                                  String value)

The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).