Class: MintPress::Aws::RDS::DbProxy

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

Properties (Read/Write)

  • #db_proxy_name ⇒ [String]
    'The identifier for the DBProxy to modify.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'db_proxy_name'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • delete_db_proxy_prop ⇒ 'db_proxy_name'
    • describe_db_proxies_prop ⇒ 'db_proxy_name'
    • modify_db_proxy_prop ⇒ 'db_proxy_name'
    

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

property :db_proxy_name, create_db_proxy_prop: 'db_proxy_name', type: [String], read_only: false, source: "modify_db_proxy", description: 'The identifier for the DBProxy to modify.', delete_db_proxy_prop: 'db_proxy_name', describe_db_proxies_prop: 'db_proxy_name', modify_db_proxy_prop: 'db_proxy_name'
  • #engine_family ⇒ [String]
    'The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'engine_family'
    • read_only ⇒ false
    • source ⇒ "create_db_proxy"
    

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

property :engine_family, create_db_proxy_prop: 'engine_family', type: [String], read_only: false, source: "create_db_proxy", description: 'The kinds of databases that the proxy can connect to. This value
determines which database network protocol the proxy recognizes when
it interprets network traffic to and from the database. The engine
family applies to MySQL and PostgreSQL for both RDS and Aurora.'
  • #auth ⇒ Hash of ⇒ [MintPress::Aws::RDS::UserAuthConfig]
    'The new authentication settings for the DBProxy.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'auth'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • modify_db_proxy_prop ⇒ 'auth'
    

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

property :auth, create_db_proxy_prop: 'auth', type: [MintPress::Aws::RDS::UserAuthConfig], array: false, read_only: false, source: "modify_db_proxy", description: 'The new authentication settings for the DBProxy.', modify_db_proxy_prop: 'auth', hash: true
  • #role_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'role_arn'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • modify_db_proxy_prop ⇒ 'role_arn'
    

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

property :role_arn, create_db_proxy_prop: 'role_arn', type: [String], read_only: false, source: "modify_db_proxy", description: 'The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
access secrets in AWS Secrets Manager.', modify_db_proxy_prop: 'role_arn'
  • #require_tls ⇒ [TrueClass,FalseClass]
    'Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn"t use TLS.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'require_tls'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • modify_db_proxy_prop ⇒ 'require_tls'
    

34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_proxy.rb', line 34

property :require_tls, create_db_proxy_prop: 'require_tls', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_proxy", description: 'Whether Transport Layer Security (TLS) encryption is required for
connections to the proxy. By enabling this setting, you can enforce
encrypted TLS connections to the proxy, even if the associated
database doesn"t use TLS.', modify_db_proxy_prop: 'require_tls'
  • #idle_client_timeout ⇒ [Integer]
    'The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'idle_client_timeout'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • modify_db_proxy_prop ⇒ 'idle_client_timeout'
    

38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_proxy.rb', line 38

property :idle_client_timeout, create_db_proxy_prop: 'idle_client_timeout', type: [Integer], read_only: false, source: "modify_db_proxy", description: 'The number of seconds that a connection to the proxy can be inactive
before the proxy disconnects it. You can set this value higher or
lower than the connection timeout limit for the associated database.', modify_db_proxy_prop: 'idle_client_timeout'
  • #debug_logging ⇒ [TrueClass,FalseClass]
    'Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'debug_logging'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    • modify_db_proxy_prop ⇒ 'debug_logging'
    

41
42
43
44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_proxy.rb', line 41

property :debug_logging, create_db_proxy_prop: 'debug_logging', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_proxy", description: 'Whether the proxy includes detailed information about SQL statements
in its logs. This information helps you to debug issues involving SQL
behavior or the performance and scalability of the proxy connections.
The debug information includes the text of SQL statements that you
submit through the proxy. Thus, only enable this setting when needed
for debugging, and only when you have security measures in place to
safeguard any sensitive information that appears in the logs.', modify_db_proxy_prop: 'debug_logging'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_proxy"
    

48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_proxy.rb', line 48

property :tags, create_db_proxy_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_proxy", description: 'An optional set of key-value pairs to associate arbitrary data of your
choosing with the proxy.', hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter is not currently supported.'
    Property Attributes
    • describe_db_proxies_prop ⇒ 'filters'
    • source ⇒ "describe_db_proxies"
    

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

property :filters, describe_db_proxies_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_proxies", description: 'This parameter is not currently supported.', 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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_db_proxies_prop ⇒ 'max_records'
    • source ⇒ "describe_db_proxies"
    

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

property :max_records, describe_db_proxies_prop: 'max_records', type: [Integer], source: "describe_db_proxies", 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 the
remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #new_db_proxy_name ⇒ [String]
    'The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can"t end with a hyphen or contain two consecutive hyphens.'
    Property Attributes
    • modify_db_proxy_prop ⇒ 'new_db_proxy_name'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    

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

property :new_db_proxy_name, modify_db_proxy_prop: 'new_db_proxy_name', type: [String], read_only: false, source: "modify_db_proxy", description: 'The new identifier for the DBProxy. An identifier must begin with a
letter and must contain only ASCII letters, digits, and hyphens; it
can"t end with a hyphen or contain two consecutive hyphens.'
  • #security_groups ⇒ Array of ⇒ [String]
    'The new list of security groups for the DBProxy.'
    Property Attributes
    • modify_db_proxy_prop ⇒ 'security_groups'
    • read_only ⇒ false
    • source ⇒ "modify_db_proxy"
    

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

property :security_groups, modify_db_proxy_prop: 'security_groups', type: [String], array: true, read_only: false, source: "modify_db_proxy", description: 'The new list of security groups for the DBProxy.'
  • #vpc_subnets ⇒ Array of ⇒ [String]
    'One or more VPC subnet IDs to associate with the new proxy.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'vpc_subnet_ids'
    • read_only ⇒ false
    • source ⇒ "create_db_proxy"
    

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

property :vpc_subnets, create_db_proxy_prop: 'vpc_subnet_ids', type: [String], array: true, read_only: false, source: "create_db_proxy", description: 'One or more VPC subnet IDs to associate with the new proxy.'
  • #vpc_security_groups ⇒ Array of ⇒ [String]
    'One or more VPC security group IDs to associate with the new proxy.'
    Property Attributes
    • create_db_proxy_prop ⇒ 'vpc_security_group_ids'
    • read_only ⇒ false
    • source ⇒ "create_db_proxy"
    

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

property :vpc_security_groups, create_db_proxy_prop: 'vpc_security_group_ids', type: [String], array: true, read_only: false, source: "create_db_proxy", description: 'One or more VPC security group IDs to associate with the new proxy.'
  • #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 
    

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

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
    

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

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

Returns a new instance of DbProxy.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object