Class: MintPress::Aws::EC2::VpcPeeringConnection

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

Properties (Read/Write)

  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the peering connection.'
    Property Attributes
    • source ⇒ "create_vpc_peering_connection"
    • orig_name ⇒ 'tags'
    • create_vpc_peering_connection_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    

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

property :tags, description: 'The tags to assign to the peering connection.', source: "create_vpc_peering_connection", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_vpc_peering_connection_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
    • accept_vpc_peering_connection_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_vpc_peering_connection"
    • create_vpc_peering_connection_prop ⇒ 'dry_run'
    • delete_vpc_peering_connection_prop ⇒ 'dry_run'
    • describe_vpc_peering_connections_prop ⇒ 'dry_run'
    

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

property :dry_run, accept_vpc_peering_connection_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_vpc_peering_connection", 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.', create_vpc_peering_connection_prop: 'dry_run', delete_vpc_peering_connection_prop: 'dry_run', describe_vpc_peering_connections_prop: 'dry_run'
  • #peer_region ⇒ [String]
    'The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. Default: The Region in which you make the request.'
    Property Attributes
    • create_vpc_peering_connection_prop ⇒ 'peer_region'
    • read_only ⇒ false
    • source ⇒ "create_vpc_peering_connection"
    

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

property :peer_region, create_vpc_peering_connection_prop: 'peer_region', type: [String], read_only: false, source: "create_vpc_peering_connection", description: 'The Region code for the accepter VPC, if the accepter VPC is located
in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC. accepter-vpc-info.vpc-id - The ID of the accepter VPC. expiration-time - The expiration date and time for the VPC peering connection. requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester"s VPC. requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC. requester-vpc-info.vpc-id - The ID of the requester VPC. status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected). status-message - A message that provides more information about the status of the VPC peering connection, if applicable. 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-peering-connection-id - The ID of the VPC peering connection.'
    Property Attributes
    • describe_vpc_peering_connections_prop ⇒ 'filters'
    • source ⇒ "describe_vpc_peering_connections"
    

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_peering_connection.rb', line 44

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


accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter
VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of
the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering
connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the
requester"s VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of
the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection
(pending-acceptance | failed | expired | provisioning |
active | deleting | deleted | rejected).
status-message - A message that provides more information about
the status of the VPC peering connection, if applicable.
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-peering-connection-id - The ID of the VPC peering connection.', 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_vpc_peering_connections_prop ⇒ 'max_results'
    • source ⇒ "describe_vpc_peering_connections"
    

73
74
75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_peering_connection.rb', line 73

property :max_results, describe_vpc_peering_connections_prop: 'max_results', type: [Integer], source: "describe_vpc_peering_connections", 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 VPC peering connection IDs. Default: Describes all your VPC peering connections.'
    Property Attributes
    • read_only ⇒ false
    • source ⇒ "describe_vpc_peering_connections"
    • orig_name ⇒ 'vpc_peering_connection_id'
    • accept_vpc_peering_connection_prop ⇒ 'vpc_peering_connection_id'
    • delete_vpc_peering_connection_prop ⇒ 'vpc_peering_connection_id'
    • create_vpc_peering_connection_prop ⇒ 'vpc_id'
    • describe_vpc_peering_connections_prop ⇒ 'vpc_peering_connection_ids'
    • default ⇒ Proc.new { self.name }
    

76
77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_peering_connection.rb', line 76

property :id, read_only: false, description: 'One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.', source: "describe_vpc_peering_connections", orig_name: 'vpc_peering_connection_id', type: [String], accept_vpc_peering_connection_prop: 'vpc_peering_connection_id', delete_vpc_peering_connection_prop: 'vpc_peering_connection_id', array: false, hash: false, create_vpc_peering_connection_prop: 'vpc_id', describe_vpc_peering_connections_prop: 'vpc_peering_connection_ids', default: Proc.new { self.name }
  • #accepter_vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'accepter_vpc'
    • default ⇒ MintPress::Aws::EC2::Vpc.new
    

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

