Class: MintPress::Aws::EC2::TransitGatewayMulticastDomain

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

Properties (Read/Write)

  • #creation_time ⇒ [Time]
    'The time the transit gateway multicast domain was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'creation_time'
    

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

property :creation_time, disposition: :attribute, description: 'The time the transit gateway multicast domain was created.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'creation_time', type: [Time]
  • #options ⇒ [MintPress::Aws::EC2::TransitGatewayMulticastDomainOption] (Default Value: MintPress::Aws::EC2::TransitGatewayMulticastDomainOption.new)
    'The options for the transit gateway multicast domain.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'options'
    • default ⇒ MintPress::Aws::EC2::TransitGatewayMulticastDomainOption.new
    • create_transit_gateway_multicast_domain_prop ⇒ 'options'
    • read_only ⇒ false
    

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

property :options, disposition: :attribute, description: 'The options for the transit gateway multicast domain.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'options', type: [MintPress::Aws::EC2::TransitGatewayMulticastDomainOption], default: MintPress::Aws::EC2::TransitGatewayMulticastDomainOption.new, create_transit_gateway_multicast_domain_prop: 'options', read_only: false
  • #state ⇒ [String]
    'The state of the transit gateway multicast domain.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the transit gateway multicast domain.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags for the transit gateway multicast domain.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'tags'
    • create_transit_gateway_multicast_domain_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags for the transit gateway multicast domain.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_transit_gateway_multicast_domain_prop: 'tag_specifications', read_only: false, hash: true
  • #transit_gateway_multicast_domain_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the transit gateway multicast domain.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'transit_gateway_multicast_domain_arn'
    

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

property :transit_gateway_multicast_domain_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the transit gateway multicast domain.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'transit_gateway_multicast_domain_arn', type: [String]
  • #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_transit_gateway_multicast_domain_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_transit_gateway_multicast_domains"
    • delete_transit_gateway_multicast_domain_prop ⇒ 'dry_run'
    • describe_transit_gateway_multicast_domains_prop ⇒ 'dry_run'
    

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

property :dry_run, create_transit_gateway_multicast_domain_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_transit_gateway_multicast_domains", 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_transit_gateway_multicast_domain_prop: 'dry_run', describe_transit_gateway_multicast_domains_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. The possible values are: state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted. transit-gateway-id - The ID of the transit gateway. transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.'
    Property Attributes
    • describe_transit_gateway_multicast_domains_prop ⇒ 'filters'
    • source ⇒ "describe_transit_gateway_multicast_domains"
    

34
35
36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/transit_gateway_multicast_domain.rb', line 34

property :filters, describe_transit_gateway_multicast_domains_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_transit_gateway_multicast_domains", description: 'One or more filters. The possible values are:


state - The state of the transit gateway multicast domain. Valid
values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit
gateway multicast domain.', 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_transit_gateway_multicast_domains_prop ⇒ 'max_results'
    • source ⇒ "describe_transit_gateway_multicast_domains"
    

42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/transit_gateway_multicast_domain.rb', line 42

property :max_results, describe_transit_gateway_multicast_domains_prop: 'max_results', type: [Integer], source: "describe_transit_gateway_multicast_domains", 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.'
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the transit gateway multiicast domain.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'owner_id'
    

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

property :owner, disposition: :attribute, description: 'The ID of the AWS account that owns the transit gateway multiicast domain.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'owner_id', type: [String]
  • #transit_gateway ⇒ [MintPress::Aws::EC2::TransitGateway]
    'The ID of the transit gateway.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayMulticastDomain"
    • orig_name ⇒ 'transit_gateway_id'
    • create_transit_gateway_multicast_domain_prop ⇒ 'transit_gateway_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :transit_gateway, disposition: :attribute, description: 'The ID of the transit gateway.', source: "MintPress::Aws::EC2::TransitGatewayMulticastDomain", orig_name: 'transit_gateway_id', type: [MintPress::Aws::EC2::TransitGateway], create_transit_gateway_multicast_domain_prop: 'transit_gateway_id', read_only: false, from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the transit gateway multicast domain.'
    Property Attributes
    • source ⇒ "describe_transit_gateway_multicast_domains"
    • orig_name ⇒ 'transit_gateway_multicast_domain_id'
    • delete_transit_gateway_multicast_domain_prop ⇒ 'transit_gateway_multicast_domain_id'
    • read_only ⇒ false
    • describe_transit_gateway_multicast_domains_prop ⇒ 'transit_gateway_multicast_domain_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The ID of the transit gateway multicast domain.', source: "describe_transit_gateway_multicast_domains", orig_name: 'transit_gateway_multicast_domain_id', type: [String], delete_transit_gateway_multicast_domain_prop: 'transit_gateway_multicast_domain_id', read_only: false, array: false, hash: false, describe_transit_gateway_multicast_domains_prop: 'transit_gateway_multicast_domain_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of TransitGatewayMulticastDomain.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object