Class CfnBrokerProps
Properties for defining a CfnBroker.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AmazonMQ
Assembly: Amazon.CDK.AWS.AmazonMQ.dll
Syntax (csharp)
public class CfnBrokerProps : Object, ICfnBrokerPropsSyntax (vb)
Public Class CfnBrokerProps
Inherits Object
Implements ICfnBrokerPropsRemarks
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 cfnBrokerProps = 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
| CfnBrokerProps() |
Properties
| 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. |
| 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. |
Constructors
CfnBrokerProps()
public CfnBrokerProps()Properties
AuthenticationStrategy
Optional.
public 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 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 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.
Configuration
A list of information about the configuration.
public 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 string DeploymentMode { get; set; }Property Value
System.String
Remarks
EncryptionOptions
Encryption options for the broker.
public object EncryptionOptions { get; set; }Property Value
System.Object
Remarks
Does not apply to RabbitMQ brokers.
EngineType
The type of broker engine.
public string EngineType { get; set; }Property Value
System.String
Remarks
Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .
EngineVersion
The version of the broker engine.
public 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 string HostInstanceType { get; set; }Property Value
System.String
Remarks
LdapServerMetadata
Optional.
public 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 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 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 object PubliclyAccessible { get; set; }Property Value
System.Object
Remarks
SecurityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
public string[] SecurityGroups { get; set; }Property Value
System.String[]
Remarks
StorageType
The broker's storage type.
public 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 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 CfnBroker.ITagsEntryProperty[] Tags { get; set; }Property Value
CfnBroker.ITagsEntryProperty[]
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 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.