property :accepter_vpc, disposition: :association, source: "VpcPeeringConnection", orig_name: 'accepter_vpc', type: [MintPress::Aws::EC2::Vpc], default: MintPress::Aws::EC2::Vpc.new
  • #requester_vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'requester_vpc'
    • default ⇒ MintPress::Aws::EC2::Vpc.new
    

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

property :requester_vpc, disposition: :association, source: "VpcPeeringConnection", orig_name: 'requester_vpc', type: [MintPress::Aws::EC2::Vpc], default: MintPress::Aws::EC2::Vpc.new
  • #peer_owner ⇒ [String]
    'The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID'
    Property Attributes
    • create_vpc_peering_connection_prop ⇒ 'peer_owner_id'
    • read_only ⇒ false
    • source ⇒ "create_vpc_peering_connection"
    

81
82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_peering_connection.rb', line 81

property :peer_owner, create_vpc_peering_connection_prop: 'peer_owner_id', type: [String], read_only: false, source: "create_vpc_peering_connection", description: 'The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID'
  • #peer_vpc ⇒ [String]
    'The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.'
    Property Attributes
    • create_vpc_peering_connection_prop ⇒ 'peer_vpc_id'
    • read_only ⇒ false
    • source ⇒ "create_vpc_peering_connection"
    

84
85
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_peering_connection.rb', line 84

property :peer_vpc, create_vpc_peering_connection_prop: 'peer_vpc_id', type: [String], read_only: false, source: "create_vpc_peering_connection", description: 'The ID of the VPC with which you are creating the VPC peering
connection. You must specify this parameter in the request.'
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

  • #accepter_vpc_info ⇒ [MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo] (Default Value: MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new)
    'Information about the accepter VPC.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'accepter_vpc_info'
    • default ⇒ MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new
    • read_only ⇒ true
    

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

property :accepter_vpc_info, disposition: :read_only_attribute, description: 'Information about the accepter VPC.', source: "VpcPeeringConnection", orig_name: 'accepter_vpc_info', type: [MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo], default: MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new, read_only: true
  • #expiration_time ⇒ [Time]
    'The time that an unaccepted VPC peering connection will expire.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'expiration_time'
    • read_only ⇒ true
    

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

property :expiration_time, disposition: :read_only_attribute, description: 'The time that an unaccepted VPC peering connection will expire.', source: "VpcPeeringConnection", orig_name: 'expiration_time', type: [Time], read_only: true
  • #requester_vpc_info ⇒ [MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo] (Default Value: MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new)
    'Information about the requester VPC.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'requester_vpc_info'
    • default ⇒ MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new
    • read_only ⇒ true
    

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

property :requester_vpc_info, disposition: :read_only_attribute, description: 'Information about the requester VPC.', source: "VpcPeeringConnection", orig_name: 'requester_vpc_info', type: [MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo], default: MintPress::Aws::EC2::VpcPeeringConnectionVpcInfo.new, read_only: true
  • #status ⇒ [MintPress::Aws::EC2::VpcPeeringConnectionStateReason] (Default Value: MintPress::Aws::EC2::VpcPeeringConnectionStateReason.new)
    'The status of the VPC peering connection.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "VpcPeeringConnection"
    • orig_name ⇒ 'status'
    • default ⇒ MintPress::Aws::EC2::VpcPeeringConnectionStateReason.new
    • read_only ⇒ true
    

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

property :status, disposition: :read_only_attribute, description: 'The status of the VPC peering connection.', source: "VpcPeeringConnection", orig_name: 'status', type: [MintPress::Aws::EC2::VpcPeeringConnectionStateReason], default: MintPress::Aws::EC2::VpcPeeringConnectionStateReason.new, read_only: true

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

Returns a new instance of VpcPeeringConnection.

Instance Method Details

#accept ⇒ Object

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object