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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateBrokerRequest as input to an Aws::Client method, you can use a vanilla 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)

#broker_nameString

Returns:

  • (String)

#configurationTypes::ConfigurationId

A list of information about the configuration.

Returns:

#creator_request_idString

Returns:

  • (String)

#deployment_modeString

The deployment mode of the broker.

Possible values:

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ

Returns:

  • (String)

    The deployment mode of the broker.

#encryption_optionsTypes::EncryptionOptions

Encryption options for the broker.

Returns:

#engine_typeString

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

Possible values:

  • ACTIVEMQ

Returns:

  • (String)

    The type of broker engine.

#engine_versionString

Returns:

  • (String)

#host_instance_typeString

Returns:

  • (String)

#logsTypes::Logs

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

Returns:

  • (Types::Logs)

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

#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.

Returns:

  • (Types::WeeklyStartTime)

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

#publicly_accessibleBoolean

Returns:

  • (Boolean)

#security_groupsArray<String>

Returns:

  • (Array<String>)

#subnet_idsArray<String>

Returns:

  • (Array<String>)

#tagsHash<String,String>

Returns:

  • (Hash<String,String>)

#usersArray<Types::User>

Returns: