Experimental
@aws-cdk/aws-pipes-sources-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
StreamSource Class
Streaming sources.
Initializer
ts
new StreamSource(sourceArn: string, sourceParameters: StreamSourceParameters)
python
StreamSource(source_arn: str, source_parameters: StreamSourceParameters)
java
new StreamSource(String sourceArn, StreamSourceParameters sourceParameters)
csharp
new StreamSource(string sourceArn, StreamSourceParameters sourceParameters)
go
NewStreamSource(SourceArn *string, SourceParameters StreamSourceParameters)
Properties
deadLetterTargetmay be undefinedIQueue | ITopicdead_letter_targetmay be undefinedtyping.Union[IQueue, ITopic]deadLetterTargetmay be undefinedIQueueDeadLetterTargetmay be undefinedIQueueDeadLetterTargetmay be undefinedinterface{}#The dead-letter SQS queue or SNS topic.
The ARN of the source resource.
sourceParametersStreamSourceParameterssource_parametersStreamSourceParameterssourceParametersStreamSourceParametersSourceParametersStreamSourceParametersSourceParametersStreamSourceParameters#Base parameters for streaming sources.
Methods
bind(pipe: IPipe): SourceConfigdef bind(self, pipe: IPipe) -> SourceConfigpublic SourceConfig bind(IPipe pipe)public SourceConfig Bind(IPipe pipe)func Bind(Pipe IPipe) SourceConfig#Bind the source to a pipe.
grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): voiddef grant_push(self, grantee: IRole, dead_letter_target: typing.Optional[typing.Union[IQueue, ITopic]] = None) -> Nonepublic void grantPush(IRole grantee, IQueue deadLetterTarget)public void GrantPush(IRole grantee, IQueue? deadLetterTarget = null)func GrantPush(Grantee IRole, DeadLetterTarget interface{})#Grants the pipe role permission to publish to the dead-letter target.
[disable-awslint:no-grants]
grantRead(grantee: IRole): voiddef grant_read(self, grantee: IRole) -> Nonepublic void grantRead(IRole grantee)public void GrantRead(IRole grantee)func GrantRead(Grantee IRole)#Grant the pipe role read access to the source.
isSourceWithDeadLetterTarget(source: ISource): boolean@staticmethod def is_source_with_dead_letter_target(source: ISource) -> boolpublic static Boolean isSourceWithDeadLetterTarget(ISource source)public static bool IsSourceWithDeadLetterTarget(ISource source)func IsSourceWithDeadLetterTarget(Source ISource) *boolstatic#Determines if the source is an instance of SourceWithDeadLetterTarget.