Class: MintPress::Aws::EC2::CarrierGateway

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

Properties (Read/Write)

  • #state ⇒ [String]
    'The state of the carrier gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CarrierGateway"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the carrier gateway.', source: "MintPress::Aws::EC2::CarrierGateway", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags assigned to the carrier gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CarrierGateway"
    • orig_name ⇒ 'tags'
    • create_carrier_gateway_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags assigned to the carrier gateway.', source: "MintPress::Aws::EC2::CarrierGateway", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_carrier_gateway_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_carrier_gateway_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_carrier_gateways"
    • delete_carrier_gateway_prop ⇒ 'dry_run'
    • describe_carrier_gateways_prop ⇒ 'dry_run'
    

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

property :dry_run, create_carrier_gateway_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_carrier_gateways", 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_carrier_gateway_prop: 'dry_run', describe_carrier_gateways_prop: 'dry_run'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • create_carrier_gateway_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_carrier_gateway"
    

30
31
32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/carrier_gateway.rb', line 30

property :client_token, create_carrier_gateway_prop: 'client_token', type: [String], read_only: false, source: "create_carrier_gateway", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. carrier-gateway-id - The ID of the carrier gateway. state - The state of the carrier gateway (pending | failed | available | deleting | deleted). owner-id - The AWS account ID of the owner of the carrier gateway. 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. vpc-id - The ID of the VPC associated with the carrier gateway.'
    Property Attributes
    • describe_carrier_gateways_prop ⇒ 'filters'
    • source ⇒ "describe_carrier_gateways"
    

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/carrier_gateway.rb', line 36

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


carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed |
available | deleting | deleted).
owner-id - The AWS account ID of the owner of the carrier gateway.
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.
vpc-id - The ID of the VPC associated with the carrier gateway.', 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_carrier_gateways_prop ⇒ 'max_results'
    • source ⇒ "describe_carrier_gateways"
    

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

property :max_results, describe_carrier_gateways_prop: 'max_results', type: [Integer], source: "describe_carrier_gateways", 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 })
    'One or more carrier gateway IDs.'
    Property Attributes
    • source ⇒ "describe_carrier_gateways"
    • orig_name ⇒ 'carrier_gateway_id'
    • delete_carrier_gateway_prop ⇒ 'carrier_gateway_id'
    • read_only ⇒ false
    • describe_carrier_gateways_prop ⇒ 'carrier_gateway_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'One or more carrier gateway IDs.', source: "describe_carrier_gateways", orig_name: 'carrier_gateway_id', type: [String], delete_carrier_gateway_prop: 'carrier_gateway_id', read_only: false, array: false, hash: false, describe_carrier_gateways_prop: 'carrier_gateway_ids', default: Proc.new { self.name }
  • #owner ⇒ [String]
    'The AWS account ID of the owner of the carrier gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CarrierGateway"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The AWS account ID of the owner of the carrier gateway.', source: "MintPress::Aws::EC2::CarrierGateway", orig_name: 'owner_id', type: [String]
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    'The ID of the VPC associated with the carrier gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::CarrierGateway"
    • orig_name ⇒ 'vpc_id'
    • create_carrier_gateway_prop ⇒ 'vpc_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :vpc, disposition: :attribute, description: 'The ID of the VPC associated with the carrier gateway.', source: "MintPress::Aws::EC2::CarrierGateway", orig_name: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], create_carrier_gateway_prop: 'vpc_id', read_only: false, from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of CarrierGateway.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object