Class: AWSCDK::Pipes::CfnPipe::PipeSourceRabbitMQBrokerParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::PipeSourceRabbitMQBrokerParametersProperty

Defined in:

pipes/cfn_pipe.rb

Overview

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html

Instance Attribute Summary

• #batch_size ⇒ Numeric^? readonly

  The maximum number of records to include in each batch.

• #credentials ⇒ AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::MQBrokerAccessCredentialsProperty readonly

  The credentials needed to access the resource.

• #maximum_batching_window_in_seconds ⇒ Numeric^? readonly

  The maximum length of a time to wait for events.

• #queue_name ⇒ String readonly

  The name of the destination queue to consume.

• #virtual_host ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(credentials:, queue_name:, batch_size: nil, maximum_batching_window_in_seconds: nil, virtual_host: nil) ⇒ PipeSourceRabbitMQBrokerParametersProperty constructor

  A new instance of PipeSourceRabbitMQBrokerParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(credentials:, queue_name:, batch_size: nil, maximum_batching_window_in_seconds: nil, virtual_host: nil) ⇒ PipeSourceRabbitMQBrokerParametersProperty

Returns a new instance of PipeSourceRabbitMQBrokerParametersProperty.

Parameters:

• credentials (AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::MQBrokerAccessCredentialsProperty) —

  The credentials needed to access the resource.

• queue_name (String) —

  The name of the destination queue to consume.

• batch_size (Numeric, nil) (defaults to: nil) —

  The maximum number of records to include in each batch.

• maximum_batching_window_in_seconds (Numeric, nil) (defaults to: nil) —

  The maximum length of a time to wait for events.

• virtual_host (String, nil) (defaults to: nil) —

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

# File 'pipes/cfn_pipe.rb', line 2737

def initialize(credentials:, queue_name:, batch_size: nil, maximum_batching_window_in_seconds: nil, virtual_host: nil)
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::MQBrokerAccessCredentialsProperty.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLk1RQnJva2VyQWNjZXNzQ3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "credentials")
  @queue_name = queue_name
  Jsii::Type.check_type(@queue_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queueName")
  @batch_size = batch_size
  Jsii::Type.check_type(@batch_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "batchSize") unless @batch_size.nil?
  @maximum_batching_window_in_seconds = maximum_batching_window_in_seconds
  Jsii::Type.check_type(@maximum_batching_window_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumBatchingWindowInSeconds") unless @maximum_batching_window_in_seconds.nil?
  @virtual_host = virtual_host
  Jsii::Type.check_type(@virtual_host, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualHost") unless @virtual_host.nil?
end

Instance Attribute Details

#batch_size ⇒ Numeric^? (readonly)

The maximum number of records to include in each batch.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize

# File 'pipes/cfn_pipe.rb', line 2764

def batch_size
  @batch_size
end

#credentials ⇒ AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::MQBrokerAccessCredentialsProperty (readonly)

The credentials needed to access the resource.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::MQBrokerAccessCredentialsProperty)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials

# File 'pipes/cfn_pipe.rb', line 2754

def credentials
  @credentials
end

#maximum_batching_window_in_seconds ⇒ Numeric^? (readonly)

The maximum length of a time to wait for events.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds

# File 'pipes/cfn_pipe.rb', line 2769

def maximum_batching_window_in_seconds
  @maximum_batching_window_in_seconds
end

#queue_name ⇒ String (readonly)

The name of the destination queue to consume.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename

# File 'pipes/cfn_pipe.rb', line 2759

def queue_name
  @queue_name
end

#virtual_host ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost

# File 'pipes/cfn_pipe.rb', line 2774

def virtual_host
  @virtual_host
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 2776

def self.jsii_properties
  {
    :credentials => "credentials",
    :queue_name => "queueName",
    :batch_size => "batchSize",
    :maximum_batching_window_in_seconds => "maximumBatchingWindowInSeconds",
    :virtual_host => "virtualHost",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 2786

def to_jsii
  result = {}
  result.merge!({
    "credentials" => @credentials,
    "queueName" => @queue_name,
    "batchSize" => @batch_size,
    "maximumBatchingWindowInSeconds" => @maximum_batching_window_in_seconds,
    "virtualHost" => @virtual_host,
  })
  result.compact
end