Learn R Programming
paws.application.integration (version 0.1.11)

mq_create_broker: Creates a broker

Description

Creates a broker. Note: This API is asynchronous.

Usage

mq_create_broker(AuthenticationStrategy, AutoMinorVersionUpgrade,
  BrokerName, Configuration, CreatorRequestId, DeploymentMode,
  EncryptionOptions, EngineType, EngineVersion, HostInstanceType,
  LdapServerMetadata, Logs, MaintenanceWindowStartTime,
  PubliclyAccessible, SecurityGroups, StorageType, SubnetIds, Tags, Users)

Arguments

AuthenticationStrategy

The authentication strategy used to secure the broker.

AutoMinorVersionUpgrade

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.

BrokerName

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.

Configuration

A list of information about the configuration.

CreatorRequestId

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.

DeploymentMode

Required. The deployment mode of the broker.

EncryptionOptions

Encryption options for the broker.

EngineType

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

EngineVersion

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

HostInstanceType

Required. The broker's instance type.

LdapServerMetadata

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

Logs

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

PubliclyAccessible

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

SecurityGroups

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

StorageType

The broker's storage type.

SubnetIds

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.

Tags

Create tags when creating the broker.

Users

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.

Value

A list with the following syntax:

list(
  BrokerArn = "string",
  BrokerId = "string"
)

Request syntax

svc$create_broker(
  AuthenticationStrategy = "SIMPLE"|"LDAP",
  AutoMinorVersionUpgrade = TRUE|FALSE,
  BrokerName = "string",
  Configuration = list(
    Id = "string",
    Revision = 123
  ),
  CreatorRequestId = "string",
  DeploymentMode = "SINGLE_INSTANCE"|"ACTIVE_STANDBY_MULTI_AZ"|"CLUSTER_MULTI_AZ",
  EncryptionOptions = list(
    KmsKeyId = "string",
    UseAwsOwnedKey = TRUE|FALSE
  ),
  EngineType = "ACTIVEMQ"|"RABBITMQ",
  EngineVersion = "string",
  HostInstanceType = "string",
  LdapServerMetadata = list(
    Hosts = list(
      "string"
    ),
    RoleBase = "string",
    RoleName = "string",
    RoleSearchMatching = "string",
    RoleSearchSubtree = TRUE|FALSE,
    ServiceAccountPassword = "string",
    ServiceAccountUsername = "string",
    UserBase = "string",
    UserRoleName = "string",
    UserSearchMatching = "string",
    UserSearchSubtree = TRUE|FALSE
  ),
  Logs = list(
    Audit = TRUE|FALSE,
    General = TRUE|FALSE
  ),
  MaintenanceWindowStartTime = list(
    DayOfWeek = "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY",
    TimeOfDay = "string",
    TimeZone = "string"
  ),
  PubliclyAccessible = TRUE|FALSE,
  SecurityGroups = list(
    "string"
  ),
  StorageType = "EBS"|"EFS",
  SubnetIds = list(
    "string"
  ),
  Tags = list(
    "string"
  ),
  Users = list(
    list(
      ConsoleAccess = TRUE|FALSE,
      Groups = list(
        "string"
      ),
      Password = "string",
      Username = "string"
    )
  )
)