Class: MintPress::Aws::RDS::DbClusterEndpoint

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

Properties (Read/Write)

  • #db_cluster_identifier ⇒ [String]
    'The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'db_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "describe_db_cluster_endpoints"
    • describe_db_cluster_endpoints_prop ⇒ 'db_cluster_identifier'
    

25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 25

property :db_cluster_identifier, create_db_cluster_endpoint_prop: 'db_cluster_identifier', type: [String], read_only: false, source: "describe_db_cluster_endpoints", description: 'The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.', describe_db_cluster_endpoints_prop: 'db_cluster_identifier'
  • #db_cluster_endpoint_identifier ⇒ [String]
    'The identifier of the endpoint to modify. This parameter is stored as a lowercase string.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'db_cluster_endpoint_identifier'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster_endpoint"
    • delete_db_cluster_endpoint_prop ⇒ 'db_cluster_endpoint_identifier'
    • describe_db_cluster_endpoints_prop ⇒ 'db_cluster_endpoint_identifier'
    • modify_db_cluster_endpoint_prop ⇒ 'db_cluster_endpoint_identifier'
    

27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 27

property :db_cluster_endpoint_identifier, create_db_cluster_endpoint_prop: 'db_cluster_endpoint_identifier', type: [String], read_only: false, source: "modify_db_cluster_endpoint", description: 'The identifier of the endpoint to modify. This parameter is stored as
a lowercase string.', delete_db_cluster_endpoint_prop: 'db_cluster_endpoint_identifier', describe_db_cluster_endpoints_prop: 'db_cluster_endpoint_identifier', modify_db_cluster_endpoint_prop: 'db_cluster_endpoint_identifier'
  • #endpoint_type ⇒ [String]
    'The type of the endpoint. One of: READER, WRITER, ANY.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'endpoint_type'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster_endpoint"
    • modify_db_cluster_endpoint_prop ⇒ 'endpoint_type'
    

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

property :endpoint_type, create_db_cluster_endpoint_prop: 'endpoint_type', type: [String], read_only: false, source: "modify_db_cluster_endpoint", description: 'The type of the endpoint. One of: READER, WRITER, ANY.', modify_db_cluster_endpoint_prop: 'endpoint_type'
  • #static_members ⇒ Array of ⇒ [String]
    'List of DB instance identifiers that are part of the custom endpoint group.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'static_members'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster_endpoint"
    • modify_db_cluster_endpoint_prop ⇒ 'static_members'
    

30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 30

property :static_members, create_db_cluster_endpoint_prop: 'static_members', type: [String], array: true, read_only: false, source: "modify_db_cluster_endpoint", description: 'List of DB instance identifiers that are part of the custom endpoint
group.', modify_db_cluster_endpoint_prop: 'static_members'
  • #excluded_members ⇒ Array of ⇒ [String]
    'List of DB instance identifiers that aren"t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'excluded_members'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster_endpoint"
    • modify_db_cluster_endpoint_prop ⇒ 'excluded_members'
    

32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 32

property :excluded_members, create_db_cluster_endpoint_prop: 'excluded_members', type: [String], array: true, read_only: false, source: "modify_db_cluster_endpoint", description: 'List of DB instance identifiers that aren"t part of the custom
endpoint group. All other eligible instances are reachable through the
custom endpoint. Only relevant if the list of static members is empty.', modify_db_cluster_endpoint_prop: 'excluded_members'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'The tags to be assigned to the Amazon RDS resource.'
    Property Attributes
    • create_db_cluster_endpoint_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster_endpoint"
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 35

property :tags, create_db_cluster_endpoint_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_cluster_endpoint", description: 'The tags to be assigned to the Amazon RDS resource.', hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.'
    Property Attributes
    • describe_db_cluster_endpoints_prop ⇒ 'filters'
    • source ⇒ "describe_db_cluster_endpoints"
    

36
37
38
39
40
41
42
43
44
45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 36

property :filters, describe_db_cluster_endpoints_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_cluster_endpoints", description: 'A set of name-value pairs that define which endpoints to include in
the output. The filters are specified as name-value pairs, in the
format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
Name can be one of: db-cluster-endpoint-type,
db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the 
db-cluster-endpoint-type filter can be one or more of: reader,
writer, custom. Values for the db-cluster-endpoint-custom-type
filter can be one or more of: reader, any. Values for the
db-cluster-endpoint-status filter can be one or more of:
available, creating, deleting, inactive, modifying.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_db_cluster_endpoints_prop ⇒ 'max_records'
    • source ⇒ "describe_db_cluster_endpoints"
    

47
48
49
50
51
52
53
54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 47

property :max_records, describe_db_cluster_endpoints_prop: 'max_records', type: [Integer], source: "describe_db_cluster_endpoints", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so you can retrieve
the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #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 
    

58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 58

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
    

61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_endpoint.rb', line 61

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 = {}) ⇒ DbClusterEndpoint

Returns a new instance of DbClusterEndpoint.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object