MQ

import { MQ } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/mq.ts?docs=full";

class MQ {

constructor(apiFactory: client.ApiFactory);

async createBroker(params: CreateBrokerRequest, opts?: client.RequestOptions): Promise<CreateBrokerResponse>;

async createConfiguration(params: CreateConfigurationRequest, opts?: client.RequestOptions): Promise<CreateConfigurationResponse>;

async createTags(params: CreateTagsRequest, opts?: client.RequestOptions): Promise<void>;

async createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<void>;

async deleteBroker(params: DeleteBrokerRequest, opts?: client.RequestOptions): Promise<DeleteBrokerResponse>;

async deleteTags(params: DeleteTagsRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>;

async describeBroker(params: DescribeBrokerRequest, opts?: client.RequestOptions): Promise<DescribeBrokerResponse>;

async describeBrokerEngineTypes(params?: DescribeBrokerEngineTypesRequest, opts?: client.RequestOptions): Promise<DescribeBrokerEngineTypesResponse>;

async describeBrokerInstanceOptions(params?: DescribeBrokerInstanceOptionsRequest, opts?: client.RequestOptions): Promise<DescribeBrokerInstanceOptionsResponse>;

async describeConfiguration(params: DescribeConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationResponse>;

async describeConfigurationRevision(params: DescribeConfigurationRevisionRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationRevisionResponse>;

async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;

async listBrokers(params?: ListBrokersRequest, opts?: client.RequestOptions): Promise<ListBrokersResponse>;

async listConfigurationRevisions(params: ListConfigurationRevisionsRequest, opts?: client.RequestOptions): Promise<ListConfigurationRevisionsResponse>;

async listConfigurations(params?: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>;

async listTags(params: ListTagsRequest, opts?: client.RequestOptions): Promise<ListTagsResponse>;

async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;

async promote(params: PromoteRequest, opts?: client.RequestOptions): Promise<PromoteResponse>;

async rebootBroker(params: RebootBrokerRequest, opts?: client.RequestOptions): Promise<void>;

async updateBroker(params: UpdateBrokerRequest, opts?: client.RequestOptions): Promise<UpdateBrokerResponse>;

async updateConfiguration(params: UpdateConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateConfigurationResponse>;

async updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new MQ(apiFactory: client.ApiFactory)

[src]

§Methods

createBroker(params: CreateBrokerRequest, opts?: client.RequestOptions): Promise<CreateBrokerResponse>

[src]

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

ec2:CreateNetworkInterface This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

createConfiguration(params: CreateConfigurationRequest, opts?: client.RequestOptions): Promise<CreateConfigurationResponse>

[src]

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

createTags(params: CreateTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Add a tag to a resource.

createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates an ActiveMQ user.

! IMPORTANT: ! Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. ! Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. ! Broker usernames are not intended to be used for private or sensitive data.

deleteBroker(params: DeleteBrokerRequest, opts?: client.RequestOptions): Promise<DeleteBrokerResponse>

[src]

Deletes a broker. Note: This API is asynchronous.

deleteTags(params: DeleteTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from a resource.

deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an ActiveMQ user.

describeBroker(params: DescribeBrokerRequest, opts?: client.RequestOptions): Promise<DescribeBrokerResponse>

[src]

Returns information about the specified broker.

describeBrokerEngineTypes(params?: DescribeBrokerEngineTypesRequest, opts?: client.RequestOptions): Promise<DescribeBrokerEngineTypesResponse>

[src]

Describe available engine types and versions.

describeBrokerInstanceOptions(params?: DescribeBrokerInstanceOptionsRequest, opts?: client.RequestOptions): Promise<DescribeBrokerInstanceOptionsResponse>

[src]

Describe available broker instance options.

describeConfiguration(params: DescribeConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationResponse>

[src]

Returns information about the specified configuration.

describeConfigurationRevision(params: DescribeConfigurationRevisionRequest, opts?: client.RequestOptions): Promise<DescribeConfigurationRevisionResponse>

[src]

Returns the specified configuration revision for the specified configuration.

describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>

[src]

Returns information about an ActiveMQ user.

listBrokers(params?: ListBrokersRequest, opts?: client.RequestOptions): Promise<ListBrokersResponse>

[src]

Returns a list of all brokers.

listConfigurationRevisions(params: ListConfigurationRevisionsRequest, opts?: client.RequestOptions): Promise<ListConfigurationRevisionsResponse>

[src]

Returns a list of all revisions for the specified configuration.

listConfigurations(params?: ListConfigurationsRequest, opts?: client.RequestOptions): Promise<ListConfigurationsResponse>

[src]

Returns a list of all configurations.

listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>

[src]

Returns a list of all ActiveMQ users.

promote(params: PromoteRequest, opts?: client.RequestOptions): Promise<PromoteResponse>

[src]

Promotes a data replication replica broker to the primary broker role.

rebootBroker(params: RebootBrokerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Reboots a broker. Note: This API is asynchronous.

updateBroker(params: UpdateBrokerRequest, opts?: client.RequestOptions): Promise<UpdateBrokerResponse>

[src]

Adds a pending configuration change to a broker.

updateConfiguration(params: UpdateConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateConfigurationResponse>

[src]

Updates the specified configuration.

updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the information for an ActiveMQ user.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]