Class: MintPress::Aws::EC2::IdentityIdFormat

Inherits:

Object

• Object
• MintPress::Aws::EC2::IdentityIdFormat

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_id_format.rb

Properties (Read/Write)

• #principal_arn ⇒ [String]
  'The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
  Property Attributes
  • describe_identity_id_format_prop ⇒ 'principal_arn'
  • source ⇒ "modify_identity_id_format"
  • modify_identity_id_format_prop ⇒ 'principal_arn'
  • read_only ⇒ false

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_id_format.rb', line 19
  
  property :principal_arn, describe_identity_id_format_prop: 'principal_arn', type: [String], source: "modify_identity_id_format", description: 'The ARN of the principal, which can be an IAM user, IAM role, or the
  root user. Specify all to modify the ID format for all IAM users,
  IAM roles, and the root user of the account.', modify_identity_id_format_prop: 'principal_arn', read_only: false

• #resource ⇒ [String]
  'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.'
  Property Attributes
  • describe_identity_id_format_prop ⇒ 'resource'
  • source ⇒ "modify_identity_id_format"
  • modify_identity_id_format_prop ⇒ 'resource'
  • read_only ⇒ false

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_id_format.rb', line 22
  
  property :resource, describe_identity_id_format_prop: 'resource', type: [String], source: "modify_identity_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 | internet-gateway | network-acl |
  network-acl-association | network-interface |
  network-interface-attachment | prefix-list | route-table |
  route-table-association | security-group | subnet |
  subnet-cidr-block-association | vpc |
  vpc-cidr-block-association | vpc-endpoint |
  vpc-peering-connection | vpn-connection | vpn-gateway.
  
  Alternatively, use the all-current option to include all resource
  types that are currently within their opt-in period for longer IDs.', modify_identity_id_format_prop: 'resource', read_only: false

• #use_longs ⇒ [TrueClass,FalseClass]
  'Indicates whether the resource should use longer IDs (17-character IDs)'
  Property Attributes
  • modify_identity_id_format_prop ⇒ 'use_long_ids'
  • read_only ⇒ false
  • source ⇒ "modify_identity_id_format"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_id_format.rb', line 35
  
  property :use_longs, modify_identity_id_format_prop: 'use_long_ids', type: [TrueClass,FalseClass], read_only: false, source: "modify_identity_id_format", description: 'Indicates whether the resource should use longer IDs (17-character
  IDs)'

• #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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_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

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/identity_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

• #describe ⇒ Object
• #initialize(opts = {}) ⇒ IdentityIdFormat constructor
  A new instance of IdentityIdFormat.
• #modify ⇒ Object

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

Returns a new instance of IdentityIdFormat.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object