Class: MintPress::Aws::EC2::PrincipalIdFormat

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

Properties (Read/Write)

  • #arn ⇒ [String]
    'PrincipalIdFormatARN description.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::PrincipalIdFormat"
    • orig_name ⇒ 'arn'
    

18
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/principal_id_format.rb', line 18

property :arn, disposition: :attribute, description: 'PrincipalIdFormatARN description.', source: "MintPress::Aws::EC2::PrincipalIdFormat", orig_name: 'arn', type: [String]
  • #statuses ⇒ Array of ⇒ [MintPress::Aws::EC2::IdFormat]
    'PrincipalIdFormatStatuses description.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::PrincipalIdFormat"
    • orig_name ⇒ 'statuses'
    

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

property :statuses, disposition: :attribute, description: 'PrincipalIdFormatStatuses description.', source: "MintPress::Aws::EC2::PrincipalIdFormat", orig_name: 'statuses', type: [MintPress::Aws::EC2::IdFormat], array: true
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • describe_principal_id_format_prop ⇒ 'dry_run'
    • source ⇒ "describe_principal_id_format"
    

20
21
22
23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/principal_id_format.rb', line 20

property :dry_run, describe_principal_id_format_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_principal_id_format", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
  • #resources ⇒ Array of ⇒ [String] (Default Value: Proc.new { [self.parent.id] })
    'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway'
    Property Attributes
    • describe_principal_id_format_prop ⇒ 'resources'
    • source ⇒ "describe_principal_id_format"
    • default ⇒ Proc.new { [self.parent.id] }
    

24
25
26
27
28
29
30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/principal_id_format.rb', line 24

property :resources, describe_principal_id_format_prop: 'resources', type: [String], array: true, source: "describe_principal_id_format", description: 'The type of resource: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface |
network-interface-attachment | prefix-list | reservation |
route-table | route-table-association | security-group |
snapshot | subnet | subnet-cidr-block-association | volume
| vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway', default: Proc.new { [self.parent.id] }
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.'
    Property Attributes
    • describe_principal_id_format_prop ⇒ 'max_results'
    • source ⇒ "describe_principal_id_format"
    

34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/principal_id_format.rb', line 34

property :max_results, describe_principal_id_format_prop: 'max_results', type: [Integer], source: "describe_principal_id_format", description: 'The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned NextToken
value.'
  • #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 
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/principal_id_format.rb', line 40

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
    

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

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

Returns a new instance of PrincipalIdFormat.

Instance Method Details

#describe ⇒ Object