Class: MintPress::Aws::EC2::DhcpOption

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

Properties (Read/Write)

  • #dhcp_configurations ⇒ Hash of ⇒ [MintPress::Aws::EC2::DhcpConfiguration]
    'A DHCP configuration option.'
    Property Attributes
    • source ⇒ "create_dhcp_options"
    • orig_name ⇒ 'dhcp_configurations'
    • create_dhcp_options_prop ⇒ 'dhcp_configurations'
    • read_only ⇒ false
    

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

property :dhcp_configurations, description: 'A DHCP configuration option.', source: "create_dhcp_options", orig_name: 'dhcp_configurations', type: [MintPress::Aws::EC2::DhcpConfiguration], array: false, create_dhcp_options_prop: 'dhcp_configurations', read_only: false, hash: true
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the DHCP option.'
    Property Attributes
    • source ⇒ "create_dhcp_options"
    • orig_name ⇒ 'tags'
    • create_dhcp_options_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to assign to the DHCP option.', source: "create_dhcp_options", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_dhcp_options_prop: 'tag_specifications', read_only: false, hash: 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
    • create_dhcp_options_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_dhcp_options"
    • delete_dhcp_options_prop ⇒ 'dry_run'
    • describe_dhcp_options_prop ⇒ 'dry_run'
    

26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/dhcp_option.rb', line 26

property :dry_run, create_dhcp_options_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_dhcp_options", 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.', delete_dhcp_options_prop: 'dry_run', describe_dhcp_options_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. dhcp-options-id - The ID of a DHCP options set. key - The key for one of the options (for example, domain-name). value - The value for one of the options. owner-id - The ID of the AWS account that owns the DHCP options set. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.'
    Property Attributes
    • describe_dhcp_options_prop ⇒ 'filters'
    • source ⇒ "describe_dhcp_options"
    

30
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/ec2/dhcp_option.rb', line 30

property :filters, describe_dhcp_options_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_dhcp_options", description: 'One or more filters.


dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the AWS account that owns the DHCP options
set.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
    Property Attributes
    • describe_dhcp_options_prop ⇒ 'max_results'
    • source ⇒ "describe_dhcp_options"
    

46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/dhcp_option.rb', line 46

property :max_results, describe_dhcp_options_prop: 'max_results', type: [Integer], source: "describe_dhcp_options", description: 'The maximum number of results to return with a single call. To
retrieve the remaining results, make another call with the returned
nextToken value.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_dhcp_options"
    • orig_name ⇒ 'dhcp_options_id'
    • delete_dhcp_options_prop ⇒ 'dhcp_options_id'
    • describe_dhcp_options_prop ⇒ 'dhcp_options_ids'
    • default ⇒ Proc.new { self.name }
    

49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/dhcp_option.rb', line 49

property :id, read_only: false, disposition: :attribute, description: 'The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.', source: "describe_dhcp_options", orig_name: 'dhcp_options_id', type: [String], delete_dhcp_options_prop: 'dhcp_options_id', array: false, hash: false, describe_dhcp_options_prop: 'dhcp_options_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

property :name, type: String
  • #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 
    

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

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
    

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

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #owner ⇒ [String]
    'The ID of the AWS account that owns the DHCP options set.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "DhcpOptions"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

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

property :owner, disposition: :read_only_attribute, description: 'The ID of the AWS account that owns the DHCP options set.', source: "DhcpOptions", orig_name: 'owner_id', type: [String], read_only: true

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

Returns a new instance of DhcpOption.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object