Class: MintPress::Aws::Kafka::Cluster

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb

Properties (Read/Write)

  • #broker_node_group_info ⇒ [MintPress::Aws::Kafka::BrokerNodeGroupInfo] (Default Value: MintPress::Aws::Kafka::BrokerNodeGroupInfo.new)
    'Information about the broker nodes in the cluster.'
    Property Attributes
    • create_cluster_prop ⇒ 'broker_node_group_info'
    • default ⇒ MintPress::Aws::Kafka::BrokerNodeGroupInfo.new
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 29

property :broker_node_group_info, create_cluster_prop: 'broker_node_group_info', type: [MintPress::Aws::Kafka::BrokerNodeGroupInfo], default: MintPress::Aws::Kafka::BrokerNodeGroupInfo.new, read_only: false, source: "create_cluster", description: 'Information about the broker nodes in the cluster.'
  • #client_authentication ⇒ [MintPress::Aws::Kafka::ClientAuthentication] (Default Value: MintPress::Aws::Kafka::ClientAuthentication.new)
    'Includes all client authentication related information.'
    Property Attributes
    • create_cluster_prop ⇒ 'client_authentication'
    • default ⇒ MintPress::Aws::Kafka::ClientAuthentication.new
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 30

property :client_authentication, create_cluster_prop: 'client_authentication', type: [MintPress::Aws::Kafka::ClientAuthentication], default: MintPress::Aws::Kafka::ClientAuthentication.new, read_only: false, source: "create_cluster", description: 'Includes all client authentication related information.'
  • #cluster_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the cluster.'
    Property Attributes
    • create_cluster_prop ⇒ 'cluster_name'
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    • default ⇒ Proc.new { self.name }
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 31

property :cluster_name, create_cluster_prop: 'cluster_name', type: [String], read_only: false, source: "create_cluster", description: 'The name of the cluster.', default: Proc.new { self.name }
  • #configuration_info ⇒ [MintPress::Aws::Kafka::ConfigurationInfo] (Default Value: MintPress::Aws::Kafka::ConfigurationInfo.new)
    'Represents the configuration that you want MSK to use for the cluster.'
    Property Attributes
    • create_cluster_prop ⇒ 'configuration_info'
    • default ⇒ MintPress::Aws::Kafka::ConfigurationInfo.new
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 32

property :configuration_info, create_cluster_prop: 'configuration_info', type: [MintPress::Aws::Kafka::ConfigurationInfo], default: MintPress::Aws::Kafka::ConfigurationInfo.new, read_only: false, source: "create_cluster", description: 'Represents the configuration that you want MSK to use for the cluster.'
  • #encryption_info ⇒ [MintPress::Aws::Kafka::EncryptionInfo] (Default Value: MintPress::Aws::Kafka::EncryptionInfo.new)
    'Includes all encryption-related information.'
    Property Attributes
    • create_cluster_prop ⇒ 'encryption_info'
    • default ⇒ MintPress::Aws::Kafka::EncryptionInfo.new
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 33

property :encryption_info, create_cluster_prop: 'encryption_info', type: [MintPress::Aws::Kafka::EncryptionInfo], default: MintPress::Aws::Kafka::EncryptionInfo.new, read_only: false, source: "create_cluster", description: 'Includes all encryption-related information.'
  • #enhanced_monitoring ⇒ [String]
    'Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.'
    Property Attributes
    • create_cluster_prop ⇒ 'enhanced_monitoring'
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 34

property :enhanced_monitoring, create_cluster_prop: 'enhanced_monitoring', type: [String], read_only: false, source: "create_cluster", description: 'Specifies the level of monitoring for the MSK cluster. The possible
values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and
PER_TOPIC_PER_PARTITION.'
  • #kafka_version ⇒ [String]
    'The version of Apache Kafka.'
    Property Attributes
    • create_cluster_prop ⇒ 'kafka_version'
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 37

property :kafka_version, create_cluster_prop: 'kafka_version', type: [String], read_only: false, source: "create_cluster", description: 'The version of Apache Kafka.'
  • #logging_info ⇒ [MintPress::Aws::Kafka::BrokerLog]
    'LoggingInfo details.'
    Property Attributes
    • create_cluster_prop ⇒ "logging_info.broker_logs"
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 38

property :logging_info, create_cluster_prop: "logging_info.broker_logs", type: [MintPress::Aws::Kafka::BrokerLog], read_only: false, source: "create_cluster", description: 'LoggingInfo details.'
  • #number_of_broker_nodes ⇒ [Integer]
    'The number of Kafka broker nodes in the Amazon MSK cluster.'
    Property Attributes
    • create_cluster_prop ⇒ 'number_of_broker_nodes'
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 39

property :number_of_broker_nodes, create_cluster_prop: 'number_of_broker_nodes', type: [Integer], read_only: false, source: "create_cluster", description: 'The number of Kafka broker nodes in the Amazon MSK cluster.'
  • #open_monitoring ⇒ [MintPress::Aws::Kafka::PrometheusInfo]
    'The settings for open monitoring.'
    Property Attributes
    • create_cluster_prop ⇒ "open_monitoring.prometheus"
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 40

property :open_monitoring, create_cluster_prop: "open_monitoring.prometheus", type: [MintPress::Aws::Kafka::PrometheusInfo], read_only: false, source: "create_cluster", description: 'The settings for open monitoring.'
  • #tags ⇒ []
    'Create tags when creating the cluster.'
    Property Attributes
    • create_cluster_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_cluster"
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 41

property :tags, create_cluster_prop: 'tags', type: [], read_only: false, source: "create_cluster", description: 'Create tags when creating the cluster.'
  • #cluster_arn ⇒ [String]

    Property Attributes
    • delete_cluster_prop ⇒ 'cluster_arn'
    • read_only ⇒ false
    • source ⇒ "describe_cluster"
    • describe_cluster_prop ⇒ 'cluster_arn'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 42

property :cluster_arn, delete_cluster_prop: 'cluster_arn', type: [String], read_only: false, source: "describe_cluster", describe_cluster_prop: 'cluster_arn'
  • #current_version ⇒ [String]

    Property Attributes
    • delete_cluster_prop ⇒ 'current_version'
    • read_only ⇒ false
    • source ⇒ "delete_cluster"
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 43

property :current_version, delete_cluster_prop: 'current_version', type: [String], read_only: false, source: "delete_cluster"
  • #cluster_name_filter ⇒ [String]

    Property Attributes
    • list_clusters_prop ⇒ 'cluster_name_filter'
    • read_only ⇒ false
    • source ⇒ "list_clusters"
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 44

property :cluster_name_filter, list_clusters_prop: 'cluster_name_filter', type: [String], read_only: false, source: "list_clusters"
  • #max_results ⇒ [Integer]

    Property Attributes
    • list_clusters_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_clusters"
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 45

property :max_results, list_clusters_prop: 'max_results', type: [Integer], read_only: false, source: "list_clusters"
  • #name ⇒ [String]

    Property Attributes 
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 46

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 50

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/kafka/cluster.rb', line 53

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Cluster

Returns a new instance of Cluster.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object