Class: MintPress::Aws::ECS::AccountSetting

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

Properties (Read/Write)

  • #name ⇒ [String]
    'The name of the account setting you want to list the settings for.'
    Property Attributes
    • delete_account_setting_prop ⇒ 'name'
    • read_only ⇒ false
    • source ⇒ "list_account_settings"
    • list_account_settings_prop ⇒ 'name'
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/account_setting.rb', line 19

property :name, delete_account_setting_prop: 'name', type: [String], read_only: false, source: "list_account_settings", description: 'The name of the account setting you want to list the settings for.', list_account_settings_prop: 'name'
  • #principal_arn ⇒ [String]
    'The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.'
    Property Attributes
    • delete_account_setting_prop ⇒ 'principal_arn'
    • read_only ⇒ false
    • source ⇒ "list_account_settings"
    • list_account_settings_prop ⇒ 'principal_arn'
    

20
21
22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/account_setting.rb', line 20

property :principal_arn, delete_account_setting_prop: 'principal_arn', type: [String], read_only: false, source: "list_account_settings", description: 'The ARN of the principal, which can be an IAM user, IAM role, or the
root user. If this field is omitted, the account settings are listed
only for the authenticated user.', list_account_settings_prop: 'principal_arn'
  • #value ⇒ [String]
    'The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.'
    Property Attributes
    • list_account_settings_prop ⇒ 'value'
    • read_only ⇒ false
    • source ⇒ "list_account_settings"
    

23
24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/account_setting.rb', line 23

property :value, list_account_settings_prop: 'value', type: [String], read_only: false, source: "list_account_settings", description: 'The value of the account settings with which to filter results. You
must also specify an account setting name to use this parameter.'
  • #effective_settings ⇒ [TrueClass,FalseClass]
    'Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.'
    Property Attributes
    • list_account_settings_prop ⇒ 'effective_settings'
    • read_only ⇒ false
    • source ⇒ "list_account_settings"
    

25
26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/account_setting.rb', line 25

property :effective_settings, list_account_settings_prop: 'effective_settings', type: [TrueClass,FalseClass], read_only: false, source: "list_account_settings", description: 'Specifies whether to return the effective settings. If true, the
account settings for the root user or the default setting for the
principalArn are returned. If false, the account settings for the
principalArn are returned if they are set. Otherwise, no account
settings are returned.'
  • #max_results ⇒ [Integer]
    'The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.'
    Property Attributes
    • list_account_settings_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_account_settings"
    

30
31
32
33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/account_setting.rb', line 30

property :max_results, list_account_settings_prop: 'max_results', type: [Integer], read_only: false, source: "list_account_settings", description: 'The maximum number of account setting results returned by
ListAccountSettings in paginated output. When this parameter is
used, ListAccountSettings only returns maxResults results in a
single page along with a nextToken response element. The remaining
results of the initial request can be seen by sending another
ListAccountSettings request with the returned nextToken value.
This value can be between 1 and 10. If this parameter is not used,
then ListAccountSettings returns up to 10 results and a nextToken
value if applicable.'
  • #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 
    

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

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
    

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

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

Returns a new instance of AccountSetting.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#list ⇒ Object