Class: MintPress::Aws::EC2::VpcEndpointServiceConfiguration

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_configuration.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
    • create_vpc_endpoint_service_configuration_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    • delete_vpc_endpoint_service_configurations_prop ⇒ 'dry_run'
    • describe_vpc_endpoint_service_configurations_prop ⇒ 'dry_run'
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'dry_run'
    

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

property :dry_run, create_vpc_endpoint_service_configuration_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "modify_vpc_endpoint_service_configuration", 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_vpc_endpoint_service_configurations_prop: 'dry_run', describe_vpc_endpoint_service_configurations_prop: 'dry_run', modify_vpc_endpoint_service_configuration_prop: 'dry_run'
  • #acceptance_required ⇒ [TrueClass,FalseClass]
    'Indicates whether requests to create an endpoint to your service must be accepted.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'acceptance_required'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'acceptance_required'
    

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

property :acceptance_required, create_vpc_endpoint_service_configuration_prop: 'acceptance_required', type: [TrueClass,FalseClass], read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'Indicates whether requests to create an endpoint to your service must
be accepted.', modify_vpc_endpoint_service_configuration_prop: 'acceptance_required'
  • #private_dns_name ⇒ [String]
    'The private DNS name to assign to the endpoint service.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'private_dns_name'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'private_dns_name'
    

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

property :private_dns_name, create_vpc_endpoint_service_configuration_prop: 'private_dns_name', type: [String], read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'The private DNS name to assign to
the endpoint service.', modify_vpc_endpoint_service_configuration_prop: 'private_dns_name'
  • #network_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'network_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "create_vpc_endpoint_service_configuration"
    

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

property :network_load_balancer_arns, create_vpc_endpoint_service_configuration_prop: 'network_load_balancer_arns', type: [String], array: true, read_only: false, source: "create_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of one or more Network Load Balancers
for your service.'
  • #gateway_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'gateway_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "create_vpc_endpoint_service_configuration"
    

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

property :gateway_load_balancer_arns, create_vpc_endpoint_service_configuration_prop: 'gateway_load_balancer_arns', type: [String], array: true, read_only: false, source: "create_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of one or more Gateway Load
Balancers.'
  • #client_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_vpc_endpoint_service_configuration"
    

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

property :client_token, create_vpc_endpoint_service_configuration_prop: 'client_token', type: [String], read_only: false, source: "create_vpc_endpoint_service_configuration", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to Ensure
Idempotency.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to associate with the service.'
    Property Attributes
    • create_vpc_endpoint_service_configuration_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    • source ⇒ "create_vpc_endpoint_service_configuration"
    

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

property :tags, create_vpc_endpoint_service_configuration_prop: 'tag_specifications', type: [MintPress::Aws::EC2::Tag], array: false, read_only: false, source: "create_vpc_endpoint_service_configuration", description: 'The tags to associate with the service.', hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed). 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.'
    Property Attributes
    • describe_vpc_endpoint_service_configurations_prop ⇒ 'filters'
    • source ⇒ "describe_vpc_endpoint_service_configurations"
    

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_configuration.rb', line 41

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


service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available
| Deleting | Deleted | Failed).
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.', 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_configurations_prop ⇒ 'max_results'
    • source ⇒ "describe_vpc_endpoint_service_configurations"
    

56
57
58
59
60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_configuration.rb', line 56

property :max_results, describe_vpc_endpoint_service_configurations_prop: 'max_results', type: [Integer], source: "describe_vpc_endpoint_service_configurations", 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.'
  • #remove_private_dns_name ⇒ [TrueClass,FalseClass]
    'Removes the private DNS name of the endpoint service.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'remove_private_dns_name'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

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

property :remove_private_dns_name, modify_vpc_endpoint_service_configuration_prop: 'remove_private_dns_name', type: [TrueClass,FalseClass], read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'Removes the private DNS name of the
endpoint service.'
  • #add_network_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'add_network_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

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

property :add_network_load_balancer_arns, modify_vpc_endpoint_service_configuration_prop: 'add_network_load_balancer_arns', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of Network Load Balancers to add to
your service configuration.'
  • #remove_network_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'remove_network_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

65
66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_configuration.rb', line 65

property :remove_network_load_balancer_arns, modify_vpc_endpoint_service_configuration_prop: 'remove_network_load_balancer_arns', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of Network Load Balancers to remove
from your service configuration.'
  • #add_gateway_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'add_gateway_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

67
68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_configuration.rb', line 67

property :add_gateway_load_balancer_arns, modify_vpc_endpoint_service_configuration_prop: 'add_gateway_load_balancer_arns', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to
your service configuration.'
  • #remove_gateway_load_balancer_arns ⇒ Array of ⇒ [String]
    'The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'remove_gateway_load_balancer_arns'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/vpc_endpoint_service_configuration.rb', line 69

property :remove_gateway_load_balancer_arns, modify_vpc_endpoint_service_configuration_prop: 'remove_gateway_load_balancer_arns', type: [String], array: true, read_only: false, source: "modify_vpc_endpoint_service_configuration", description: 'The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove
from your service configuration.'
  • #services ⇒ Array of ⇒ [String]
    'The IDs of one or more services.'
    Property Attributes
    • delete_vpc_endpoint_service_configurations_prop ⇒ 'service_ids'
    • read_only ⇒ false
    • source ⇒ "describe_vpc_endpoint_service_configurations"
    • describe_vpc_endpoint_service_configurations_prop ⇒ 'service_ids'
    

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

property :services, delete_vpc_endpoint_service_configurations_prop: 'service_ids', type: [String], array: true, read_only: false, source: "describe_vpc_endpoint_service_configurations", description: 'The IDs of one or more services.', describe_vpc_endpoint_service_configurations_prop: 'service_ids'
  • #service ⇒ [String]
    'The ID of the service.'
    Property Attributes
    • modify_vpc_endpoint_service_configuration_prop ⇒ 'service_id'
    • read_only ⇒ false
    • source ⇒ "modify_vpc_endpoint_service_configuration"
    

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

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

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

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
    

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

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

Returns a new instance of VpcEndpointServiceConfiguration.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object