CreateBrokerRequest

import type { CreateBrokerRequest } from "https://aws-api.deno.dev/v0.3/services/mq.ts?docs=full";

Creates a broker using the specified properties.

interface CreateBrokerRequest {

AuthenticationStrategy?: AuthenticationStrategy | null;

AutoMinorVersionUpgrade: boolean;

BrokerName: string;

Configuration?: ConfigurationId | null;

CreatorRequestId?: string | null;

DeploymentMode: DeploymentMode;

EncryptionOptions?: EncryptionOptions | null;

EngineType: EngineType;

EngineVersion: string;

HostInstanceType: string;

LdapServerMetadata?: LdapServerMetadataInput | null;

Logs?: Logs | null;

MaintenanceWindowStartTime?: WeeklyStartTime | null;

PubliclyAccessible: boolean;

SecurityGroups?: string[] | null;

StorageType?: BrokerStorageType | null;

SubnetIds?: string[] | null;

Tags?: {

[key: string]: string | null | undefined;

} | null;

Users: User[];

}

§Properties

AuthenticationStrategy?: AuthenticationStrategy | null

[src]

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade: boolean

[src]

Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.

BrokerName: string

[src]

Required. The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.

Configuration?: ConfigurationId | null

[src]

A list of information about the configuration.

CreatorRequestId?: string | null

[src]

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: DeploymentMode

[src]

Required. The broker's deployment mode.

EncryptionOptions?: EncryptionOptions | null

[src]

Encryption options for the broker. Does not apply to RabbitMQ brokers.

EngineType: EngineType

[src]

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

EngineVersion: string

[src]

Required. The broker engine's version. For a list of supported engine versions, see Supported engines.

HostInstanceType: string

[src]

Required. The broker's instance type.

LdapServerMetadata?: LdapServerMetadataInput | null

[src]

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs?: Logs | null

[src]

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime?: WeeklyStartTime | null

[src]

The parameters that determine the WeeklyStartTime.

PubliclyAccessible: boolean

[src]

Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

SecurityGroups?: string[] | null

[src]

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType?: BrokerStorageType | null

[src]

The broker's storage type.

SubnetIds?: string[] | null

[src]

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.

! IMPORTANT: ! If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. ! Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.

Tags?: {

[key: string]: string | null | undefined;

} | null

[src]

Create tags when creating the broker.

Users: User[]

[src]

TODO: Failed to render documentation: unhandled top level doc tag title