Skip to content
v2.273.0

PipeSourceRabbitMQBrokerParametersProperty Struct ​

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

Example ​

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

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

Properties ​

batchSizenumberbatch_sizeint | floatbatchSizeNumberBatchSizedoubleBatchSize*float64#
The maximum number of records to include in each batch.
credentialsIResolvable | CfnPipe.MQBrokerAccessCredentialsPropertycredentialstyping.Union[IResolvable, MQBrokerAccessCredentialsProperty]credentialsIResolvableCredentialsIResolvableCredentialsinterface{}required#
The credentials needed to access the resource.
maximumBatchingWindowInSecondsnumbermaximum_batching_window_in_secondsint | floatmaximumBatchingWindowInSecondsNumberMaximumBatchingWindowInSecondsdoubleMaximumBatchingWindowInSeconds*float64#
The maximum length of a time to wait for events.
queueNamestringqueue_namestrqueueNameStringQueueNamestringQueueName*stringrequired#
The name of the destination queue to consume.
virtualHoststringvirtual_hoststrvirtualHostStringVirtualHoststringVirtualHost*string#
The name of the virtual host associated with the source broker.