Class: MintPress::Aws::EC2::SecurityGroup

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

Properties (Read/Write)

  • #description ⇒ [String]
    'A description of the security group.'
    Property Attributes
    • create_security_group_prop ⇒ 'description'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'description'
    

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

property :description, create_security_group_prop: 'description', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::EC2::SecurityGroup", description: 'A description of the security group.', orig_name: 'description'
  • #group_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the security group.'
    Property Attributes
    • create_security_group_prop ⇒ 'group_name'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • delete_security_group_prop ⇒ 'group_name'
    • orig_name ⇒ 'group_name'
    • default ⇒ Proc.new { self.name }
    

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

property :group_name, create_security_group_prop: 'group_name', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::EC2::SecurityGroup", description: 'The name of the security group.', delete_security_group_prop: 'group_name', orig_name: 'group_name', default: Proc.new { self.name }
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the security group.'
    Property Attributes
    • create_security_group_prop ⇒ 'tag_specifications'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'tags'
    

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

property :tags, create_security_group_prop: 'tag_specifications', type: [MintPress::Aws::EC2::Tag], array: false, disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::EC2::SecurityGroup", description: 'Any tags assigned to the security group.', orig_name: 'tags', 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_security_group_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_security_group"
    • delete_security_group_prop ⇒ 'dry_run'
    • describe_security_groups_prop ⇒ 'dry_run'
    

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

property :dry_run, create_security_group_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_security_group", 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_security_group_prop: 'dry_run', describe_security_groups_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters. description - The description of the security group. egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule. egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule. egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule. egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule. egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access. egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number). egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule. group-id - The ID of the security group. group-name - The name of the security group. ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule. ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule. ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule. ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule. ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access. ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number). ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule. owner-id - The AWS account ID of the owner of the security group. 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 specified when the security group was created.'
    Property Attributes
    • describe_security_groups_prop ⇒ 'filters'
    • source ⇒ "describe_security_groups"
    

36
37
38
39
40
41
42
43
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/security_group.rb', line 36

property :filters, describe_security_groups_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_security_groups", description: 'The filters. If using multiple filters for rules, the results include
security groups for which any combination of rules - not necessarily a
single rule - match all filters.


description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound
security group rule.
egress.ip-permission.from-port - For an outbound rule, the start
of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that
has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group
that has been referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to
which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound
security group rule (tcp | udp | icmp or a protocol number).
egress.ip-permission.to-port - For an outbound rule, the end of
port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an AWS account that has
been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security
group rule.
ip-permission.from-port - For an inbound rule, the start of port
range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been
referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that has
been referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound
security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which
a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security
group rule (tcp | udp | icmp or a protocol number).
ip-permission.to-port - For an inbound rule, the end of port range
for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been
referenced in an inbound security group rule.
owner-id - The AWS account ID of the owner of the security group.
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 specified when the security group was
created.', hash: true
  • #group_names ⇒ Array of ⇒ [String]
    '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name. Default: Describes all your security groups.'
    Property Attributes
    • describe_security_groups_prop ⇒ 'group_names'
    • source ⇒ "describe_security_groups"
    

91
92
93
94
95
96
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/security_group.rb', line 91

property :group_names, describe_security_groups_prop: 'group_names', type: [String], array: true, source: "describe_security_groups", description: '[EC2-Classic and default VPC only] The names of the security groups.
You can specify either the security group name or the security group
ID. For security groups in a nondefault VPC, use the group-name
filter to describe security groups by name.

Default: Describes all your security groups.'
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
    Property Attributes
    • describe_security_groups_prop ⇒ 'max_results'
    • source ⇒ "describe_security_groups"
    

97
98
99
100
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/security_group.rb', line 97

property :max_results, describe_security_groups_prop: 'max_results', type: [Integer], source: "describe_security_groups", description: 'The maximum number of results to return in a single call. To retrieve
the remaining results, make another request with the returned
NextToken value. This value can be between 5 and 1000. If this
parameter is not specified, then all results are returned.'
  • #id ⇒ [String]
    'The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all your security groups.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_security_groups"
    • orig_name ⇒ 'group_id'
    • delete_security_group_prop ⇒ 'group_id'
    • describe_security_groups_prop ⇒ 'group_ids'
    

101
102
103
104
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/security_group.rb', line 101

property :id, read_only: false, disposition: :attribute, description: 'The IDs of the security groups. Required for security groups in a
nondefault VPC.

Default: Describes all your security groups.', source: "describe_security_groups", orig_name: 'group_id', type: [String], delete_security_group_prop: 'group_id', array: false, hash: false, describe_security_groups_prop: 'group_ids'
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc]
    '[VPC only] The ID of the VPC for the security group.'
    Property Attributes
    • create_security_group_prop ⇒ 'vpc_id'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'vpc_id'
    • from ⇒ String
    

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

property :vpc, create_security_group_prop: 'vpc_id', type: [MintPress::Aws::EC2::Vpc], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::EC2::SecurityGroup", description: '[VPC only] The ID of the VPC for the security group.', orig_name: 'vpc_id', from: String
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

  • #ip_permissions ⇒ Array of ⇒ [MintPress::Aws::EC2::IpPermission]
    'The inbound rules associated with the security group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'ip_permissions'
    • read_only ⇒ true
    

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

property :ip_permissions, disposition: :read_only_attribute, description: 'The inbound rules associated with the security group.', source: "MintPress::Aws::EC2::SecurityGroup", orig_name: 'ip_permissions', type: [MintPress::Aws::EC2::IpPermission], array: true, read_only: true
  • #ip_permissions_egress ⇒ Array of ⇒ [MintPress::Aws::EC2::IpPermission]
    '[VPC only] The outbound rules associated with the security group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'ip_permissions_egress'
    • read_only ⇒ true
    

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

property :ip_permissions_egress, disposition: :read_only_attribute, description: '[VPC only] The outbound rules associated with the security group.', source: "MintPress::Aws::EC2::SecurityGroup", orig_name: 'ip_permissions_egress', type: [MintPress::Aws::EC2::IpPermission], array: true, read_only: true
  • #owner ⇒ [String]
    'The AWS account ID of the owner of the security group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::EC2::SecurityGroup"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

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

property :owner, disposition: :read_only_attribute, description: 'The AWS account ID of the owner of the security group.', source: "MintPress::Aws::EC2::SecurityGroup", orig_name: 'owner_id', type: [String], 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 = {}) ⇒ SecurityGroup

Returns a new instance of SecurityGroup.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object