Class: MintPress::Aws::EC2::PlacementGroup

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

Properties (Read/Write)

  • #group_name ⇒ [String]
    'A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters'
    Property Attributes
    • source ⇒ "create_placement_group"
    • orig_name ⇒ 'group_name'
    • create_placement_group_prop ⇒ 'group_name'
    • read_only ⇒ false
    • delete_placement_group_prop ⇒ 'group_name'
    

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

property :group_name, description: 'A name for the placement group. Must be unique within the scope of
your account for the Region.

Constraints: Up to 255 ASCII characters', source: "create_placement_group", orig_name: 'group_name', type: [String], create_placement_group_prop: 'group_name', read_only: false, delete_placement_group_prop: 'group_name'
  • #partition_count ⇒ [Integer]
    'The number of partitions. Valid only when Strategy is set to partition.'
    Property Attributes
    • source ⇒ "create_placement_group"
    • orig_name ⇒ 'partition_count'
    • create_placement_group_prop ⇒ 'partition_count'
    • read_only ⇒ false
    

29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/placement_group.rb', line 29

property :partition_count, description: 'The number of partitions. Valid only when Strategy is set to
partition.', source: "create_placement_group", orig_name: 'partition_count', type: [Integer], create_placement_group_prop: 'partition_count', read_only: false
  • #strategy ⇒ [String]
    'The placement strategy.'
    Property Attributes
    • source ⇒ "create_placement_group"
    • orig_name ⇒ 'strategy'
    • create_placement_group_prop ⇒ 'strategy'
    • read_only ⇒ false
    

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

property :strategy, description: 'The placement strategy.', source: "create_placement_group", orig_name: 'strategy', type: [String], create_placement_group_prop: 'strategy', read_only: false
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply to the new placement group.'
    Property Attributes
    • source ⇒ "create_placement_group"
    • orig_name ⇒ 'tags'
    • create_placement_group_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to apply to the new placement group.', source: "create_placement_group", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_placement_group_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_placement_group_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_placement_group"
    • delete_placement_group_prop ⇒ 'dry_run'
    • describe_placement_groups_prop ⇒ 'dry_run'
    

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

property :dry_run, create_placement_group_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_placement_group", 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_placement_group_prop: 'dry_run', describe_placement_groups_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. group-name - The name of the placement group. state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition). 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 that have a tag with a specific key, regardless of the tag value.'
    Property Attributes
    • describe_placement_groups_prop ⇒ 'filters'
    • source ⇒ "describe_placement_groups"
    

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/placement_group.rb', line 38

property :filters, describe_placement_groups_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_placement_groups", description: 'The filters.


group-name - The name of the placement group.
state - The state of the placement group (pending | available
| deleting | deleted).
strategy - The strategy of the placement group (cluster |
spread | partition).
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 that have a tag with a specific key,
regardless of the tag value.', hash: true
  • #group_names ⇒ Array of ⇒ [String]
    'The names of the placement groups. Default: Describes all your placement groups, or only those otherwise specified.'
    Property Attributes
    • describe_placement_groups_prop ⇒ 'group_names'
    • source ⇒ "describe_placement_groups"
    

54
55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/placement_group.rb', line 54

property :group_names, describe_placement_groups_prop: 'group_names', type: [String], array: true, source: "describe_placement_groups", description: 'The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise
specified.'
  • #instances ⇒ Hash of ⇒ [MintPress::Aws::EC2::Instance]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "PlacementGroup"
    • orig_name ⇒ 'instances'
    

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

property :instances, disposition: :association, source: "PlacementGroup", orig_name: 'instances', type: [MintPress::Aws::EC2::Instance], array: false, hash: true
  • #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 
    

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

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
    

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

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

Properties (Read Only)

  • #state ⇒ [String]
    'The state of the placement group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "PlacementGroup"
    • orig_name ⇒ 'state'
    • read_only ⇒ true
    

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

property :state, disposition: :read_only_attribute, description: 'The state of the placement group.', source: "PlacementGroup", orig_name: 'state', type: [String], read_only: true
  • #name ⇒ [String]
    '(also: #group_name)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "PlacementGroup"
    • orig_name ⇒ 'name'
    

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

property :name, read_only: true, disposition: :read_only_attribute, description: '(also: #group_name)', source: "PlacementGroup", orig_name: 'name', type: [String]
  • #id ⇒ [String]
    'The IDs of the placement groups.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "describe_placement_groups"
    • orig_name ⇒ 'group_id'
    • read_only ⇒ true
    • describe_placement_groups_prop ⇒ 'group_ids'
    

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

property :id, disposition: :read_only_attribute, description: 'The IDs of the placement groups.', source: "describe_placement_groups", orig_name: 'group_id', type: [String], read_only: true, array: false, hash: false, describe_placement_groups_prop: 'group_ids'

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

Returns a new instance of PlacementGroup.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object