Class CfnBrokerMixinProps

Properties for CfnBrokerPropsMixin.

Inheritance

object

CfnBrokerMixinProps

Implements

ICfnBrokerMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.AmazonMQ

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnBrokerMixinProps : ICfnBrokerMixinProps

Syntax (vb)

Public Class CfnBrokerMixinProps Implements ICfnBrokerMixinProps

Remarks

See: 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.CfnPropertyMixins.AWS.AmazonMQ;

             var cfnBrokerMixinProps = new CfnBrokerMixinProps {
                 AuthenticationStrategy = "authenticationStrategy",
                 AutoMinorVersionUpgrade = false,
                 BrokerName = "brokerName",
                 Configuration = new ConfigurationIdProperty {
                     Id = "id",
                     Revision = 123
                 },
                 DataReplicationMode = "dataReplicationMode",
                 DataReplicationPrimaryBrokerArn = "dataReplicationPrimaryBrokerArn",
                 DeploymentMode = "deploymentMode",
                 EncryptionOptions = new EncryptionOptionsProperty {
                     KmsKeyId = "kmsKeyId",
                     UseAwsOwnedKey = false
                 },
                 EngineType = "engineType",
                 EngineVersion = "engineVersion",
                 HostInstanceType = "hostInstanceType",
                 LdapServerMetadata = new LdapServerMetadataProperty {
                     Hosts = new [] { "hosts" },
                     RoleBase = "roleBase",
                     RoleName = "roleName",
                     RoleSearchMatching = "roleSearchMatching",
                     RoleSearchSubtree = false,
                     ServiceAccountPassword = "serviceAccountPassword",
                     ServiceAccountUsername = "serviceAccountUsername",
                     UserBase = "userBase",
                     UserRoleName = "userRoleName",
                     UserSearchMatching = "userSearchMatching",
                     UserSearchSubtree = false
                 },
                 Logs = new LogListProperty {
                     Audit = false,
                     General = false
                 },
                 MaintenanceWindowStartTime = new MaintenanceWindowProperty {
                     DayOfWeek = "dayOfWeek",
                     TimeOfDay = "timeOfDay",
                     TimeZone = "timeZone"
                 },
                 PubliclyAccessible = false,
                 SecurityGroups = new [] { "securityGroups" },
                 StorageType = "storageType",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new TagsEntryProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 Users = new [] { new UserProperty {
                     ConsoleAccess = false,
                     Groups = new [] { "groups" },
                     Password = "password",
                     ReplicationUser = false,
                     Username = "username"
                 } }
             };

Synopsis

Constructors

CfnBrokerMixinProps()

Properties for CfnBrokerPropsMixin.

Properties

AuthenticationStrategy	Optional.
AutoMinorVersionUpgrade	Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
BrokerName	Required.
Configuration	A list of information about the configuration.
DataReplicationMode	Defines whether this broker is a part of a data replication pair.
DataReplicationPrimaryBrokerArn	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.
DeploymentMode	Required.
EncryptionOptions	Encryption options for the broker.
EngineType	Required.
EngineVersion	The broker engine version.
HostInstanceType	Required.
LdapServerMetadata	Optional.
Logs	Enables Amazon CloudWatch logging for brokers.
MaintenanceWindowStartTime	The parameters that determine the WeeklyStartTime.
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	Create tags when creating the broker.
Users	The list of broker users (persons or applications) who can access queues and topics.

Constructors

CfnBrokerMixinProps()

Properties for CfnBrokerPropsMixin.

public CfnBrokerMixinProps()

Remarks

