CrossAccountDestination L2 construct
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.
For cross-account scenarios, you need to manually create a CrossAccountDestination in the destination account. The integration classes in the aws-cdk-lib/aws-logs-destinations package (such as KinesisDestination) only handle same-account scenarios and do not automatically create CrossAccountDestination for cross-account usage.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';
declare const roleRef: interfaces_iam.IRoleRef;
const crossAccountDestination = new logs.CrossAccountDestination(this, 'MyCrossAccountDestination', {
role: roleRef,
targetArn: 'targetArn',
// the properties below are optional
destinationName: 'destinationName',
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_logs as logs
from aws_cdk.interfaces import aws_iam as interfaces_iam
# role_ref: interfaces_iam.IRoleRef
cross_account_destination = logs.CrossAccountDestination(self, "MyCrossAccountDestination",
role=role_ref,
target_arn="targetArn",
# the properties below are optional
destination_name="destinationName"
)
// 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.*;
import software.amazon.awscdk.interfaces.iam.*;
IRoleRef roleRef;
CrossAccountDestination crossAccountDestination = CrossAccountDestination.Builder.create(this, "MyCrossAccountDestination")
.role(roleRef)
.targetArn("targetArn")
// the properties below are optional
.destinationName("destinationName")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.Interfaces.IAM;
IRoleRef roleRef;
var crossAccountDestination = new CrossAccountDestination(this, "MyCrossAccountDestination", new CrossAccountDestinationProps {
Role = roleRef,
TargetArn = "targetArn",
// the properties below are optional
DestinationName = "destinationName"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var roleRef IRoleRef
crossAccountDestination := awscdk.Aws_logs.NewCrossAccountDestination(this, jsii.String("MyCrossAccountDestination"), &CrossAccountDestinationProps{
Role: roleRef,
TargetArn: jsii.String("targetArn"),
// the properties below are optional
DestinationName: jsii.String("destinationName"),
})
Initializer
new CrossAccountDestination(scope: Construct, id: string, props: CrossAccountDestinationProps)
CrossAccountDestination(scope: Construct, id: str, props: CrossAccountDestinationProps)
new CrossAccountDestination(Construct scope, String id, CrossAccountDestinationProps props)
new CrossAccountDestination(Construct scope, string id, CrossAccountDestinationProps props)
NewCrossAccountDestination(Scope Construct, Id *string, Props CrossAccountDestinationProps)
Construct Props
destinationNameoptionalstringdestination_nameoptionalstrdestinationNameoptionalStringDestinationNameoptionalstringDestinationNameoptional*string#Default: Automatically generated
The role must be assumable by 'logs.{REGION}.amazonaws.com'.
Properties
destinationArnstringdestination_arnstrdestinationArnStringDestinationArnstringDestinationArn*stringrequired#destinationNamestringdestination_namestrdestinationNameStringDestinationNamestringDestinationName*stringrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
policyDocumentPolicyDocumentpolicy_documentPolicyDocumentpolicyDocumentPolicyDocumentPolicyDocumentPolicyDocumentPolicyDocumentPolicyDocumentrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
addToPolicy(statement: PolicyStatement): voiddef add_to_policy(self, statement: PolicyStatement) -> Nonepublic void addToPolicy(PolicyStatement statement)public void AddToPolicy(PolicyStatement statement)func AddToPolicy(Statement PolicyStatement)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
bind(_scope: Construct, _sourceLogGroup: ILogGroupRef): LogSubscriptionDestinationConfigdef bind(self, _scope: Construct, _source_log_group: ILogGroupRef) -> LogSubscriptionDestinationConfigpublic LogSubscriptionDestinationConfig bind(Construct _scope, ILogGroupRef _sourceLogGroup)public LogSubscriptionDestinationConfig Bind(Construct _scope, ILogGroupRef _sourceLogGroup)func Bind(_scope Construct, _sourceLogGroup ILogGroupRef) LogSubscriptionDestinationConfig#notes
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.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.