CrossAccountDestination

class aws_cdk.aws_logs.CrossAccountDestination(scope, id, *, role, target_arn, destination_name=None)

Bases: Resource

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-lib/aws-logs-destinations package; if necessary, a CrossAccountDestination will be created automatically.

Resource:: AWS::Logs::Destination
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iam as iam
from aws_cdk import aws_logs as logs

# role: iam.Role

cross_account_destination = logs.CrossAccountDestination(self, "MyCrossAccountDestination",
    role=role,
    target_arn="targetArn",

    # the properties below are optional
    destination_name="destinationName"
)

Parameters:

scope (Construct) –
id (str) –
role (IRole) – The role to assume that grants permissions to write to ‘target’. The role must be assumable by ‘logs.{REGION}.amazonaws.com’.
target_arn (str) – The log destination target’s ARN.
destination_name (Optional[str]) – The name of the log destination. Default: Automatically generated

Methods

add_to_policy(statement)

Parameters:

statement (PolicyStatement) –

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

bind(_scope, _source_log_group)

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.

Parameters:

_scope (Construct) –
_source_log_group (ILogGroup) –

Return type:

LogSubscriptionDestinationConfig

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

destination_arn

The ARN of this CrossAccountDestination object.

Attribute:: true

destination_name

The name of this CrossAccountDestination object.

Attribute:: true

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

policy_document: Policy object of this CrossAccountDestination object.

stack: The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool