Class: AWSCDK::AmazonMQ::CfnBroker

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAmazonmq::IBrokerRef
Defined in:
amazon_mq/cfn_broker.rb

Overview

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 and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnBroker

Create a new AWS::AmazonMQ::Broker.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::AmazonMQ::CfnBrokerProps) —

    Resource properties.



41
42
43
44
45
46
47
 
# File 'amazon_mq/cfn_broker.rb', line 41

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBrokerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1hem9ubXEuQ2ZuQnJva2VyUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_broker(resource) ⇒ String

Parameters:

Returns:

  • (String) 


126
127
128
129
 
# File 'amazon_mq/cfn_broker.rb', line 126

def self.arn_for_broker(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hbWF6b25tcS5JQnJva2VyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amazonmq.CfnBroker", "arnForBroker", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


233
234
235
 
# File 'amazon_mq/cfn_broker.rb', line 233

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_amazonmq.CfnBroker", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_broker(x) ⇒ Boolean

Checks whether the given object is a CfnBroker.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


135
136
137
138
 
# File 'amazon_mq/cfn_broker.rb', line 135

def self.is_cfn_broker(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amazonmq.CfnBroker", "isCfnBroker", [x])
end

.jsii_overridable_methods ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'amazon_mq/cfn_broker.rb', line 49

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_amqp_endpoints => { kind: :property, name: "attrAmqpEndpoints", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_configuration_id => { kind: :property, name: "attrConfigurationId", is_optional: false },
    :attr_configuration_revision => { kind: :property, name: "attrConfigurationRevision", is_optional: false },
    :attr_console_ur_ls => { kind: :property, name: "attrConsoleUrLs", is_optional: false },
    :attr_engine_version_current => { kind: :property, name: "attrEngineVersionCurrent", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_ip_addresses => { kind: :property, name: "attrIpAddresses", is_optional: false },
    :attr_mqtt_endpoints => { kind: :property, name: "attrMqttEndpoints", is_optional: false },
    :attr_open_wire_endpoints => { kind: :property, name: "attrOpenWireEndpoints", is_optional: false },
    :attr_stomp_endpoints => { kind: :property, name: "attrStompEndpoints", is_optional: false },
    :attr_wss_endpoints => { kind: :property, name: "attrWssEndpoints", is_optional: false },
    :broker_ref => { kind: :property, name: "brokerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :broker_name => { kind: :property, name: "brokerName", is_optional: false },
    :deployment_mode => { kind: :property, name: "deploymentMode", is_optional: false },
    :engine_type => { kind: :property, name: "engineType", is_optional: false },
    :host_instance_type => { kind: :property, name: "hostInstanceType", is_optional: false },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: false },
    :authentication_strategy => { kind: :property, name: "authenticationStrategy", is_optional: true },
    :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true },
    :configuration => { kind: :property, name: "configuration", is_optional: true },
    :data_replication_mode => { kind: :property, name: "dataReplicationMode", is_optional: true },
    :data_replication_primary_broker_arn => { kind: :property, name: "dataReplicationPrimaryBrokerArn", is_optional: true },
    :encryption_options => { kind: :property, name: "encryptionOptions", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :ldap_server_metadata => { kind: :property, name: "ldapServerMetadata", is_optional: true },
    :logs => { kind: :property, name: "logs", is_optional: true },
    :maintenance_window_start_time => { kind: :property, name: "maintenanceWindowStartTime", is_optional: true },
    :resource_share_arns => { kind: :property, name: "resourceShareArns", is_optional: true },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: true },
    :storage_type => { kind: :property, name: "storageType", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :users => { kind: :property, name: "users", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



645
646
647
648
 
# File 'amazon_mq/cfn_broker.rb', line 645

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



657
658
659
660
 
# File 'amazon_mq/cfn_broker.rb', line 657

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



667
668
669
670
 
# File 'amazon_mq/cfn_broker.rb', line 667

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



678
679
680
681
682
 
# File 'amazon_mq/cfn_broker.rb', line 678

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


735
736
737
738
739
 
# File 'amazon_mq/cfn_broker.rb', line 735

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



745
746
747
748
 
# File 'amazon_mq/cfn_broker.rb', line 745

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



757
758
759
760
761
 
# File 'amazon_mq/cfn_broker.rb', line 757

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



770
771
772
773
 
# File 'amazon_mq/cfn_broker.rb', line 770

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



792
793
794
795
796
797
 
# File 'amazon_mq/cfn_broker.rb', line 792

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_amqp_endpoints ⇒ Array<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

Returns:

  • (Array<String>) 


242
243
244
 
# File 'amazon_mq/cfn_broker.rb', line 242

def attr_amqp_endpoints()
  jsii_get_property("attrAmqpEndpoints")
end

#attr_arn ⇒ 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

Returns:

  • (String) 


251
252
253
 
# File 'amazon_mq/cfn_broker.rb', line 251

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_configuration_id ⇒ String

The unique ID that Amazon MQ generates for the configuration.

c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

Returns:

  • (String) 


260
261
262
 
# File 'amazon_mq/cfn_broker.rb', line 260

def attr_configuration_id()
  jsii_get_property("attrConfigurationId")
end

#attr_configuration_revision ⇒ Numeric

The revision number of the configuration.

1

Returns:

  • (Numeric) 


269
270
271
 
# File 'amazon_mq/cfn_broker.rb', line 269

def attr_configuration_revision()
  jsii_get_property("attrConfigurationRevision")
end

#attr_console_ur_ls ⇒ Array<String>

Returns:

  • (Array<String>) 


274
275
276
 
# File 'amazon_mq/cfn_broker.rb', line 274

def attr_console_ur_ls()
  jsii_get_property("attrConsoleUrLs")
end

#attr_engine_version_current ⇒ String

The version in use.

This may have more precision than the specified EngineVersion.

Returns:

  • (String) 


283
284
285
 
# File 'amazon_mq/cfn_broker.rb', line 283

def attr_engine_version_current()
  jsii_get_property("attrEngineVersionCurrent")
end

#attr_id ⇒ String

Returns:

  • (String) 


288
289
290
 
# File 'amazon_mq/cfn_broker.rb', line 288

def attr_id()
  jsii_get_property("attrId")
end

#attr_ip_addresses ⇒ Array<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']

Returns:

  • (Array<String>) 


297
298
299
 
# File 'amazon_mq/cfn_broker.rb', line 297

def attr_ip_addresses()
  jsii_get_property("attrIpAddresses")
end

#attr_mqtt_endpoints ⇒ 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

Returns:

  • (Array<String>) 


306
307
308
 
# File 'amazon_mq/cfn_broker.rb', line 306

def attr_mqtt_endpoints()
  jsii_get_property("attrMqttEndpoints")
end

#attr_open_wire_endpoints ⇒ 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

Returns:

  • (Array<String>) 


315
316
317
 
# File 'amazon_mq/cfn_broker.rb', line 315

def attr_open_wire_endpoints()
  jsii_get_property("attrOpenWireEndpoints")
end

#attr_stomp_endpoints ⇒ 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

Returns:

  • (Array<String>) 


324
325
326
 
# File 'amazon_mq/cfn_broker.rb', line 324

def attr_stomp_endpoints()
  jsii_get_property("attrStompEndpoints")
end

#attr_wss_endpoints ⇒ 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

Returns:

  • (Array<String>) 


333
334
335
 
# File 'amazon_mq/cfn_broker.rb', line 333

def attr_wss_endpoints()
  jsii_get_property("attrWssEndpoints")
end

#authentication_strategy ⇒ String?

Optional.

Returns:

  • (String, nil) 


414
415
416
 
# File 'amazon_mq/cfn_broker.rb', line 414

def authentication_strategy()
  jsii_get_property("authenticationStrategy")
end

#authentication_strategy=(value) ⇒ Object 



418
419
420
421
 
# File 'amazon_mq/cfn_broker.rb', line 418

def authentication_strategy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationStrategy") unless value.nil?
  jsii_set_property("authenticationStrategy", value)
end

#auto_minor_version_upgrade ⇒ Boolean, ...

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

Returns:



426
427
428
 
# File 'amazon_mq/cfn_broker.rb', line 426

def auto_minor_version_upgrade()
  jsii_get_property("autoMinorVersionUpgrade")
end

#auto_minor_version_upgrade=(value) ⇒ Object 



430
431
432
433
 
# File 'amazon_mq/cfn_broker.rb', line 430

def auto_minor_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless value.nil?
  jsii_set_property("autoMinorVersionUpgrade", value)
end

#broker_name ⇒ String

Required.

Returns:

  • (String) 


354
355
356
 
# File 'amazon_mq/cfn_broker.rb', line 354

def broker_name()
  jsii_get_property("brokerName")
end

#broker_name=(value) ⇒ Object 



358
359
360
361
 
# File 'amazon_mq/cfn_broker.rb', line 358

def broker_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "brokerName")
  jsii_set_property("brokerName", value)
end

#broker_ref ⇒ AWSCDK::Interfaces::AWSAmazonmq::BrokerReference

A reference to a Broker resource.

Returns:



340
341
342
 
# File 'amazon_mq/cfn_broker.rb', line 340

def broker_ref()
  jsii_get_property("brokerRef")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



186
187
188
 
# File 'amazon_mq/cfn_broker.rb', line 186

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'amazon_mq/cfn_broker.rb', line 191

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


801
802
803
804
 
# File 'amazon_mq/cfn_broker.rb', line 801

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


196
197
198
 
# File 'amazon_mq/cfn_broker.rb', line 196

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


203
204
205
 
# File 'amazon_mq/cfn_broker.rb', line 203

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration ⇒ AWSCDK::IResolvable, ...

A list of information about the configuration.

Returns:



438
439
440
 
# File 'amazon_mq/cfn_broker.rb', line 438

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



442
443
444
445
446
 
# File 'amazon_mq/cfn_broker.rb', line 442

def configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::ConfigurationIdProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuQ29uZmlndXJhdGlvbklkUHJvcGVydHkifV19fQ==")), "configuration") unless value.nil?
  jsii_set_property("configuration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


148
149
150
 
# File 'amazon_mq/cfn_broker.rb', line 148

def creation_stack()
  jsii_get_property("creationStack")
end

#data_replication_mode ⇒ String?

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

Returns:

  • (String, nil) 


451
452
453
 
# File 'amazon_mq/cfn_broker.rb', line 451

def data_replication_mode()
  jsii_get_property("dataReplicationMode")
end

#data_replication_mode=(value) ⇒ Object 



455
456
457
458
 
# File 'amazon_mq/cfn_broker.rb', line 455

def data_replication_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataReplicationMode") unless value.nil?
  jsii_set_property("dataReplicationMode", value)
end

#data_replication_primary_broker_arn ⇒ 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.

Returns:

  • (String, nil) 


463
464
465
 
# File 'amazon_mq/cfn_broker.rb', line 463

def data_replication_primary_broker_arn()
  jsii_get_property("dataReplicationPrimaryBrokerArn")
end

#data_replication_primary_broker_arn=(value) ⇒ Object 



467
468
469
470
 
# File 'amazon_mq/cfn_broker.rb', line 467

def data_replication_primary_broker_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataReplicationPrimaryBrokerArn") unless value.nil?
  jsii_set_property("dataReplicationPrimaryBrokerArn", value)
end

#deployment_mode ⇒ String

Required.

Returns:

  • (String) 


366
367
368
 
# File 'amazon_mq/cfn_broker.rb', line 366

def deployment_mode()
  jsii_get_property("deploymentMode")
end

#deployment_mode=(value) ⇒ Object 



370
371
372
373
 
# File 'amazon_mq/cfn_broker.rb', line 370

def deployment_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentMode")
  jsii_set_property("deploymentMode", value)
end

#encryption_options ⇒ AWSCDK::IResolvable, ...

Encryption options for the broker.

Returns:



475
476
477
 
# File 'amazon_mq/cfn_broker.rb', line 475

def encryption_options()
  jsii_get_property("encryptionOptions")
end

#encryption_options=(value) ⇒ Object 



479
480
481
482
483
 
# File 'amazon_mq/cfn_broker.rb', line 479

def encryption_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::EncryptionOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuRW5jcnlwdGlvbk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "encryptionOptions") unless value.nil?
  jsii_set_property("encryptionOptions", value)
end

#engine_type ⇒ String

Required.

Returns:

  • (String) 


378
379
380
 
# File 'amazon_mq/cfn_broker.rb', line 378

def engine_type()
  jsii_get_property("engineType")
end

#engine_type=(value) ⇒ Object 



382
383
384
385
 
# File 'amazon_mq/cfn_broker.rb', line 382

def engine_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineType")
  jsii_set_property("engineType", value)
end

#engine_version ⇒ String?

The broker engine version.

Returns:

  • (String, nil) 


488
489
490
 
# File 'amazon_mq/cfn_broker.rb', line 488

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



492
493
494
495
 
# File 'amazon_mq/cfn_broker.rb', line 492

def engine_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless value.nil?
  jsii_set_property("engineVersion", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



208
209
210
 
# File 'amazon_mq/cfn_broker.rb', line 208

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



814
815
816
817
818
 
# File 'amazon_mq/cfn_broker.rb', line 814

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



825
826
827
828
 
# File 'amazon_mq/cfn_broker.rb', line 825

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#host_instance_type ⇒ String

Required.

Returns:

  • (String) 


390
391
392
 
# File 'amazon_mq/cfn_broker.rb', line 390

def host_instance_type()
  jsii_get_property("hostInstanceType")
end

#host_instance_type=(value) ⇒ Object 



394
395
396
397
 
# File 'amazon_mq/cfn_broker.rb', line 394

def host_instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostInstanceType")
  jsii_set_property("hostInstanceType", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



895
896
897
898
 
# File 'amazon_mq/cfn_broker.rb', line 895

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#ldap_server_metadata ⇒ AWSCDK::IResolvable, ...

Optional.

Returns:



500
501
502
 
# File 'amazon_mq/cfn_broker.rb', line 500

def ldap_server_metadata()
  jsii_get_property("ldapServerMetadata")
end

#ldap_server_metadata=(value) ⇒ Object 



504
505
506
507
508
 
# File 'amazon_mq/cfn_broker.rb', line 504

def ldap_server_metadata=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::LdapServerMetadataProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuTGRhcFNlcnZlck1ldGFkYXRhUHJvcGVydHkifV19fQ==")), "ldapServerMetadata") unless value.nil?
  jsii_set_property("ldapServerMetadata", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


160
161
162
 
# File 'amazon_mq/cfn_broker.rb', line 160

def logical_id()
  jsii_get_property("logicalId")
end

#logs ⇒ AWSCDK::IResolvable, ...

Enables Amazon CloudWatch logging for brokers.

Returns:



513
514
515
 
# File 'amazon_mq/cfn_broker.rb', line 513

def logs()
  jsii_get_property("logs")
end

#logs=(value) ⇒ Object 



517
518
519
520
521
 
# File 'amazon_mq/cfn_broker.rb', line 517

def logs=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::LogListProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuTG9nTGlzdFByb3BlcnR5In1dfX0=")), "logs") unless value.nil?
  jsii_set_property("logs", value)
end

#maintenance_window_start_time ⇒ AWSCDK::IResolvable, ...

The parameters that determine the WeeklyStartTime.

Returns:



526
527
528
 
# File 'amazon_mq/cfn_broker.rb', line 526

def maintenance_window_start_time()
  jsii_get_property("maintenanceWindowStartTime")
end

#maintenance_window_start_time=(value) ⇒ Object 



530
531
532
533
534
 
# File 'amazon_mq/cfn_broker.rb', line 530

def maintenance_window_start_time=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::MaintenanceWindowProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuTWFpbnRlbmFuY2VXaW5kb3dQcm9wZXJ0eSJ9XX19")), "maintenanceWindowStartTime") unless value.nil?
  jsii_set_property("maintenanceWindowStartTime", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


143
144
145
 
# File 'amazon_mq/cfn_broker.rb', line 143

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



836
837
838
 
# File 'amazon_mq/cfn_broker.rb', line 836

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



843
844
845
 
# File 'amazon_mq/cfn_broker.rb', line 843

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



636
637
638
639
 
# File 'amazon_mq/cfn_broker.rb', line 636

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#publicly_accessible ⇒ Boolean, AWSCDK::IResolvable

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

Returns:



402
403
404
 
# File 'amazon_mq/cfn_broker.rb', line 402

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



406
407
408
409
 
# File 'amazon_mq/cfn_broker.rb', line 406

def publicly_accessible=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible")
  jsii_set_property("publiclyAccessible", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


179
180
181
 
# File 'amazon_mq/cfn_broker.rb', line 179

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



854
855
856
857
 
# File 'amazon_mq/cfn_broker.rb', line 854

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


861
862
863
864
 
# File 'amazon_mq/cfn_broker.rb', line 861

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



871
872
873
874
875
 
# File 'amazon_mq/cfn_broker.rb', line 871

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resource_share_arns ⇒ Array<String>?

The ARNs of the resource shares to be associated with the broker.

Returns:

  • (Array<String>, nil) 


539
540
541
 
# File 'amazon_mq/cfn_broker.rb', line 539

def resource_share_arns()
  jsii_get_property("resourceShareArns")
end

#resource_share_arns=(value) ⇒ Object 



543
544
545
546
 
# File 'amazon_mq/cfn_broker.rb', line 543

def resource_share_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceShareArns") unless value.nil?
  jsii_set_property("resourceShareArns", value)
end

#security_groups ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


551
552
553
 
# File 'amazon_mq/cfn_broker.rb', line 551

def security_groups()
  jsii_get_property("securityGroups")
end

#security_groups=(value) ⇒ Object 



555
556
557
558
 
# File 'amazon_mq/cfn_broker.rb', line 555

def security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") unless value.nil?
  jsii_set_property("securityGroups", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



880
881
882
 
# File 'amazon_mq/cfn_broker.rb', line 880

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



169
170
171
 
# File 'amazon_mq/cfn_broker.rb', line 169

def stack()
  jsii_get_property("stack")
end

#storage_type ⇒ String?

The broker's storage type.

Returns:

  • (String, nil) 


563
564
565
 
# File 'amazon_mq/cfn_broker.rb', line 563

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



567
568
569
570
 
# File 'amazon_mq/cfn_broker.rb', line 567

def storage_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless value.nil?
  jsii_set_property("storageType", value)
end

#subnet_ids ⇒ Array<String>?

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Returns:

  • (Array<String>, nil) 


575
576
577
 
# File 'amazon_mq/cfn_broker.rb', line 575

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



579
580
581
582
 
# File 'amazon_mq/cfn_broker.rb', line 579

def subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") unless value.nil?
  jsii_set_property("subnetIds", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



347
348
349
 
# File 'amazon_mq/cfn_broker.rb', line 347

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::AmazonMQ::CfnBroker::TagsEntryProperty>?

Create tags when creating the broker.

Returns:



587
588
589
 
# File 'amazon_mq/cfn_broker.rb', line 587

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



591
592
593
594
595
 
# File 'amazon_mq/cfn_broker.rb', line 591

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnBroker::TagsEntryProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Ccm9rZXIuVGFnc0VudHJ5UHJvcGVydHkifSwia2luZCI6ImFycmF5In19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



612
613
614
 
# File 'amazon_mq/cfn_broker.rb', line 612

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


216
217
218
 
# File 'amazon_mq/cfn_broker.rb', line 216

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


226
227
228
 
# File 'amazon_mq/cfn_broker.rb', line 226

def updated_properties()
  jsii_get_property("updatedProperties")
end

#users ⇒ AWSCDK::IResolvable, ...

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

Returns:



600
601
602
 
# File 'amazon_mq/cfn_broker.rb', line 600

def users()
  jsii_get_property("users")
end

#users=(value) ⇒ Object 



604
605
606
607
 
# File 'amazon_mq/cfn_broker.rb', line 604

def users=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1hem9ubXEuQ2ZuQnJva2VyLlVzZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "users") unless value.nil?
  jsii_set_property("users", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


886
887
888
889
 
# File 'amazon_mq/cfn_broker.rb', line 886

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


625
626
627
628
629
630
 
# File 'amazon_mq/cfn_broker.rb', line 625

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end