class StreamSource
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Pipes.Sources.Alpha.StreamSource |
 Go | github.com/aws/aws-cdk-go/awscdkpipessourcesalpha/v2#StreamSource |
 Java | software.amazon.awscdk.services.pipes.sources.alpha.StreamSource |
 Python | aws_cdk.aws_pipes_sources_alpha.StreamSource |
 TypeScript (source) | @aws-cdk/aws-pipes-sources-alpha » StreamSource |
Implements
ISource
Extends
Source
Implemented by
Dynamo, Kinesis
Streaming sources.
Initializer
new StreamSource(sourceArn: string, sourceParameters: StreamSourceParameters)
Parameters
- sourceArn
string— The ARN of the source resource. - sourceParameters
StreamSource Parameters
Properties
| Name | Type | Description |
|---|---|---|
| source | string | The ARN of the source resource. |
| source | Stream | Base parameters for streaming sources. |
| dead | IQueue | ITopic | The dead-letter SQS queue or SNS topic. |
sourceArn
Type:
string
The ARN of the source resource.
sourceParameters
Type:
Stream
Base parameters for streaming sources.
deadLetterTarget?
Type:
IQueue | ITopic
(optional)
The dead-letter SQS queue or SNS topic.
Methods
| Name | Description |
|---|---|
| bind(pipe) | Bind the source to a pipe. |
| grant | Grants the pipe role permission to publish to the dead-letter target. |
| grant | Grant the pipe role read access to the source. |
bind(pipe)
public bind(pipe: IPipe): SourceConfig
Parameters
- pipe
IPipe
Returns
Bind the source to a pipe.
grantPush(grantee, deadLetterTarget?)
public grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): void
Parameters
Grants the pipe role permission to publish to the dead-letter target.
grantRead(grantee)
public grantRead(grantee: IRole): void
Parameters
- grantee
IRole
Grant the pipe role read access to the source.