Class: MintPress::Aws::RDS::GlobalCluster

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

Properties (Read/Write)

  • #database_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The default database name within the new global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'database_name'
    • create_global_cluster_prop ⇒ 'database_name'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

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

property :database_name, disposition: :attribute, description: 'The default database name within the new global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'database_name', type: [String], create_global_cluster_prop: 'database_name', read_only: false, default: Proc.new { self.name }
  • #deletion_protection ⇒ [TrueClass,FalseClass]
    'Indicates if the global database cluster has deletion protection enabled. The global database cluster can"t be deleted when deletion protection is enabled.'
    Property Attributes
    • source ⇒ "modify_global_cluster"
    • orig_name ⇒ 'deletion_protection'
    • create_global_cluster_prop ⇒ 'deletion_protection'
    • read_only ⇒ false
    • modify_global_cluster_prop ⇒ 'deletion_protection'
    

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

property :deletion_protection, description: 'Indicates if the global database cluster has deletion protection
enabled. The global database cluster can"t be deleted when deletion
protection is enabled.', source: "modify_global_cluster", orig_name: 'deletion_protection', type: [TrueClass,FalseClass], create_global_cluster_prop: 'deletion_protection', read_only: false, modify_global_cluster_prop: 'deletion_protection'
  • #engine ⇒ [String]
    'The Aurora database engine used by the global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'engine'
    • create_global_cluster_prop ⇒ 'engine'
    • read_only ⇒ false
    

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

property :engine, disposition: :attribute, description: 'The Aurora database engine used by the global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'engine', type: [String], create_global_cluster_prop: 'engine', read_only: false
  • #engine_version ⇒ [String]
    'Indicates the database engine version.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'engine_version'
    • create_global_cluster_prop ⇒ 'engine_version'
    • read_only ⇒ false
    

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

property :engine_version, disposition: :attribute, description: 'Indicates the database engine version.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'engine_version', type: [String], create_global_cluster_prop: 'engine_version', read_only: false
  • #global_cluster_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'global_cluster_arn'
    

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

property :global_cluster_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) for the global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'global_cluster_arn', type: [String]
  • #global_cluster_identifier ⇒ [String]
    'The DB cluster identifier for the global cluster being modified. This parameter isn"t case-sensitive. Constraints: Must match the identifier of an existing global database cluster. ^'
    Property Attributes
    • source ⇒ "modify_global_cluster"
    • orig_name ⇒ 'global_cluster_identifier'
    • create_global_cluster_prop ⇒ 'global_cluster_identifier'
    • read_only ⇒ false
    • delete_global_cluster_prop ⇒ 'global_cluster_identifier'
    • describe_global_clusters_prop ⇒ 'global_cluster_identifier'
    • modify_global_cluster_prop ⇒ 'global_cluster_identifier'
    

32
33
34
35
36
37
38
39
40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/global_cluster.rb', line 32

property :global_cluster_identifier, description: 'The DB cluster identifier for the global cluster being modified. This
parameter isn"t case-sensitive.

Constraints:


Must match the identifier of an existing global database cluster.



^', source: "modify_global_cluster", orig_name: 'global_cluster_identifier', type: [String], create_global_cluster_prop: 'global_cluster_identifier', read_only: false, delete_global_cluster_prop: 'global_cluster_identifier', describe_global_clusters_prop: 'global_cluster_identifier', modify_global_cluster_prop: 'global_cluster_identifier'
  • #global_cluster_members ⇒ Array of ⇒ [MintPress::Aws::RDS::GlobalClusterMember]
    'The list of cluster IDs for secondary clusters within the global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'global_cluster_members'
    

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

property :global_cluster_members, disposition: :attribute, description: 'The list of cluster IDs for secondary clusters within the global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'global_cluster_members', type: [MintPress::Aws::RDS::GlobalClusterMember], array: true
  • #status ⇒ [String]
    'Specifies the current state of this global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'Specifies the current state of this global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'status', type: [String]
  • #storage_encrypted ⇒ [TrueClass,FalseClass]
    'The storage encryption setting for the global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'storage_encrypted'
    • create_global_cluster_prop ⇒ 'storage_encrypted'
    • read_only ⇒ false
    

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

property :storage_encrypted, disposition: :attribute, description: 'The storage encryption setting for the global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'storage_encrypted', type: [TrueClass,FalseClass], create_global_cluster_prop: 'storage_encrypted', read_only: false
  • #source_db_cluster_identifier ⇒ [String]
    'The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.'
    Property Attributes
    • create_global_cluster_prop ⇒ 'source_db_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "create_global_cluster"
    

46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/global_cluster.rb', line 46

property :source_db_cluster_identifier, create_global_cluster_prop: 'source_db_cluster_identifier', type: [String], read_only: false, source: "create_global_cluster", description: 'The Amazon Resource Name (ARN) to use as the primary cluster of the
global database. This parameter is optional.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. ^'
    Property Attributes
    • describe_global_clusters_prop ⇒ 'filters'
    • source ⇒ "describe_global_clusters"
    

48
49
50
51
52
53
54
55
56
57
58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/global_cluster.rb', line 48

property :filters, describe_global_clusters_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_global_clusters", description: 'A filter that specifies one or more global DB clusters to describe.

Supported filters:


db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs). The results list will only include
information about the DB clusters identified by these ARNs.



^', 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 that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_global_clusters_prop ⇒ 'max_records'
    • source ⇒ "describe_global_clusters"
    

60
61
62
63
64
65
66
67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/global_cluster.rb', line 60

property :max_records, describe_global_clusters_prop: 'max_records', type: [Integer], source: "describe_global_clusters", 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 that you can
retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #new_global_cluster_identifier ⇒ [String]
    'The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can"t end with a hyphen or contain two consecutive hyphens Example: my-cluster2'
    Property Attributes
    • modify_global_cluster_prop ⇒ 'new_global_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "modify_global_cluster"
    

68
69
70
71
72
73
74
75
76
77
78
79
80
81
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/global_cluster.rb', line 68

property :new_global_cluster_identifier, modify_global_cluster_prop: 'new_global_cluster_identifier', type: [String], read_only: false, source: "modify_global_cluster", description: 'The new cluster identifier for the global database cluster when
modifying a global database cluster. This value is stored as a
lowercase string.

Constraints:


Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can"t end with a hyphen or contain two consecutive hyphens



Example: my-cluster2'
  • #global_cluster_resource ⇒ [String]
    'The AWS Region-unique, immutable identifier for the global database cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::GlobalCluster"
    • orig_name ⇒ 'global_cluster_resource_id'
    

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

property :global_cluster_resource, disposition: :attribute, description: 'The AWS Region-unique, immutable identifier for the global database cluster.', source: "MintPress::Aws::RDS::GlobalCluster", orig_name: 'global_cluster_resource_id', type: [String]
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of GlobalCluster.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object