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

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

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

Overview

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategy ⇒ String

The authentication strategy used to secure the broker.

Possible values:

  • SIMPLE
  • LDAP

Returns:

  • (String) —

    The authentication strategy used to secure the broker.

#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) —

    Required.

#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) —

    Required.

#configuration ⇒ Types::ConfigurationId

A list of information about the configuration.

Returns:

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

Returns:

  • (String) —

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

#deployment_mode ⇒ String

Required. The deployment mode of the broker.

Possible values:

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ
  • CLUSTER_MULTI_AZ

Returns:

  • (String) —

    Required.

#encryption_options ⇒ Types::EncryptionOptions

Encryption options for the broker.

Returns:

#engine_type ⇒ String

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

Possible values:

  • ACTIVEMQ
  • RABBITMQ

Returns:

  • (String) —

    Required.

#engine_version ⇒ String

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

Returns:

  • (String) —

    Required.

#host_instance_type ⇒ String

Required. The broker\'s instance type.

Returns:

  • (String) —

    Required.

#ldap_server_metadata ⇒ Types::LdapServerMetadataInput

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Returns:

#logs ⇒ Types::Logs

Enables Amazon CloudWatch logging for brokers.

Returns:

  • (Types::Logs) —

    Enables Amazon CloudWatch logging for brokers.

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

The parameters that determine the WeeklyStartTime.

Returns:

#publicly_accessible ⇒ Boolean

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

Returns:

  • (Boolean) —

    Required.

#security_groups ⇒ Array<String>

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

  • (Array<String>) —

    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

#storage_type ⇒ String

The broker\'s storage type.

Possible values:

  • EBS
  • EFS

Returns:

  • (String) —

    The broker\'s storage type.

#subnet_ids ⇒ Array<String>

The list of groups 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 (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.

Returns:

  • (Array<String>) —

    The list of groups 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.

Returns:

  • (Hash<String,String>) —

    Create tags when creating the broker.

#users ⇒ Array<Types::User>

Required. The list of broker users (persons or applications) who can access queues and topics. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Returns: