Class: Aws::MQ::Types::CreateBrokerInput

Inherits:

Struct

• Object
• Struct
• Aws::MQ::Types::CreateBrokerInput

Includes:

Structure

Defined in:

lib/aws-sdk-mq/types.rb

Overview

Required. The time period during which Amazon MQ applies pending updates or patches to the broker.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #auto_minor_version_upgrade ⇒ Boolean

  Required.

• #broker_name ⇒ String

  Required.

• #configuration ⇒ Types::ConfigurationId

  A list of information about the configuration.

• #creator_request_id ⇒ String

  The unique ID that the requester receives for the created broker.

• #deployment_mode ⇒ String

  Required.

• #engine_type ⇒ String

  Required.

• #engine_version ⇒ String

  Required.

• #host_instance_type ⇒ String

  Required.

• #logs ⇒ Types::Logs

  Enables Amazon CloudWatch logging for brokers.

• #maintenance_window_start_time ⇒ Types::WeeklyStartTime

  The parameters that determine the WeeklyStartTime.

• #publicly_accessible ⇒ Boolean

  Required.

• #security_groups ⇒ Array<String>

  The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

• #subnet_ids ⇒ Array<String>

  The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones.

• #tags ⇒ Hash<String,String>

  Create tags when creating the broker.

• #users ⇒ Array<Types::User>

  Required.

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

Returns:

• (Boolean)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_name ⇒ String

Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#configuration ⇒ Types::ConfigurationId

A list of information about the configuration.

Returns:

• (Types::ConfigurationId)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#creator_request_id ⇒ String

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn’t require idempotency.**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#deployment_mode ⇒ String

Required. The deployment mode of the broker.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#engine_type ⇒ String

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#engine_version ⇒ String

Required. The version of the broker engine. For a list of supported engine versions, see docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#host_instance_type ⇒ String

Required. The broker’s instance type.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#logs ⇒ Types::Logs

Enables Amazon CloudWatch logging for brokers.

Returns:

• (Types::Logs)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

The parameters that determine the WeeklyStartTime.

Returns:

• (Types::WeeklyStartTime)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Required. Enables connections from applications outside of the VPC that hosts the broker’s subnets.

Returns:

• (Boolean)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#security_groups ⇒ Array<String>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Create tags when creating the broker.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#users ⇒ Array<Types::User>

Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Returns:

• (Array<Types::User>)

# File 'lib/aws-sdk-mq/types.rb', line 297

class CreateBrokerInput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end