aws-cdk-lib

import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { BrokerReference, ConfigurationAssociationReference, ConfigurationReference, IBrokerRef, IConfigurationAssociationRef, IConfigurationRef } from "../../interfaces/generated/aws-amazonmq-interfaces.generated"; /** * 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 AWS Credentials](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user) and [Never Modify or Delete the Amazon MQ Elastic Network Interface](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface) in the *Amazon MQ Developer Guide* . * * @cloudformationResource AWS::AmazonMQ::Broker * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html */ export declare class CfnBroker extends cdk.CfnResource implements cdk.IInspectable, IBrokerRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnBroker from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnBroker; /** * Checks whether the given object is a CfnBroker */ static isCfnBroker(x: any): x is CfnBroker; static arnForBroker(resource: IBrokerRef): string; /** * The AMQP endpoints of each broker instance as a list of strings. * * `amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671` * * @cloudformationAttribute AmqpEndpoints */ readonly attrAmqpEndpoints: Array<string>; /** * The Amazon Resource Name (ARN) of the Amazon MQ broker. * * `arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The unique ID that Amazon MQ generates for the configuration. * * `c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` * * @cloudformationAttribute ConfigurationId */ readonly attrConfigurationId: string; /** * The revision number of the configuration. * * `1` * * @cloudformationAttribute ConfigurationRevision */ readonly attrConfigurationRevision: number; /** * @cloudformationAttribute ConsoleURLs */ readonly attrConsoleUrLs: Array<string>; /** * The version in use. This may have more precision than the specified EngineVersion. * * @cloudformationAttribute EngineVersionCurrent */ readonly attrEngineVersionCurrent: string; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers. * * `['198.51.100.2', '203.0.113.9']` * * @cloudformationAttribute IpAddresses */ readonly attrIpAddresses: Array<string>; /** * The MQTT endpoints of each broker instance as a list of strings. * * `mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883` * * @cloudformationAttribute MqttEndpoints */ readonly attrMqttEndpoints: Array<string>; /** * The OpenWire endpoints of each broker instance as a list of strings. * * `ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617` * * @cloudformationAttribute OpenWireEndpoints */ readonly attrOpenWireEndpoints: Array<string>; /** * The STOMP endpoints of each broker instance as a list of strings. * * `stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614` * * @cloudformationAttribute StompEndpoints */ readonly attrStompEndpoints: Array<string>; /** * The WSS endpoints of each broker instance as a list of strings. * * `wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619` * * @cloudformationAttribute WssEndpoints */ readonly attrWssEndpoints: Array<string>; /** * Optional. */ authenticationStrategy?: string; /** * Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. */ autoMinorVersionUpgrade?: boolean | cdk.IResolvable; /** * Required. */ brokerName: string; /** * A list of information about the configuration. */ configuration?: CfnBroker.ConfigurationIdProperty | cdk.IResolvable; /** * Defines whether this broker is a part of a data replication pair. */ dataReplicationMode?: string; /** * The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. */ dataReplicationPrimaryBrokerArn?: string; /** * Required. */ deploymentMode: string; /** * Encryption options for the broker. */ encryptionOptions?: CfnBroker.EncryptionOptionsProperty | cdk.IResolvable; /** * Required. */ engineType: string; /** * The broker engine version. */ engineVersion?: string; /** * Required. */ hostInstanceType: string; /** * Optional. */ ldapServerMetadata?: cdk.IResolvable | CfnBroker.LdapServerMetadataProperty; /** * Enables Amazon CloudWatch logging for brokers. */ logs?: cdk.IResolvable | CfnBroker.LogListProperty; /** * The parameters that determine the WeeklyStartTime. */ maintenanceWindowStartTime?: cdk.IResolvable | CfnBroker.MaintenanceWindowProperty; /** * Enables connections from applications outside of the VPC that hosts the broker's subnets. */ publiclyAccessible: boolean | cdk.IResolvable; /** * The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. */ securityGroups?: Array<string>; /** * The broker's storage type. */ storageType?: string; /** * The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. */ subnetIds?: Array<string>; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Create tags when creating the broker. */ tagsRaw?: Array<CfnBroker.TagsEntryProperty>; /** * The list of broker users (persons or applications) who can access queues and topics. */ users?: Array<cdk.IResolvable | CfnBroker.UserProperty> | cdk.IResolvable; /** * Create a new `AWS::AmazonMQ::Broker`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnBrokerProps); get brokerRef(): BrokerReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnBroker { /** * A list of information about the configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html */ interface ConfigurationIdProperty { /** * Required. * * The unique ID that Amazon MQ generates for the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id */ readonly id: string; /** * The revision number of the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision */ readonly revision: number; } /** * The parameters that determine the WeeklyStartTime. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html */ interface MaintenanceWindowProperty { /** * Required. * * The day of the week. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek */ readonly dayOfWeek: string; /** * Required. * * The time, in 24-hour format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday */ readonly timeOfDay: string; /** * The time zone, UTC by default, in either the Country/City format, or the UTC offset format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone */ readonly timeZone: string; } /** * The list of broker users (persons or applications) who can access queues and topics. * * For Amazon MQ 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. * * When OAuth 2.0 is enabled, the broker accepts one or no users. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html */ interface UserProperty { /** * Enables access to the ActiveMQ Web Console for the ActiveMQ user. * * Does not apply to RabbitMQ brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess */ readonly consoleAccess?: boolean | cdk.IResolvable; /** * The list of groups (20 maximum) to which the ActiveMQ user belongs. * * This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups */ readonly groups?: Array<string>; /** * Required. * * The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password */ readonly password: string; /** * Defines if this user is intended for CRDR replication purposes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-replicationuser */ readonly replicationUser?: boolean | cdk.IResolvable; /** * The username of the broker user. The following restrictions apply to broker usernames:. * * - For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. * - For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using `guest` as a valid usename. This value must be 2-100 characters long. * * > Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username */ readonly username: string; } /** * The list of information about logs to be enabled for the specified broker. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html */ interface LogListProperty { /** * Enables audit logging. * * Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit */ readonly audit?: boolean | cdk.IResolvable; /** * Enables general logging. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general */ readonly general?: boolean | cdk.IResolvable; } /** * Optional. * * The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html */ interface LdapServerMetadataProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-hosts */ readonly hosts: Array<string>; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolebase */ readonly roleBase: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolename */ readonly roleName?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolesearchmatching */ readonly roleSearchMatching: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-rolesearchsubtree */ readonly roleSearchSubtree?: boolean | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-serviceaccountpassword */ readonly serviceAccountPassword?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-serviceaccountusername */ readonly serviceAccountUsername: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-userbase */ readonly userBase: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-userrolename */ readonly userRoleName?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-usersearchmatching */ readonly userSearchMatching: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-ldapservermetadata.html#cfn-amazonmq-broker-ldapservermetadata-usersearchsubtree */ readonly userSearchSubtree?: boolean | cdk.IResolvable; } /** * Encryption options for the broker. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html */ interface EncryptionOptionsProperty { /** * The customer master key (CMK) to use for the A AWS (KMS). * * This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-kmskeyid */ readonly kmsKeyId?: string; /** * Enables the use of an AWS owned CMK using AWS (KMS). * * Set to `true` by default, if no value is provided, for example, for RabbitMQ brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-useawsownedkey */ readonly useAwsOwnedKey: boolean | cdk.IResolvable; } /** * Create tags when creating the broker. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html */ interface TagsEntryProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-key */ readonly key: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-value */ readonly value: string; } } /** * Properties for defining a `CfnBroker` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html */ export interface CfnBrokerProps { /** * Optional. * * The authentication strategy used to secure the broker. The default is `SIMPLE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-authenticationstrategy */ readonly authenticationStrategy?: string; /** * Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. * * Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to `true` by default, if no value is specified. * * > Must be set to `true` for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade */ readonly autoMinorVersionUpgrade?: boolean | cdk.IResolvable; /** * 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. * * > Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including CloudWatch Logs . Broker names are not intended to be used for private or sensitive data. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername */ readonly brokerName: string; /** * A list of information about the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration */ readonly configuration?: CfnBroker.ConfigurationIdProperty | cdk.IResolvable; /** * Defines whether this broker is a part of a data replication pair. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationmode */ readonly dataReplicationMode?: string; /** * The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. * * Must be set when dataReplicationMode is set to CRDR. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationprimarybrokerarn */ readonly dataReplicationPrimaryBrokerArn?: string; /** * Required. * * The broker's deployment mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode */ readonly deploymentMode: string; /** * Encryption options for the broker. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions */ readonly encryptionOptions?: CfnBroker.EncryptionOptionsProperty | cdk.IResolvable; /** * Required. * * The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype */ readonly engineType: string; /** * The broker engine version. * * Defaults to the latest available version for the specified broker engine type. For more information, see the [ActiveMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html) and the [RabbitMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html) sections in the Amazon MQ Developer Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion */ readonly engineVersion?: string; /** * Required. * * The broker's instance type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype */ readonly hostInstanceType: string; /** * Optional. * * The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-ldapservermetadata */ readonly ldapServerMetadata?: cdk.IResolvable | CfnBroker.LdapServerMetadataProperty; /** * Enables Amazon CloudWatch logging for brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs */ readonly logs?: cdk.IResolvable | CfnBroker.LogListProperty; /** * The parameters that determine the WeeklyStartTime. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime */ readonly maintenanceWindowStartTime?: cdk.IResolvable | CfnBroker.MaintenanceWindowProperty; /** * Enables connections from applications outside of the VPC that hosts the broker's subnets. * * Set to `false` by default, if no value is provided. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible */ readonly publiclyAccessible: boolean | cdk.IResolvable; /** * The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups */ readonly securityGroups?: Array<string>; /** * The broker's storage type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype */ readonly storageType?: string; /** * 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. * * > If you specify subnets in a [shared VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html) 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 . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids */ readonly subnetIds?: Array<string>; /** * Create tags when creating the broker. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags */ readonly tags?: Array<CfnBroker.TagsEntryProperty>; /** * The list of broker users (persons or applications) who can access queues and topics. * * For Amazon MQ 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. * * When OAuth 2.0 is enabled, the broker accepts one or no users. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users */ readonly users?: Array<cdk.IResolvable | CfnBroker.UserProperty> | cdk.IResolvable; } /** * Creates a new configuration for the specified configuration name. * * Amazon MQ uses the default configuration (the engine type and version). * * @cloudformationResource AWS::AmazonMQ::Configuration * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html */ export declare class CfnConfiguration extends cdk.CfnResource implements cdk.IInspectable, IConfigurationRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnConfiguration from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConfiguration; /** * Checks whether the given object is a CfnConfiguration */ static isCfnConfiguration(x: any): x is CfnConfiguration; /** * Creates a new IConfigurationRef from an ARN */ static fromConfigurationArn(scope: constructs.Construct, id: string, arn: string): IConfigurationRef; /** * Creates a new IConfigurationRef from a configurationId */ static fromConfigurationId(scope: constructs.Construct, id: string, configurationId: string): IConfigurationRef; static arnForConfiguration(resource: IConfigurationRef): string; /** * The Amazon Resource Name (ARN) of the Amazon MQ configuration. * * `arn:aws:mq:us-east-2:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The ID of the Amazon MQ configuration. * * `c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9` * * @cloudformationAttribute Id */ readonly attrId: string; /** * The revision number of the configuration. * * `1` * * @cloudformationAttribute Revision */ readonly attrRevision: number; /** * Optional. */ authenticationStrategy?: string; /** * Amazon MQ for Active MQ: The base64-encoded XML configuration. */ data?: string; /** * The description of the configuration. */ description?: string; /** * Required. */ engineType: string; /** * The broker engine version. */ engineVersion?: string; /** * Required. */ name: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Create tags when creating the configuration. */ tagsRaw?: Array<CfnConfiguration.TagsEntryProperty>; /** * Create a new `AWS::AmazonMQ::Configuration`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnConfigurationProps); get configurationRef(): ConfigurationReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnConfiguration { /** * The list of all tags associated with this configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html */ interface TagsEntryProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-key */ readonly key: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-value */ readonly value: string; } } /** * Properties for defining a `CfnConfiguration` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html */ export interface CfnConfigurationProps { /** * Optional. * * The authentication strategy associated with the configuration. The default is `SIMPLE` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-authenticationstrategy */ readonly authenticationStrategy?: string; /** * Amazon MQ for Active MQ: The base64-encoded XML configuration. * * Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-data */ readonly data?: string; /** * The description of the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-description */ readonly description?: string; /** * Required. * * The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-enginetype */ readonly engineType: string; /** * The broker engine version. * * Defaults to the latest available version for the specified broker engine type. For more information, see the [ActiveMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html) and the [RabbitMQ version management](https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html) sections in the Amazon MQ Developer Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion */ readonly engineVersion?: string; /** * Required. * * The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name */ readonly name: string; /** * Create tags when creating the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-tags */ readonly tags?: Array<CfnConfiguration.TagsEntryProperty>; } /** * http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html. * * @cloudformationResource AWS::AmazonMQ::ConfigurationAssociation * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html */ export declare class CfnConfigurationAssociation extends cdk.CfnResource implements cdk.IInspectable, IConfigurationAssociationRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnConfigurationAssociation from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConfigurationAssociation; /** * Checks whether the given object is a CfnConfigurationAssociation */ static isCfnConfigurationAssociation(x: any): x is CfnConfigurationAssociation; /** * The ID of the ConfigurationAssociation Resource * * @cloudformationAttribute Id */ readonly attrId: string; /** * ID of the Broker that the configuration should be applied to. */ broker: string; /** * Returns information about all configurations. */ configuration: CfnConfigurationAssociation.ConfigurationIdProperty | cdk.IResolvable; /** * Create a new `AWS::AmazonMQ::ConfigurationAssociation`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnConfigurationAssociationProps); get configurationAssociationRef(): ConfigurationAssociationReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnConfigurationAssociation { /** * A list of information about the configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html */ interface ConfigurationIdProperty { /** * Required. * * The unique ID that Amazon MQ generates for the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-id */ readonly id: string; /** * The revision number of the configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-revision */ readonly revision: number; } } /** * Properties for defining a `CfnConfigurationAssociation` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html */ export interface CfnConfigurationAssociationProps { /** * ID of the Broker that the configuration should be applied to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-broker */ readonly broker: string; /** * Returns information about all configurations. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-configuration */ readonly configuration: CfnConfigurationAssociation.ConfigurationIdProperty | cdk.IResolvable; } export type { IBrokerRef, BrokerReference }; export type { IConfigurationRef, ConfigurationReference }; export type { IConfigurationAssociationRef, ConfigurationAssociationReference };