interface PipeSourceRabbitMQBrokerParametersProperty

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty
Java	software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty
Python	aws_cdk.aws_pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty
TypeScript	@aws-cdk/aws-pipes » CfnPipe » PipeSourceRabbitMQBrokerParametersProperty

The parameters for using a Rabbit MQ broker as a source.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes from '@aws-cdk/aws-pipes';
const pipeSourceRabbitMQBrokerParametersProperty: pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty = {
  credentials: {
    basicAuth: 'basicAuth',
  },
  queueName: 'queueName',

  // the properties below are optional
  batchSize: 123,
  maximumBatchingWindowInSeconds: 123,
  virtualHost: 'virtualHost',
};

Properties

Name	Type	Description
credentials	IResolvable | MQBrokerAccessCredentialsProperty	The credentials needed to access the resource.
queueName	string	The name of the destination queue to consume.
batchSize?	number	The maximum number of records to include in each batch.
maximumBatchingWindowInSeconds?	number	The maximum length of a time to wait for events.
virtualHost?	string	The name of the virtual host associated with the source broker.

---

credentials

Type: IResolvable | MQBrokerAccessCredentialsProperty

The credentials needed to access the resource.

---

queueName

Type: string

The name of the destination queue to consume.

---

batchSize?

Type: number (optional)

The maximum number of records to include in each batch.

---

maximumBatchingWindowInSeconds?

Type: number (optional)

The maximum length of a time to wait for events.

---

virtualHost?

Type: string (optional)

The name of the virtual host associated with the source broker.