Class: MintPress::Aws::EC2::VpcEndpointServicePermission

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

Properties (Read/Write)

  • #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
    • describe_vpc_endpoint_service_permissions_prop ⇒ 'dry_run'
    • source ⇒ "modify_vpc_endpoint_service_permissions"
    • modify_vpc_endpoint_service_permissions_prop ⇒ 'dry_run'
    • read_only ⇒ false
    

20
21
22
23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_permission.rb', line 20

property :dry_run, describe_vpc_endpoint_service_permissions_prop: 'dry_run', type: [TrueClass,FalseClass], source: "modify_vpc_endpoint_service_permissions", 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.', modify_vpc_endpoint_service_permissions_prop: 'dry_run', read_only: false
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. principal - The ARN of the principal. principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).'
    Property Attributes
    • describe_vpc_endpoint_service_permissions_prop ⇒ 'filters'
    • source ⇒ "describe_vpc_endpoint_service_permissions"
    

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

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


principal - The ARN of the principal.
principal-type - The principal type (All | Service |
OrganizationUnit | Account | User | Role).', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
    Property Attributes
    • describe_vpc_endpoint_service_permissions_prop ⇒ 'max_results'
    • source ⇒ "describe_vpc_endpoint_service_permissions"
    

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

property :max_results, describe_vpc_endpoint_service_permissions_prop: 'max_results', type: [Integer], source: "describe_vpc_endpoint_service_permissions", description: 'The maximum number of results to return for the request in a single
page. The remaining results of the initial request can be seen by
sending another request with the returned NextToken value. This
value can be between 5 and 1,000; if MaxResults is given a value
larger than 1,000, only 1,000 results are returned.'
  • #add_allowed_principals ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).'
    Property Attributes
    • modify_vpc_endpoint_service_permissions_prop ⇒ 'add_allowed_principals'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_permissions"
    

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

property :add_allowed_principals, modify_vpc_endpoint_service_permissions_prop: 'add_allowed_principals', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_permissions", description: 'The Amazon Resource Names (ARN) of one or more principals. Permissions
are granted to the principals in this list. To grant permissions to
all principals, specify an asterisk (*).'
  • #remove_allowed_principals ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.'
    Property Attributes
    • modify_vpc_endpoint_service_permissions_prop ⇒ 'remove_allowed_principals'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_permissions"
    

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

property :remove_allowed_principals, modify_vpc_endpoint_service_permissions_prop: 'remove_allowed_principals', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_permissions", description: 'The Amazon Resource Names (ARN) of one or more principals. Permissions
are revoked for principals in this list.'
  • #service ⇒ [String]
    'The ID of the service.'
    Property Attributes
    • describe_vpc_endpoint_service_permissions_prop ⇒ 'service_id'
    • source ⇒ "modify_vpc_endpoint_service_permissions"
    • modify_vpc_endpoint_service_permissions_prop ⇒ 'service_id'
    • read_only ⇒ false
    

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

property :service, describe_vpc_endpoint_service_permissions_prop: 'service_id', type: [String], source: "modify_vpc_endpoint_service_permissions", description: 'The ID of the service.', modify_vpc_endpoint_service_permissions_prop: 'service_id', read_only: false
  • #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 
    

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

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
    

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

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

Returns a new instance of VpcEndpointServicePermission.

Instance Method Details

#describe ⇒ Object

#modify ⇒ Object