Class: AWSCDK::AmazonMQ::CfnConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
amazon_mq/cfn_configuration_props.rb

Overview

Properties for defining a CfnConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine_type:, name:, authentication_strategy: nil, data: nil, description: nil, engine_version: nil, tags: nil) ⇒ CfnConfigurationProps

Returns a new instance of CfnConfigurationProps.

Parameters:

  • engine_type (String) —

    Required.

  • name (String) —

    Required.

  • authentication_strategy (String, nil) (defaults to: nil) —

    Optional.

  • data (String, nil) (defaults to: nil) —

    Amazon MQ for Active MQ: The base64-encoded XML configuration.

  • description (String, nil) (defaults to: nil) —

    The description of the configuration.

  • engine_version (String, nil) (defaults to: nil) —

    The broker engine version.

  • tags (Array<AWSCDK::AmazonMQ::CfnConfiguration::TagsEntryProperty>, nil) (defaults to: nil) —

    Create tags when creating the configuration.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'amazon_mq/cfn_configuration_props.rb', line 16

def initialize(engine_type:, name:, authentication_strategy: nil, data: nil, description: nil, engine_version: nil, tags: nil)
  @engine_type = engine_type
  Jsii::Type.check_type(@engine_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineType")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @authentication_strategy = authentication_strategy
  Jsii::Type.check_type(@authentication_strategy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationStrategy") unless @authentication_strategy.nil?
  @data = data
  Jsii::Type.check_type(@data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "data") unless @data.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::AmazonMQ::CfnConfiguration::TagsEntryProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbWF6b25tcS5DZm5Db25maWd1cmF0aW9uLlRhZ3NFbnRyeVByb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#authentication_strategy ⇒ String? (readonly)

Optional.

The authentication strategy associated with the configuration. The default is SIMPLE .

Returns:

  • (String, nil)

See Also:



53
54
55
 
# File 'amazon_mq/cfn_configuration_props.rb', line 53

def authentication_strategy
  @authentication_strategy
end

#data ⇒ String? (readonly)

Amazon MQ for Active MQ: The base64-encoded XML configuration.

Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'amazon_mq/cfn_configuration_props.rb', line 60

def data
  @data
end

#description ⇒ String? (readonly)

The description of the configuration.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'amazon_mq/cfn_configuration_props.rb', line 65

def description
  @description
end

#engine_type ⇒ String (readonly)

Required.

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

Returns:

  • (String)

See Also:



39
40
41
 
# File 'amazon_mq/cfn_configuration_props.rb', line 39

def engine_type
  @engine_type
end

#engine_version ⇒ String? (readonly)

The broker engine version.

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.

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'amazon_mq/cfn_configuration_props.rb', line 72

def engine_version
  @engine_version
end

#name ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'amazon_mq/cfn_configuration_props.rb', line 46

def name
  @name
end

#tags ⇒ Array<AWSCDK::AmazonMQ::CfnConfiguration::TagsEntryProperty>? (readonly)

Create tags when creating the configuration.

Returns:

See Also:



77
78
79
 
# File 'amazon_mq/cfn_configuration_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'amazon_mq/cfn_configuration_props.rb', line 79

def self.jsii_properties
  {
    :engine_type => "engineType",
    :name => "name",
    :authentication_strategy => "authenticationStrategy",
    :data => "data",
    :description => "description",
    :engine_version => "engineVersion",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'amazon_mq/cfn_configuration_props.rb', line 91

def to_jsii
  result = {}
  result.merge!({
    "engineType" => @engine_type,
    "name" => @name,
    "authenticationStrategy" => @authentication_strategy,
    "data" => @data,
    "description" => @description,
    "engineVersion" => @engine_version,
    "tags" => @tags,
  })
  result.compact
end