Class: MintPress::Aws::RDS::DbClusterBacktrack

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

Properties (Read/Write)

  • #db_cluster_identifier ⇒ [String]
    'The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Can"t end with a hyphen or contain two consecutive hyphens. Example: my-cluster1'

    Property Attributes
    • describe_db_cluster_backtracks_prop'db_cluster_identifier'
    • source"describe_db_cluster_backtracks"
    
    
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 18
    
    property :db_cluster_identifier, describe_db_cluster_backtracks_prop: 'db_cluster_identifier', type: [String], source: "describe_db_cluster_backtracks", description: 'The DB cluster identifier of the DB cluster to be described. This
    parameter is stored as a lowercase string.
    
    Constraints:
    
    
    Must contain from 1 to 63 alphanumeric characters or hyphens.
    First character must be a letter.
    Can"t end with a hyphen or contain two consecutive hyphens.
    
    
    
    Example: my-cluster1'
  • #backtrack_identifier ⇒ [String]
    'If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace. ^ Example: 123e4567-e89b-12d3-a456-426655440000'

    Property Attributes
    • describe_db_cluster_backtracks_prop'backtrack_identifier'
    • source"describe_db_cluster_backtracks"
    
    
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 31
    
    property :backtrack_identifier, describe_db_cluster_backtracks_prop: 'backtrack_identifier', type: [String], source: "describe_db_cluster_backtracks", description: 'If specified, this value is the backtrack identifier of the backtrack
    to be described.
    
    Constraints:
    
    
    Must contain a valid universally unique identifier (UUID). For more
    information about UUIDs, see A Universally Unique Identifier (UUID)
    URN Namespace.
    
    
    
    ^
    
    Example: 123e4567-e89b-12d3-a456-426655440000'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies one or more DB clusters to describe. Supported filters include the following: db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. db-cluster-backtrack-status - Accepts any of the following backtrack status values: applying completed failed pending The results list includes information about only the backtracks identified by these values.'

    Property Attributes
    • describe_db_cluster_backtracks_prop'filters'
    • source"describe_db_cluster_backtracks"
    
    
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 46
    
    property :filters, describe_db_cluster_backtracks_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_cluster_backtracks", description: 'A filter that specifies one or more DB clusters to describe. Supported
    filters include the following:
    
    
    db-cluster-backtrack-id - Accepts backtrack identifiers. The
    results list includes information about only the backtracks
    identified by these identifiers.
    db-cluster-backtrack-status - Accepts any of the following
    backtrack status values:
    
    
    applying
    completed
    failed
    pending
    
    
    
    The results list includes information about only the backtracks
    identified by these values.', 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_backtracks_prop'max_records'
    • source"describe_db_cluster_backtracks"
    
    
    66
    67
    68
    69
    70
    71
    72
    73
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 66
    
    property :max_records, describe_db_cluster_backtracks_prop: 'max_records', type: [Integer], source: "describe_db_cluster_backtracks", 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
    
    
    77
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 77
    
    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
    • defaultMintPress::InfrastructureAws::AwsPlatform.new
    
    
    80
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster_backtrack.rb', line 80
    
    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 = {}) ⇒ DbClusterBacktrack

Returns a new instance of DbClusterBacktrack.

Instance Method Details

#describeObject