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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  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",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Returns:

  • (Boolean) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

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

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

The deployment mode of the broker.

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

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

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

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

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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 scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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

Returns:

  • (Boolean) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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>

Returns:

  • (Array<String>) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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>

Returns:

  • (Array<String>) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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>

Returns:

  • (Hash<String,String>) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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>

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/aws-sdk-mq/types.rb', line 431

class CreateBrokerRequest < 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