Class: MintPress::Aws::EC2::Tag

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

Properties (Read/Write)

  • #key ⇒ [String] (Default Value: Proc.new { self.name })
    'The key of the tag.'

    Property Attributes
    • disposition:attribute
    • source"MintPress::Aws::EC2::Tag"
    • orig_name'key'
    • create_capacity_reservation_prop'tags.key'
    • create_carrier_gateway_prop'tags.key'
    • create_client_vpn_endpoint_prop'tags.key'
    • create_customer_gateway_prop'tags.key'
    • create_dhcp_options_prop'tags.key'
    • create_egress_only_internet_gateway_prop'tags.key'
    • create_fleet_prop'tags.key'
    • create_flow_logs_prop'tags.key'
    • create_fpga_image_prop'tags.key'
    • create_image_prop'tags.key'
    • create_instance_export_task_prop'tags.key'
    • create_internet_gateway_prop'tags.key'
    • create_key_pair_prop'tags.key'
    • create_launch_template_prop'tags.key'
    • create_launch_template_version_prop'key'
    • create_local_gateway_route_table_vpc_association_prop'tags.key'
    • create_managed_prefix_list_prop'tags.key'
    • create_nat_gateway_prop'tags.key'
    • create_network_acl_prop'tags.key'
    • create_network_insights_path_prop'tags.key'
    • create_network_interface_prop'tags.key'
    • create_placement_group_prop'tags.key'
    • create_route_table_prop'tags.key'
    • create_security_group_prop'tags.key'
    • create_snapshot_prop'tags.key'
    • create_snapshots_prop'tags.key'
    • create_subnet_prop'tags.key'
    • create_tags_prop'tags.key'
    • create_traffic_mirror_filter_prop'tags.key'
    • create_traffic_mirror_session_prop'tags.key'
    • create_traffic_mirror_target_prop'tags.key'
    • create_transit_gateway_prop'tags.key'
    • create_transit_gateway_connect_prop'tags.key'
    • create_transit_gateway_connect_peer_prop'tags.key'
    • create_transit_gateway_multicast_domain_prop'tags.key'
    • create_transit_gateway_peering_attachment_prop'tags.key'
    • create_transit_gateway_route_table_prop'tags.key'
    • create_transit_gateway_vpc_attachment_prop'tags.key'
    • create_volume_prop'tags.key'
    • create_vpc_prop'tags.key'
    • create_vpc_endpoint_prop'tags.key'
    • create_vpc_endpoint_service_configuration_prop'tags.key'
    • create_vpc_peering_connection_prop'tags.key'
    • create_vpn_connection_prop'tags.key'
    • create_vpn_gateway_prop'tags.key'
    • delete_tags_prop'tags.key'
    • purchase_host_reservation_prop'tags.key'
    • start_network_insights_analysis_prop'tags.key'
    • create_instances_prop'tags.key'
    • defaultProc.new { self.name }
    
    
    22
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 22
    
    property :key, disposition: :attribute, description: 'The key of the tag.', source: "MintPress::Aws::EC2::Tag", orig_name: 'key', type: [String], create_capacity_reservation_prop: 'tags.key', create_carrier_gateway_prop: 'tags.key', create_client_vpn_endpoint_prop: 'tags.key', create_customer_gateway_prop: 'tags.key', create_dhcp_options_prop: 'tags.key', create_egress_only_internet_gateway_prop: 'tags.key', create_fleet_prop: 'tags.key', create_flow_logs_prop: 'tags.key', create_fpga_image_prop: 'tags.key', create_image_prop: 'tags.key', create_instance_export_task_prop: 'tags.key', create_internet_gateway_prop: 'tags.key', create_key_pair_prop: 'tags.key', create_launch_template_prop: 'tags.key', create_launch_template_version_prop: 'key', create_local_gateway_route_table_vpc_association_prop: 'tags.key', create_managed_prefix_list_prop: 'tags.key', create_nat_gateway_prop: 'tags.key', create_network_acl_prop: 'tags.key', create_network_insights_path_prop: 'tags.key', create_network_interface_prop: 'tags.key', create_placement_group_prop: 'tags.key', create_route_table_prop: 'tags.key', create_security_group_prop: 'tags.key', create_snapshot_prop: 'tags.key', create_snapshots_prop: 'tags.key', create_subnet_prop: 'tags.key', create_tags_prop: 'tags.key', create_traffic_mirror_filter_prop: 'tags.key', create_traffic_mirror_session_prop: 'tags.key', create_traffic_mirror_target_prop: 'tags.key', create_transit_gateway_prop: 'tags.key', create_transit_gateway_connect_prop: 'tags.key', create_transit_gateway_connect_peer_prop: 'tags.key', create_transit_gateway_multicast_domain_prop: 'tags.key', create_transit_gateway_peering_attachment_prop: 'tags.key', create_transit_gateway_route_table_prop: 'tags.key', create_transit_gateway_vpc_attachment_prop: 'tags.key', create_volume_prop: 'tags.key', create_vpc_prop: 'tags.key', create_vpc_endpoint_prop: 'tags.key', create_vpc_endpoint_service_configuration_prop: 'tags.key', create_vpc_peering_connection_prop: 'tags.key', create_vpn_connection_prop: 'tags.key', create_vpn_gateway_prop: 'tags.key', delete_tags_prop: 'tags.key', purchase_host_reservation_prop: 'tags.key', start_network_insights_analysis_prop: 'tags.key', create_instances_prop: 'tags.key', default: Proc.new { self.name }
  • #value ⇒ [String]
    'The value of the tag.'

    Property Attributes
    • disposition:attribute
    • source"MintPress::Aws::EC2::Tag"
    • orig_name'value'
    • create_capacity_reservation_prop'tags.value'
    • create_carrier_gateway_prop'tags.value'
    • create_client_vpn_endpoint_prop'tags.value'
    • create_customer_gateway_prop'tags.value'
    • create_dhcp_options_prop'tags.value'
    • create_egress_only_internet_gateway_prop'tags.value'
    • create_fleet_prop'tags.value'
    • create_flow_logs_prop'tags.value'
    • create_fpga_image_prop'tags.value'
    • create_image_prop'tags.value'
    • create_instance_export_task_prop'tags.value'
    • create_internet_gateway_prop'tags.value'
    • create_key_pair_prop'tags.value'
    • create_launch_template_prop'tags.value'
    • create_launch_template_version_prop'value'
    • create_local_gateway_route_table_vpc_association_prop'tags.value'
    • create_managed_prefix_list_prop'tags.value'
    • create_nat_gateway_prop'tags.value'
    • create_network_acl_prop'tags.value'
    • create_network_insights_path_prop'tags.value'
    • create_network_interface_prop'tags.value'
    • create_placement_group_prop'tags.value'
    • create_route_table_prop'tags.value'
    • create_security_group_prop'tags.value'
    • create_snapshot_prop'tags.value'
    • create_snapshots_prop'tags.value'
    • create_subnet_prop'tags.value'
    • create_tags_prop'tags.value'
    • create_traffic_mirror_filter_prop'tags.value'
    • create_traffic_mirror_session_prop'tags.value'
    • create_traffic_mirror_target_prop'tags.value'
    • create_transit_gateway_prop'tags.value'
    • create_transit_gateway_connect_prop'tags.value'
    • create_transit_gateway_connect_peer_prop'tags.value'
    • create_transit_gateway_multicast_domain_prop'tags.value'
    • create_transit_gateway_peering_attachment_prop'tags.value'
    • create_transit_gateway_route_table_prop'tags.value'
    • create_transit_gateway_vpc_attachment_prop'tags.value'
    • create_volume_prop'tags.value'
    • create_vpc_prop'tags.value'
    • create_vpc_endpoint_prop'tags.value'
    • create_vpc_endpoint_service_configuration_prop'tags.value'
    • create_vpc_peering_connection_prop'tags.value'
    • create_vpn_connection_prop'tags.value'
    • create_vpn_gateway_prop'tags.value'
    • delete_tags_prop'tags.value'
    • purchase_host_reservation_prop'tags.value'
    • start_network_insights_analysis_prop'tags.value'
    • create_instances_prop'tags.value'
    
    
    23
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 23
    
    property :value, disposition: :attribute, description: 'The value of the tag.', source: "MintPress::Aws::EC2::Tag", orig_name: 'value', type: [String], create_capacity_reservation_prop: 'tags.value', create_carrier_gateway_prop: 'tags.value', create_client_vpn_endpoint_prop: 'tags.value', create_customer_gateway_prop: 'tags.value', create_dhcp_options_prop: 'tags.value', create_egress_only_internet_gateway_prop: 'tags.value', create_fleet_prop: 'tags.value', create_flow_logs_prop: 'tags.value', create_fpga_image_prop: 'tags.value', create_image_prop: 'tags.value', create_instance_export_task_prop: 'tags.value', create_internet_gateway_prop: 'tags.value', create_key_pair_prop: 'tags.value', create_launch_template_prop: 'tags.value', create_launch_template_version_prop: 'value', create_local_gateway_route_table_vpc_association_prop: 'tags.value', create_managed_prefix_list_prop: 'tags.value', create_nat_gateway_prop: 'tags.value', create_network_acl_prop: 'tags.value', create_network_insights_path_prop: 'tags.value', create_network_interface_prop: 'tags.value', create_placement_group_prop: 'tags.value', create_route_table_prop: 'tags.value', create_security_group_prop: 'tags.value', create_snapshot_prop: 'tags.value', create_snapshots_prop: 'tags.value', create_subnet_prop: 'tags.value', create_tags_prop: 'tags.value', create_traffic_mirror_filter_prop: 'tags.value', create_traffic_mirror_session_prop: 'tags.value', create_traffic_mirror_target_prop: 'tags.value', create_transit_gateway_prop: 'tags.value', create_transit_gateway_connect_prop: 'tags.value', create_transit_gateway_connect_peer_prop: 'tags.value', create_transit_gateway_multicast_domain_prop: 'tags.value', create_transit_gateway_peering_attachment_prop: 'tags.value', create_transit_gateway_route_table_prop: 'tags.value', create_transit_gateway_vpc_attachment_prop: 'tags.value', create_volume_prop: 'tags.value', create_vpc_prop: 'tags.value', create_vpc_endpoint_prop: 'tags.value', create_vpc_endpoint_service_configuration_prop: 'tags.value', create_vpc_peering_connection_prop: 'tags.value', create_vpn_connection_prop: 'tags.value', create_vpn_gateway_prop: 'tags.value', delete_tags_prop: 'tags.value', purchase_host_reservation_prop: 'tags.value', start_network_insights_analysis_prop: 'tags.value', create_instances_prop: 'tags.value'
  • #resource_type ⇒ [String]
    'The type of resource to tag.'

    Property Attributes
    • disposition:attribute
    • source"MintPress::Aws::EC2::Tag"
    • orig_name'resource_type'
    • create_capacity_reservation_prop'resource_type'
    • create_carrier_gateway_prop'resource_type'
    • create_client_vpn_endpoint_prop'resource_type'
    • create_customer_gateway_prop'resource_type'
    • create_dhcp_options_prop'resource_type'
    • create_egress_only_internet_gateway_prop'resource_type'
    • create_fleet_prop'resource_type'
    • create_flow_logs_prop'resource_type'
    • create_fpga_image_prop'resource_type'
    • create_image_prop'resource_type'
    • create_instance_export_task_prop'resource_type'
    • create_internet_gateway_prop'resource_type'
    • create_key_pair_prop'resource_type'
    • create_launch_template_prop'resource_type'
    • create_local_gateway_route_table_vpc_association_prop'resource_type'
    • create_managed_prefix_list_prop'resource_type'
    • create_nat_gateway_prop'resource_type'
    • create_network_acl_prop'resource_type'
    • create_network_insights_path_prop'resource_type'
    • create_network_interface_prop'resource_type'
    • create_placement_group_prop'resource_type'
    • create_route_table_prop'resource_type'
    • create_security_group_prop'resource_type'
    • create_snapshot_prop'resource_type'
    • create_snapshots_prop'resource_type'
    • create_subnet_prop'resource_type'
    • create_traffic_mirror_filter_prop'resource_type'
    • create_traffic_mirror_session_prop'resource_type'
    • create_traffic_mirror_target_prop'resource_type'
    • create_transit_gateway_prop'resource_type'
    • create_transit_gateway_connect_prop'resource_type'
    • create_transit_gateway_connect_peer_prop'resource_type'
    • create_transit_gateway_multicast_domain_prop'resource_type'
    • create_transit_gateway_peering_attachment_prop'resource_type'
    • create_transit_gateway_route_table_prop'resource_type'
    • create_transit_gateway_vpc_attachment_prop'resource_type'
    • create_volume_prop'resource_type'
    • create_vpc_prop'resource_type'
    • create_vpc_endpoint_prop'resource_type'
    • create_vpc_endpoint_service_configuration_prop'resource_type'
    • create_vpc_peering_connection_prop'resource_type'
    • create_vpn_connection_prop'resource_type'
    • create_vpn_gateway_prop'resource_type'
    • purchase_host_reservation_prop'resource_type'
    • start_network_insights_analysis_prop'resource_type'
    • create_instances_prop'resource_type'
    
    
    24
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 24
    
    property :resource_type, disposition: :attribute, description: 'The type of resource to tag.', source: "MintPress::Aws::EC2::Tag", orig_name: 'resource_type', type: [String], create_capacity_reservation_prop: 'resource_type', create_carrier_gateway_prop: 'resource_type', create_client_vpn_endpoint_prop: 'resource_type', create_customer_gateway_prop: 'resource_type', create_dhcp_options_prop: 'resource_type', create_egress_only_internet_gateway_prop: 'resource_type', create_fleet_prop: 'resource_type', create_flow_logs_prop: 'resource_type', create_fpga_image_prop: 'resource_type', create_image_prop: 'resource_type', create_instance_export_task_prop: 'resource_type', create_internet_gateway_prop: 'resource_type', create_key_pair_prop: 'resource_type', create_launch_template_prop: 'resource_type', create_local_gateway_route_table_vpc_association_prop: 'resource_type', create_managed_prefix_list_prop: 'resource_type', create_nat_gateway_prop: 'resource_type', create_network_acl_prop: 'resource_type', create_network_insights_path_prop: 'resource_type', create_network_interface_prop: 'resource_type', create_placement_group_prop: 'resource_type', create_route_table_prop: 'resource_type', create_security_group_prop: 'resource_type', create_snapshot_prop: 'resource_type', create_snapshots_prop: 'resource_type', create_subnet_prop: 'resource_type', create_traffic_mirror_filter_prop: 'resource_type', create_traffic_mirror_session_prop: 'resource_type', create_traffic_mirror_target_prop: 'resource_type', create_transit_gateway_prop: 'resource_type', create_transit_gateway_connect_prop: 'resource_type', create_transit_gateway_connect_peer_prop: 'resource_type', create_transit_gateway_multicast_domain_prop: 'resource_type', create_transit_gateway_peering_attachment_prop: 'resource_type', create_transit_gateway_route_table_prop: 'resource_type', create_transit_gateway_vpc_attachment_prop: 'resource_type', create_volume_prop: 'resource_type', create_vpc_prop: 'resource_type', create_vpc_endpoint_prop: 'resource_type', create_vpc_endpoint_service_configuration_prop: 'resource_type', create_vpc_peering_connection_prop: 'resource_type', create_vpn_connection_prop: 'resource_type', create_vpn_gateway_prop: 'resource_type', purchase_host_reservation_prop: 'resource_type', start_network_insights_analysis_prop: 'resource_type', create_instances_prop: 'resource_type'
  • #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_tags_prop'dry_run'
    • read_onlyfalse
    • source"delete_tags"
    • delete_tags_prop'dry_run'
    • describe_tags_prop'dry_run'
    
    
    25
    26
    27
    28
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 25
    
    property :dry_run, create_tags_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "delete_tags", 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_tags_prop: 'dry_run', describe_tags_prop: 'dry_run'
  • #resources ⇒ Array of ⇒ [String] (Default Value: Proc.new { [self.parent.id] })
    'The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.'

    Property Attributes
    • source"delete_tags"
    • orig_name'resource_id'
    • create_tags_prop'resources'
    • read_onlyfalse
    • delete_tags_prop'resources'
    • fromString
    • defaultProc.new { [self.parent.id] }
    
    
    29
    30
    31
    32
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 29
    
    property :resources, description: 'The IDs of the resources, separated by spaces.
    
    Constraints: Up to 1000 resource IDs. We recommend breaking up this
    request into smaller batches.', source: "delete_tags", orig_name: 'resource_id', type: [String], create_tags_prop: 'resources', array: true, read_only: false, delete_tags_prop: 'resources', from: String, default: Proc.new { [self.parent.id] }
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. key - The tag key. resource-id - The ID of the resource. resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway). tag: - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". value - The tag value.'

    Property Attributes
    • describe_tags_prop'filters'
    • source"describe_tags"
    
    
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 33
    
    property :filters, describe_tags_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_tags", description: 'The filters.
    
    
    key - The tag key.
    resource-id - The ID of the resource.
    resource-type - The resource type (customer-gateway |
    dedicated-host | dhcp-options | elastic-ip | fleet |
    fpga-image | host-reservation | image | instance |
    internet-gateway | key-pair | launch-template |
    natgateway | network-acl | network-interface |
    placement-group | reserved-instances | route-table |
    security-group | snapshot | spot-instances-request |
    subnet | volume | vpc | vpc-endpoint |
    vpc-endpoint-service | vpc-peering-connection |
    vpn-connection | vpn-gateway).
    tag:<key> - The key/value combination of the tag. For
    example, specify "tag:Owner" for the filter name and "TeamA" for
    the filter value to find resources with the tag "Owner=TeamA".
    value - The tag value.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.'

    Property Attributes
    • describe_tags_prop'max_results'
    • source"describe_tags"
    
    
    52
    53
    54
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 52
    
    property :max_results, describe_tags_prop: 'max_results', type: [Integer], source: "describe_tags", description: 'The maximum number of results to return in a single call. This value
    can be between 5 and 1000. To retrieve the remaining results, make
    another call with the returned NextToken value.'
  • #name ⇒ String

    Property Attributes
    
    
    55
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 55
    
    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
    
    
    59
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 59
    
    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
    • defaultMintPress::InfrastructureAws::AwsPlatform.new
    
    
    62
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/tag.rb', line 62
    
    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 = {}) ⇒ Tag

Returns a new instance of Tag.

Instance Method Details

#createObject

#deleteObject

#delete_cascadeObject

#describeObject