You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MQ::Types::CreateBrokerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb

Overview

Note:

When making an API call, you may pass CreateBrokerRequest data as a hash:

{
  auto_minor_version_upgrade: false,
  broker_name: "__string",
  configuration: {
    id: "__string",
    revision: 1,
  },
  creator_request_id: "__string",
  deployment_mode: "SINGLE_INSTANCE", # accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
  encryption_options: {
    kms_key_id: "__string",
    use_aws_owned_key: false, # required
  },
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
  engine_version: "__string",
  host_instance_type: "__string",
  logs: {
    audit: false,
    general: false,
  },
  maintenance_window_start_time: {
    day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    time_of_day: "__string",
    time_zone: "__string",
  },
  publicly_accessible: false,
  security_groups: ["__string"],
  subnet_ids: ["__string"],
  tags: {
    "__string" => "__string",
  },
  users: [
    {
      console_access: false,
      groups: ["__string"],
      password: "__string",
      username: "__string",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

Returns:

  • (Boolean)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_nameString

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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

#configurationTypes::ConfigurationId

A list of information about the configuration.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_idString

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_modeString

The deployment mode of the broker.

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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

#encryption_optionsTypes::EncryptionOptions

Encryption options for the broker.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_typeString

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

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_versionString

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_typeString

Returns:

  • (String)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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

#logsTypes::Logs

The list of information about logs to be enabled for the specified broker.

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_timeTypes::WeeklyStartTime

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_accessibleBoolean

Returns:

  • (Boolean)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_groupsArray<String>

Returns:

  • (Array<String>)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

class CreateBrokerRequest < Struct.new(
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :encryption_options,
  :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_idsArray<String>

Returns:

  • (Array<String>)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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

#tagsHash<String,String>

Returns:

  • (Hash<String,String>)


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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

#usersArray<Types::User>

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 587

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