software.amazon.awscdk.services.logs

Class CrossAccountDestination

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.logs.CrossAccountDestination

All Implemented Interfaces:

IConstruct, IDependable, IResource, ILogSubscriptionDestination

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:27.601Z")
public class CrossAccountDestination
extends Resource
implements ILogSubscriptionDestination

A new CloudWatch Logs Destination for use in cross-account scenarios.

CrossAccountDestinations are used to subscribe a Kinesis stream in a different account to a CloudWatch Subscription.

Consumers will hardly ever need to use this class. Instead, directly subscribe a Kinesis stream using the integration class in the @aws-cdk/aws-logs-destinations package; if necessary, a CrossAccountDestination will be created automatically.

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.iam.*;
 import software.amazon.awscdk.services.logs.*;
 Role role;
 CrossAccountDestination crossAccountDestination = CrossAccountDestination.Builder.create(this, "MyCrossAccountDestination")
         .role(role)
         .targetArn("targetArn")
         // the properties below are optional
         .destinationName("destinationName")
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.logs.ILogSubscriptionDestination

ILogSubscriptionDestination.Jsii$Default, ILogSubscriptionDestination.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CrossAccountDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CrossAccountDestination(software.amazon.jsii.JsiiObjectRef objRef)
	CrossAccountDestination(software.constructs.Construct scope, java.lang.String id, CrossAccountDestinationProps props)

Method Summary

Modifier and Type	Method and Description
void	addToPolicy(PolicyStatement statement)
LogSubscriptionDestinationConfig	bind(Construct _scope, ILogGroup _sourceLogGroup) Return the properties required to send subscription events to this destination.
java.lang.String	getDestinationArn() The ARN of this CrossAccountDestination object.
java.lang.String	getDestinationName() The name of this CrossAccountDestination object.
PolicyDocument	getPolicyDocument() Policy object of this CrossAccountDestination object.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

CrossAccountDestination

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

CrossAccountDestination

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

CrossAccountDestination

public CrossAccountDestination(software.constructs.Construct scope,
                               java.lang.String id,
                               CrossAccountDestinationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addToPolicy

public void addToPolicy(PolicyStatement statement)

Parameters:

statement - This parameter is required.

bind

public LogSubscriptionDestinationConfig bind(Construct _scope,
                                             ILogGroup _sourceLogGroup)

Return the properties required to send subscription events to this destination.

If necessary, the destination can use the properties of the SubscriptionFilter object itself to configure its permissions to allow the subscription to write to it.

The destination may reconfigure its own permissions in response to this function call.

Specified by:

bind in interface ILogSubscriptionDestination

Parameters:

_scope - This parameter is required.

_sourceLogGroup - This parameter is required.

getDestinationArn

public java.lang.String getDestinationArn()

The ARN of this CrossAccountDestination object.

getDestinationName

public java.lang.String getDestinationName()

The name of this CrossAccountDestination object.

getPolicyDocument

public PolicyDocument getPolicyDocument()

Policy object of this CrossAccountDestination object.