AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-pipes-targets-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CloudWatchLogsTarget Class ​

An EventBridge Pipes target that sends messages to a CloudWatch Logs log group.

Stability
Experimental
Source
lib/cloudwatch-logs.ts

Example ​

ts
declare const sourceQueue: sqs.Queue;
declare const targetLogGroup: logs.LogGroup;

const logGroupTarget = new targets.CloudWatchLogsTarget(targetLogGroup);

const pipe = new pipes.Pipe(this, 'Pipe', {
    source: new SqsSource(sourceQueue),
    target: logGroupTarget,
});
python
# source_queue: sqs.Queue
# target_log_group: logs.LogGroup


log_group_target = targets.CloudWatchLogsTarget(target_log_group)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=log_group_target
)
java
Queue sourceQueue;
LogGroup targetLogGroup;


CloudWatchLogsTarget logGroupTarget = new CloudWatchLogsTarget(targetLogGroup);

Pipe pipe = Pipe.Builder.create(this, "Pipe")
        .source(new SqsSource(sourceQueue))
        .target(logGroupTarget)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Targets.Alpha
Queue sourceQueue;
LogGroup targetLogGroup;


var logGroupTarget = new CloudWatchLogsTarget(targetLogGroup);

var pipe = new Pipe(this, "Pipe", new PipeProps {
    Source = new SqsSource(sourceQueue),
    Target = logGroupTarget
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkpipestargetsalpha/v2
var sourceQueue Queue
var targetLogGroup LogGroup


logGroupTarget := targets.NewCloudWatchLogsTarget(targetLogGroup)

pipe := pipes.NewPipe(this, jsii.String("Pipe"), &PipeProps{
	Source: awscdkpipessourcesalpha.NewSqsSource(sourceQueue),
	Target: logGroupTarget,
})

Initializer ​

ts
new CloudWatchLogsTarget(logGroup: ILogGroup, parameters?: CloudWatchLogsTargetParameters)
python
CloudWatchLogsTarget(log_group: ILogGroup, parameters: typing.Optional[CloudWatchLogsTargetParameters] = None)
java
new CloudWatchLogsTarget(ILogGroup logGroup, CloudWatchLogsTargetParameters parameters)
csharp
new CloudWatchLogsTarget(ILogGroup logGroup, CloudWatchLogsTargetParameters? parameters = null)
go
NewCloudWatchLogsTarget(LogGroup ILogGroup, Parameters CloudWatchLogsTargetParameters)

Properties ​

targetArnstringtarget_arnstrtargetArnStringTargetArnstringTargetArn*stringrequired#
The ARN of the target resource.

Methods ​

bind(pipe: IPipe): TargetConfigdef bind(self, pipe: IPipe) -> TargetConfigpublic TargetConfig bind(IPipe pipe)public TargetConfig Bind(IPipe pipe)func Bind(Pipe IPipe) TargetConfig#
Bind this target to a pipe.
grantPush(grantee: IRole): voiddef grant_push(self, grantee: IRole) -> Nonepublic void grantPush(IRole grantee)public void GrantPush(IRole grantee)func GrantPush(Grantee IRole)#
Grant the pipe role to push to the target.