See: 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.CfnPropertyMixins.AWS.AmazonMQ;

             var cfnBrokerMixinProps = new CfnBrokerMixinProps {
                 AuthenticationStrategy = "authenticationStrategy",
                 AutoMinorVersionUpgrade = false,
                 BrokerName = "brokerName",
                 Configuration = new ConfigurationIdProperty {
                     Id = "id",
                     Revision = 123
                 },
                 DataReplicationMode = "dataReplicationMode",
                 DataReplicationPrimaryBrokerArn = "dataReplicationPrimaryBrokerArn",
                 DeploymentMode = "deploymentMode",
                 EncryptionOptions = new EncryptionOptionsProperty {
                     KmsKeyId = "kmsKeyId",
                     UseAwsOwnedKey = false
                 },
                 EngineType = "engineType",
                 EngineVersion = "engineVersion",
                 HostInstanceType = "hostInstanceType",
                 LdapServerMetadata = new LdapServerMetadataProperty {
                     Hosts = new [] { "hosts" },
                     RoleBase = "roleBase",
                     RoleName = "roleName",
                     RoleSearchMatching = "roleSearchMatching",
                     RoleSearchSubtree = false,
                     ServiceAccountPassword = "serviceAccountPassword",
                     ServiceAccountUsername = "serviceAccountUsername",
                     UserBase = "userBase",
                     UserRoleName = "userRoleName",
                     UserSearchMatching = "userSearchMatching",
                     UserSearchSubtree = false
                 },
                 Logs = new LogListProperty {
                     Audit = false,
                     General = false
                 },
                 MaintenanceWindowStartTime = new MaintenanceWindowProperty {
                     DayOfWeek = "dayOfWeek",
                     TimeOfDay = "timeOfDay",
                     TimeZone = "timeZone"
                 },
                 PubliclyAccessible = false,
                 SecurityGroups = new [] { "securityGroups" },
                 StorageType = "storageType",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new TagsEntryProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 Users = new [] { new UserProperty {
                     ConsoleAccess = false,
                     Groups = new [] { "groups" },
                     Password = "password",
                     ReplicationUser = false,
                     Username = "username"
                 } }
             };

Properties

AuthenticationStrategy

Optional.

public string? AuthenticationStrategy { get; set; }

Property Value

string

Remarks

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

AutoMinorVersionUpgrade

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.

public object? AutoMinorVersionUpgrade { get; set; }

Property Value

object

Remarks

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 <code>true</code> 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

Type union: either bool or IResolvable

BrokerName

Required.

public string? BrokerName { get; set; }

Property Value

string

Remarks

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

Configuration

A list of information about the configuration.

public object? Configuration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration

Type union: either IResolvable or CfnBrokerPropsMixin.IConfigurationIdProperty

DataReplicationMode

Defines whether this broker is a part of a data replication pair.

public string? DataReplicationMode { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-datareplicationmode

DataReplicationPrimaryBrokerArn

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.

public string? DataReplicationPrimaryBrokerArn { get; set; }

Property Value

string

Remarks

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

DeploymentMode

Required.

public string? DeploymentMode { get; set; }

Property Value

string

Remarks

The broker's deployment mode.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode

EncryptionOptions

Encryption options for the broker.

public object? EncryptionOptions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions

Type union: either IResolvable or CfnBrokerPropsMixin.IEncryptionOptionsProperty

EngineType

Required.

public string? EngineType { get; set; }

Property Value

string

Remarks

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

EngineVersion

The broker engine version.

public string? EngineVersion { get; set; }

Property Value

string

Remarks

Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management 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

HostInstanceType

Required.

public string? HostInstanceType { get; set; }

Property Value

string

Remarks

The broker's instance type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype

LdapServerMetadata

Optional.

public object? LdapServerMetadata { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnBrokerPropsMixin.ILdapServerMetadataProperty

Logs

Enables Amazon CloudWatch logging for brokers.

public object? Logs { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs

Type union: either IResolvable or CfnBrokerPropsMixin.ILogListProperty

MaintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

public object? MaintenanceWindowStartTime { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime

Type union: either IResolvable or CfnBrokerPropsMixin.IMaintenanceWindowProperty

PubliclyAccessible

Enables connections from applications outside of the VPC that hosts the broker's subnets.

public object? PubliclyAccessible { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

SecurityGroups

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

public string[]? SecurityGroups { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups

StorageType

The broker's storage type.

public string? StorageType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype

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

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 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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html">shared VPC</a> 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

Tags

Create tags when creating the broker.

public CfnBrokerPropsMixin.ITagsEntryProperty[]? Tags { get; set; }

Property Value

ITagsEntryProperty[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags

Users

The list of broker users (persons or applications) who can access queues and topics.

public object? Users { get; set; }

Property Value

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

Type union: either IResolvable or (either IResolvable or CfnBrokerPropsMixin.IUserProperty)[]

Implements

ICfnBrokerMixinProps