Class: MintPress::Aws::EC2::TransitGatewayConnectPeer

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

Properties (Read/Write)

  • #connect_peer_configuration ⇒ [MintPress::Aws::EC2::TransitGatewayConnectPeerConfiguration] (Default Value: MintPress::Aws::EC2::TransitGatewayConnectPeerConfiguration.new)
    'The Connect peer details.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayConnectPeer"
    • orig_name ⇒ 'connect_peer_configuration'
    • default ⇒ MintPress::Aws::EC2::TransitGatewayConnectPeerConfiguration.new
    

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

property :connect_peer_configuration, disposition: :attribute, description: 'The Connect peer details.', source: "MintPress::Aws::EC2::TransitGatewayConnectPeer", orig_name: 'connect_peer_configuration', type: [MintPress::Aws::EC2::TransitGatewayConnectPeerConfiguration], default: MintPress::Aws::EC2::TransitGatewayConnectPeerConfiguration.new
  • #creation_time ⇒ [Time]
    'The creation time.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayConnectPeer"
    • orig_name ⇒ 'creation_time'
    

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

property :creation_time, disposition: :attribute, description: 'The creation time.', source: "MintPress::Aws::EC2::TransitGatewayConnectPeer", orig_name: 'creation_time', type: [Time]
  • #state ⇒ [String]
    'The state of the Connect peer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayConnectPeer"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the Connect peer.', source: "MintPress::Aws::EC2::TransitGatewayConnectPeer", orig_name: 'state', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags for the Connect peer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayConnectPeer"
    • orig_name ⇒ 'tags'
    • create_transit_gateway_connect_peer_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The tags for the Connect peer.', source: "MintPress::Aws::EC2::TransitGatewayConnectPeer", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_transit_gateway_connect_peer_prop: 'tag_specifications', read_only: false, hash: true
  • #transit_gateway_address ⇒ [String]
    'The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.'
    Property Attributes
    • create_transit_gateway_connect_peer_prop ⇒ 'transit_gateway_address'
    • read_only ⇒ false
    • source ⇒ "create_transit_gateway_connect_peer"
    

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

property :transit_gateway_address, create_transit_gateway_connect_peer_prop: 'transit_gateway_address', type: [String], read_only: false, source: "create_transit_gateway_connect_peer", description: 'The peer IP address (GRE outer IP address) on the transit gateway side
of the Connect peer, which must be specified from a transit gateway
CIDR block. If not specified, Amazon automatically assigns the first
available IP address from the transit gateway CIDR block.'
  • #peer_address ⇒ [String]
    'The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.'
    Property Attributes
    • create_transit_gateway_connect_peer_prop ⇒ 'peer_address'
    • read_only ⇒ false
    • source ⇒ "create_transit_gateway_connect_peer"
    

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

property :peer_address, create_transit_gateway_connect_peer_prop: 'peer_address', type: [String], read_only: false, source: "create_transit_gateway_connect_peer", description: 'The peer IP address (GRE outer IP address) on the appliance side of
the Connect peer.'
  • #bgp_options ⇒ [Integer]
    'The BGP options for the Connect peer.'
    Property Attributes
    • create_transit_gateway_connect_peer_prop ⇒ "bgp_options.peer_asn"
    • read_only ⇒ false
    • source ⇒ "create_transit_gateway_connect_peer"
    

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

property :bgp_options, create_transit_gateway_connect_peer_prop: "bgp_options.peer_asn", type: [Integer], read_only: false, source: "create_transit_gateway_connect_peer", description: 'The BGP options for the Connect peer.'
  • #inside_cidr_blocks ⇒ Array of ⇒ [String]
    'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.'
    Property Attributes
    • create_transit_gateway_connect_peer_prop ⇒ 'inside_cidr_blocks'
    • read_only ⇒ false
    • source ⇒ "create_transit_gateway_connect_peer"
    

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

property :inside_cidr_blocks, create_transit_gateway_connect_peer_prop: 'inside_cidr_blocks', type: [String], array: true, read_only: false, source: "create_transit_gateway_connect_peer", description: 'The range of inside IP addresses that are used for BGP peering. You
must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16
range. The first address from the range must be configured on the
appliance as the BGP IP address. You can also optionally specify a
size /125 IPv6 CIDR block from the fd00::/8 range.'
  • #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_connect_peer_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "describe_transit_gateway_connect_peers"
    • delete_transit_gateway_connect_peer_prop ⇒ 'dry_run'
    • describe_transit_gateway_connect_peers_prop ⇒ 'dry_run'
    

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

property :dry_run, create_transit_gateway_connect_peer_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "describe_transit_gateway_connect_peers", 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_connect_peer_prop: 'dry_run', describe_transit_gateway_connect_peers_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. The possible values are: state - The state of the Connect peer (pending | available | deleting | deleted). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-connect-peer-id - The ID of the Connect peer.'
    Property Attributes
    • describe_transit_gateway_connect_peers_prop ⇒ 'filters'
    • source ⇒ "describe_transit_gateway_connect_peers"
    

45
46
47
48
49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/transit_gateway_connect_peer.rb', line 45

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


state - The state of the Connect peer (pending | available |
deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.', 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_connect_peers_prop ⇒ 'max_results'
    • source ⇒ "describe_transit_gateway_connect_peers"
    

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

property :max_results, describe_transit_gateway_connect_peers_prop: 'max_results', type: [Integer], source: "describe_transit_gateway_connect_peers", 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.'
  • #transit_gateway_attachment ⇒ [MintPress::Aws::EC2::TransitGatewayAttachment]
    'The ID of the Connect attachment.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::TransitGatewayConnectPeer"
    • orig_name ⇒ 'transit_gateway_attachment_id'
    • create_transit_gateway_connect_peer_prop ⇒ 'transit_gateway_attachment_id'
    • read_only ⇒ false
    • from ⇒ String
    

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

property :transit_gateway_attachment, disposition: :attribute, description: 'The ID of the Connect attachment.', source: "MintPress::Aws::EC2::TransitGatewayConnectPeer", orig_name: 'transit_gateway_attachment_id', type: [MintPress::Aws::EC2::TransitGatewayAttachment], create_transit_gateway_connect_peer_prop: 'transit_gateway_attachment_id', read_only: false, from: String
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the Connect peers.'
    Property Attributes
    • source ⇒ "describe_transit_gateway_connect_peers"
    • orig_name ⇒ 'transit_gateway_connect_peer_id'
    • delete_transit_gateway_connect_peer_prop ⇒ 'transit_gateway_connect_peer_id'
    • read_only ⇒ false
    • describe_transit_gateway_connect_peers_prop ⇒ 'transit_gateway_connect_peer_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, description: 'The IDs of the Connect peers.', source: "describe_transit_gateway_connect_peers", orig_name: 'transit_gateway_connect_peer_id', type: [String], delete_transit_gateway_connect_peer_prop: 'transit_gateway_connect_peer_id', read_only: false, array: false, hash: false, describe_transit_gateway_connect_peers_prop: 'transit_gateway_connect_peer_ids', default: Proc.new { self.name }
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of TransitGatewayConnectPeer.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object