Class CfnBroker
A CloudFormation AWS::AmazonMQ::Broker
.
Inherited Members
Namespace: Amazon.CDK.AWS.AmazonMQ
Assembly: Amazon.CDK.AWS.AmazonMQ.dll
Syntax (csharp)
public class CfnBroker : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBroker
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
A broker is a message broker environment running on Amazon MQ . It is the basic building block of Amazon MQ .
The AWS::AmazonMQ::Broker
resource lets you create Amazon MQ for ActiveMQ and Amazon MQ for RabbitMQ brokers, add configuration changes or modify users for a speified ActiveMQ broker, return information about the specified broker, and delete the broker. For more information, see How Amazon MQ works in the Amazon MQ Developer Guide .
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
This permission is required to attach the ENI to the broker instance.
CloudformationResource: AWS::AmazonMQ::Broker
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmazonMQ;
var cfnBroker = new CfnBroker(this, "MyCfnBroker", new CfnBrokerProps {
AutoMinorVersionUpgrade = false,
BrokerName = "brokerName",
DeploymentMode = "deploymentMode",
EngineType = "engineType",
EngineVersion = "engineVersion",
HostInstanceType = "hostInstanceType",
PubliclyAccessible = false,
Users = new [] { new UserProperty {
Password = "password",
Username = "username",
// the properties below are optional
ConsoleAccess = false,
Groups = new [] { "groups" }
} },
// the properties below are optional
AuthenticationStrategy = "authenticationStrategy",
Configuration = new ConfigurationIdProperty {
Id = "id",
Revision = 123
},
EncryptionOptions = new EncryptionOptionsProperty {
UseAwsOwnedKey = false,
// the properties below are optional
KmsKeyId = "kmsKeyId"
},
LdapServerMetadata = new LdapServerMetadataProperty {
Hosts = new [] { "hosts" },
RoleBase = "roleBase",
RoleSearchMatching = "roleSearchMatching",
ServiceAccountPassword = "serviceAccountPassword",
ServiceAccountUsername = "serviceAccountUsername",
UserBase = "userBase",
UserSearchMatching = "userSearchMatching",
// the properties below are optional
RoleName = "roleName",
RoleSearchSubtree = false,
UserRoleName = "userRoleName",
UserSearchSubtree = false
},
Logs = new LogListProperty {
Audit = false,
General = false
},
MaintenanceWindowStartTime = new MaintenanceWindowProperty {
DayOfWeek = "dayOfWeek",
TimeOfDay = "timeOfDay",
TimeZone = "timeZone"
},
SecurityGroups = new [] { "securityGroups" },
StorageType = "storageType",
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new TagsEntryProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnBroker(Construct, String, ICfnBrokerProps) | Create a new |
CfnBroker(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBroker(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrAmqpEndpoints | The AMQP endpoints of each broker instance as a list of strings. |
AttrArn | The Amazon Resource Name (ARN) of the Amazon MQ broker. |
AttrConfigurationId | The unique ID that Amazon MQ generates for the configuration. |
AttrConfigurationRevision | The revision number of the configuration. |
AttrIpAddresses | The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers. |
AttrMqttEndpoints | The MQTT endpoints of each broker instance as a list of strings. |
AttrOpenWireEndpoints | The OpenWire endpoints of each broker instance as a list of strings. |
AttrStompEndpoints | The STOMP endpoints of each broker instance as a list of strings. |
AttrWssEndpoints | The WSS endpoints of each broker instance as a list of strings. |
AuthenticationStrategy | Optional. |
AutoMinorVersionUpgrade | Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. |
BrokerName | The name of the broker. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Configuration | A list of information about the configuration. |
DeploymentMode | The deployment mode of the broker. Available values:. |
EncryptionOptions | Encryption options for the broker. |
EngineType | The type of broker engine. |
EngineVersion | The version of the broker engine. |
HostInstanceType | The broker's instance type. |
LdapServerMetadata | Optional. |
Logs | Enables Amazon CloudWatch logging for brokers. |
MaintenanceWindowStartTime | The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. |
PubliclyAccessible | Enables connections from applications outside of the VPC that hosts the broker's subnets. |
SecurityGroups | The list of rules (1 minimum, 125 maximum) that authorize 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. |
Tags | An array of key-value pairs. |
Users | The list of broker users (persons or applications) who can access queues and topics. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBroker(Construct, String, ICfnBrokerProps)
Create a new AWS::AmazonMQ::Broker
.
public CfnBroker(Construct scope, string id, ICfnBrokerProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBrokerProps
- resource properties.
CfnBroker(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBroker(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBroker(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBroker(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrAmqpEndpoints
The AMQP endpoints of each broker instance as a list of strings.
public virtual string[] AttrAmqpEndpoints { get; }
Property Value
System.String[]
Remarks
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671
CloudformationAttribute: AmqpEndpoints
AttrArn
The Amazon Resource Name (ARN) of the Amazon MQ broker.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
CloudformationAttribute: Arn
AttrConfigurationId
The unique ID that Amazon MQ generates for the configuration.
public virtual string AttrConfigurationId { get; }
Property Value
System.String
Remarks
c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
CloudformationAttribute: ConfigurationId
AttrConfigurationRevision
The revision number of the configuration.
public virtual double AttrConfigurationRevision { get; }
Property Value
System.Double
Remarks
1
CloudformationAttribute: ConfigurationRevision
AttrIpAddresses
The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
public virtual string[] AttrIpAddresses { get; }
Property Value
System.String[]
Remarks
['198.51.100.2', '203.0.113.9']
CloudformationAttribute: IpAddresses
AttrMqttEndpoints
The MQTT endpoints of each broker instance as a list of strings.
public virtual string[] AttrMqttEndpoints { get; }
Property Value
System.String[]
Remarks
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883
CloudformationAttribute: MqttEndpoints
AttrOpenWireEndpoints
The OpenWire endpoints of each broker instance as a list of strings.
public virtual string[] AttrOpenWireEndpoints { get; }
Property Value
System.String[]
Remarks
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617
CloudformationAttribute: OpenWireEndpoints
AttrStompEndpoints
The STOMP endpoints of each broker instance as a list of strings.
public virtual string[] AttrStompEndpoints { get; }
Property Value
System.String[]
Remarks
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614
CloudformationAttribute: StompEndpoints
AttrWssEndpoints
The WSS endpoints of each broker instance as a list of strings.
public virtual string[] AttrWssEndpoints { get; }
Property Value
System.String[]
Remarks
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
CloudformationAttribute: WssEndpoints
AuthenticationStrategy
Optional.
public virtual string AuthenticationStrategy { get; set; }
Property Value
System.String
Remarks
The authentication strategy used to secure the broker. The default is SIMPLE
.
AutoMinorVersionUpgrade
Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
Remarks
Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
BrokerName
The name of the broker.
public virtual string BrokerName { get; set; }
Property Value
System.String
Remarks
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 C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Configuration
A list of information about the configuration.
public virtual object Configuration { get; set; }
Property Value
System.Object
Remarks
Does not apply to RabbitMQ brokers.
DeploymentMode
The deployment mode of the broker. Available values:.
public virtual string DeploymentMode { get; set; }
Property Value
System.String
Remarks
EncryptionOptions
Encryption options for the broker.
public virtual object EncryptionOptions { get; set; }
Property Value
System.Object
Remarks
Does not apply to RabbitMQ brokers.
EngineType
The type of broker engine.
public virtual string EngineType { get; set; }
Property Value
System.String
Remarks
Currently, Amazon MQ supports ACTIVEMQ
and RABBITMQ
.
EngineVersion
The version of the broker engine.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
HostInstanceType
The broker's instance type.
public virtual string HostInstanceType { get; set; }
Property Value
System.String
Remarks
LdapServerMetadata
Optional.
public virtual object LdapServerMetadata { get; set; }
Property Value
System.Object
Remarks
The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Logs
Enables Amazon CloudWatch logging for brokers.
public virtual object Logs { get; set; }
Property Value
System.Object
Remarks
MaintenanceWindowStartTime
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
public virtual object MaintenanceWindowStartTime { get; set; }
Property Value
System.Object
Remarks
PubliclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
Remarks
SecurityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
public virtual string[] SecurityGroups { get; set; }
Property Value
System.String[]
Remarks
StorageType
The broker's storage type.
public virtual string StorageType { get; set; }
Property Value
System.String
Remarks
SubnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
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 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.
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 enpoints in VPCs that are not owned by your AWS account .
Tags
An array of key-value pairs.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
Users
The list of broker users (persons or applications) who can access queues and topics.
public virtual object Users { get; set; }
Property Value
System.Object
Remarks
For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent RabbitMQ users are created by via the RabbitMQ web console or by using the RabbitMQ management API.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>