Class: Aws::VPCLattice::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::VPCLattice::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb
Overview
An API client for VPCLattice. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::VPCLattice::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_update_rule(params = {}) ⇒ Types::BatchUpdateRuleResponse
Updates the listener rules in a batch.
-
#create_access_log_subscription(params = {}) ⇒ Types::CreateAccessLogSubscriptionResponse
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose.
-
#create_listener(params = {}) ⇒ Types::CreateListenerResponse
Creates a listener for a service.
-
#create_resource_configuration(params = {}) ⇒ Types::CreateResourceConfigurationResponse
Creates a resource configuration.
-
#create_resource_gateway(params = {}) ⇒ Types::CreateResourceGatewayResponse
Creates a resource gateway.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a listener rule.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service.
-
#create_service_network(params = {}) ⇒ Types::CreateServiceNetworkResponse
Creates a service network.
-
#create_service_network_resource_association(params = {}) ⇒ Types::CreateServiceNetworkResourceAssociationResponse
Associates the specified service network with the specified resource configuration.
-
#create_service_network_service_association(params = {}) ⇒ Types::CreateServiceNetworkServiceAssociationResponse
Associates the specified service with the specified service network.
-
#create_service_network_vpc_association(params = {}) ⇒ Types::CreateServiceNetworkVpcAssociationResponse
Associates a VPC with a service network.
-
#create_target_group(params = {}) ⇒ Types::CreateTargetGroupResponse
Creates a target group.
-
#delete_access_log_subscription(params = {}) ⇒ Struct
Deletes the specified access log subscription.
-
#delete_auth_policy(params = {}) ⇒ Struct
Deletes the specified auth policy.
-
#delete_listener(params = {}) ⇒ Struct
Deletes the specified listener.
-
#delete_resource_configuration(params = {}) ⇒ Struct
Deletes the specified resource configuration.
-
#delete_resource_endpoint_association(params = {}) ⇒ Types::DeleteResourceEndpointAssociationResponse
Disassociates the resource configuration from the resource VPC endpoint.
-
#delete_resource_gateway(params = {}) ⇒ Types::DeleteResourceGatewayResponse
Deletes the specified resource gateway.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the specified resource policy.
-
#delete_rule(params = {}) ⇒ Struct
Deletes a listener rule.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a service.
-
#delete_service_network(params = {}) ⇒ Struct
Deletes a service network.
-
#delete_service_network_resource_association(params = {}) ⇒ Types::DeleteServiceNetworkResourceAssociationResponse
Deletes the association between a service network and a resource configuration.
-
#delete_service_network_service_association(params = {}) ⇒ Types::DeleteServiceNetworkServiceAssociationResponse
Deletes the association between a service and a service network.
-
#delete_service_network_vpc_association(params = {}) ⇒ Types::DeleteServiceNetworkVpcAssociationResponse
Disassociates the VPC from the service network.
-
#delete_target_group(params = {}) ⇒ Types::DeleteTargetGroupResponse
Deletes a target group.
-
#deregister_targets(params = {}) ⇒ Types::DeregisterTargetsResponse
Deregisters the specified targets from the specified target group.
-
#get_access_log_subscription(params = {}) ⇒ Types::GetAccessLogSubscriptionResponse
Retrieves information about the specified access log subscription.
-
#get_auth_policy(params = {}) ⇒ Types::GetAuthPolicyResponse
Retrieves information about the auth policy for the specified service or service network.
-
#get_listener(params = {}) ⇒ Types::GetListenerResponse
Retrieves information about the specified listener for the specified service.
-
#get_resource_configuration(params = {}) ⇒ Types::GetResourceConfigurationResponse
Retrieves information about the specified resource configuration.
-
#get_resource_gateway(params = {}) ⇒ Types::GetResourceGatewayResponse
Retrieves information about the specified resource gateway.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves information about the specified resource policy.
-
#get_rule(params = {}) ⇒ Types::GetRuleResponse
Retrieves information about the specified listener rules.
-
#get_service(params = {}) ⇒ Types::GetServiceResponse
Retrieves information about the specified service.
-
#get_service_network(params = {}) ⇒ Types::GetServiceNetworkResponse
Retrieves information about the specified service network.
-
#get_service_network_resource_association(params = {}) ⇒ Types::GetServiceNetworkResourceAssociationResponse
Retrieves information about the specified association between a service network and a resource configuration.
-
#get_service_network_service_association(params = {}) ⇒ Types::GetServiceNetworkServiceAssociationResponse
Retrieves information about the specified association between a service network and a service.
-
#get_service_network_vpc_association(params = {}) ⇒ Types::GetServiceNetworkVpcAssociationResponse
Retrieves information about the specified association between a service network and a VPC.
-
#get_target_group(params = {}) ⇒ Types::GetTargetGroupResponse
Retrieves information about the specified target group.
-
#list_access_log_subscriptions(params = {}) ⇒ Types::ListAccessLogSubscriptionsResponse
Lists the access log subscriptions for the specified service network or service.
-
#list_listeners(params = {}) ⇒ Types::ListListenersResponse
Lists the listeners for the specified service.
-
#list_resource_configurations(params = {}) ⇒ Types::ListResourceConfigurationsResponse
Lists the resource configurations owned by or shared with this account.
-
#list_resource_endpoint_associations(params = {}) ⇒ Types::ListResourceEndpointAssociationsResponse
Lists the associations for the specified VPC endpoint.
-
#list_resource_gateways(params = {}) ⇒ Types::ListResourceGatewaysResponse
Lists the resource gateways that you own or that were shared with you.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists the rules for the specified listener.
-
#list_service_network_resource_associations(params = {}) ⇒ Types::ListServiceNetworkResourceAssociationsResponse
Lists the associations between a service network and a resource configuration.
-
#list_service_network_service_associations(params = {}) ⇒ Types::ListServiceNetworkServiceAssociationsResponse
Lists the associations between a service network and a service.
-
#list_service_network_vpc_associations(params = {}) ⇒ Types::ListServiceNetworkVpcAssociationsResponse
Lists the associations between a service network and a VPC.
-
#list_service_network_vpc_endpoint_associations(params = {}) ⇒ Types::ListServiceNetworkVpcEndpointAssociationsResponse
Lists the associations between a service network and a VPC endpoint.
-
#list_service_networks(params = {}) ⇒ Types::ListServiceNetworksResponse
Lists the service networks owned by or shared with this account.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services owned by the caller account or shared with the caller account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#list_target_groups(params = {}) ⇒ Types::ListTargetGroupsResponse
Lists your target groups.
-
#list_targets(params = {}) ⇒ Types::ListTargetsResponse
Lists the targets for the target group.
-
#put_auth_policy(params = {}) ⇒ Types::PutAuthPolicyResponse
Creates or updates the auth policy.
-
#put_resource_policy(params = {}) ⇒ Struct
Attaches a resource-based permission policy to a service or service network.
-
#register_targets(params = {}) ⇒ Types::RegisterTargetsResponse
Registers the targets with the target group.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_access_log_subscription(params = {}) ⇒ Types::UpdateAccessLogSubscriptionResponse
Updates the specified access log subscription.
-
#update_listener(params = {}) ⇒ Types::UpdateListenerResponse
Updates the specified listener for the specified service.
-
#update_resource_configuration(params = {}) ⇒ Types::UpdateResourceConfigurationResponse
Updates the specified resource configuration.
-
#update_resource_gateway(params = {}) ⇒ Types::UpdateResourceGatewayResponse
Updates the specified resource gateway.
-
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
Updates a specified rule for the listener.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Updates the specified service.
-
#update_service_network(params = {}) ⇒ Types::UpdateServiceNetworkResponse
Updates the specified service network.
-
#update_service_network_vpc_association(params = {}) ⇒ Types::UpdateServiceNetworkVpcAssociationResponse
Updates the service network and VPC association.
-
#update_target_group(params = {}) ⇒ Types::UpdateTargetGroupResponse
Updates the specified target group.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#batch_update_rule(params = {}) ⇒ Types::BatchUpdateRuleResponse
Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.
Required permissions: vpc-lattice:UpdateRule
For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.
586 587 588 589 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 586 def batch_update_rule(params = {}, = {}) req = build_request(:batch_update_rule, params) req.send_request() end |
#create_access_log_subscription(params = {}) ⇒ Types::CreateAccessLogSubscriptionResponse
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.
663 664 665 666 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 663 def create_access_log_subscription(params = {}, = {}) req = build_request(:create_access_log_subscription, params) req.send_request() end |
#create_listener(params = {}) ⇒ Types::CreateListenerResponse
Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.
766 767 768 769 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 766 def create_listener(params = {}, = {}) req = build_request(:create_listener, params) req.send_request() end |
#create_resource_configuration(params = {}) ⇒ Types::CreateResourceConfigurationResponse
Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.
901 902 903 904 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 901 def create_resource_configuration(params = {}, = {}) req = build_request(:create_resource_configuration, params) req.send_request() end |
#create_resource_gateway(params = {}) ⇒ Types::CreateResourceGatewayResponse
Creates a resource gateway.
979 980 981 982 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 979 def create_resource_gateway(params = {}, = {}) req = build_request(:create_resource_gateway, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1113 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
For more information, see Services in the Amazon VPC Lattice User Guide.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1203 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#create_service_network(params = {}) ⇒ Types::CreateServiceNetworkResponse
Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
For more information, see Service networks in the Amazon VPC Lattice User Guide.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1284 def create_service_network(params = {}, = {}) req = build_request(:create_service_network, params) req.send_request() end |
#create_service_network_resource_association(params = {}) ⇒ Types::CreateServiceNetworkResourceAssociationResponse
Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.
1344 1345 1346 1347 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1344 def create_service_network_resource_association(params = {}, = {}) req = build_request(:create_service_network_resource_association, params) req.send_request() end |
#create_service_network_service_association(params = {}) ⇒ Types::CreateServiceNetworkServiceAssociationResponse
Associates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.
You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.
You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.
As a result of this operation, the association is created in the service network account and the association owner account.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1423 def create_service_network_service_association(params = {}, = {}) req = build_request(:create_service_network_service_association, params) req.send_request() end |
#create_service_network_vpc_association(params = {}) ⇒ Types::CreateServiceNetworkVpcAssociationResponse
Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.
You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.
As a result of this operation, the association gets created in the service network account and the VPC owner account.
If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1515 def create_service_network_vpc_association(params = {}, = {}) req = build_request(:create_service_network_vpc_association, params) req.send_request() end |
#create_target_group(params = {}) ⇒ Types::CreateTargetGroupResponse
Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
For more information, see Target groups in the Amazon VPC Lattice User Guide.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1626 def create_target_group(params = {}, = {}) req = build_request(:create_target_group, params) req.send_request() end |
#delete_access_log_subscription(params = {}) ⇒ Struct
Deletes the specified access log subscription.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1648 def delete_access_log_subscription(params = {}, = {}) req = build_request(:delete_access_log_subscription, params) req.send_request() end |
#delete_auth_policy(params = {}) ⇒ Struct
Deletes the specified auth policy. If an auth is set to AWS_IAM
and
the auth policy is deleted, all requests are denied. If you are trying
to remove the auth policy completely, you must set the auth type to
NONE
. If auth is enabled on the resource, but no auth policy is set,
all requests are denied.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1674 def delete_auth_policy(params = {}, = {}) req = build_request(:delete_auth_policy, params) req.send_request() end |
#delete_listener(params = {}) ⇒ Struct
Deletes the specified listener.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1700 def delete_listener(params = {}, = {}) req = build_request(:delete_listener, params) req.send_request() end |
#delete_resource_configuration(params = {}) ⇒ Struct
Deletes the specified resource configuration.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1722 def delete_resource_configuration(params = {}, = {}) req = build_request(:delete_resource_configuration, params) req.send_request() end |
#delete_resource_endpoint_association(params = {}) ⇒ Types::DeleteResourceEndpointAssociationResponse
Disassociates the resource configuration from the resource VPC endpoint.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1759 def delete_resource_endpoint_association(params = {}, = {}) req = build_request(:delete_resource_endpoint_association, params) req.send_request() end |
#delete_resource_gateway(params = {}) ⇒ Types::DeleteResourceGatewayResponse
Deletes the specified resource gateway.
1793 1794 1795 1796 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1793 def delete_resource_gateway(params = {}, = {}) req = build_request(:delete_resource_gateway, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the specified resource policy.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1815 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule.
For more information, see Listener rules in the Amazon VPC Lattice User Guide.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1856 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.
1899 1900 1901 1902 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1899 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#delete_service_network(params = {}) ⇒ Struct
Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.
1930 1931 1932 1933 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1930 def delete_service_network(params = {}, = {}) req = build_request(:delete_service_network, params) req.send_request() end |
#delete_service_network_resource_association(params = {}) ⇒ Types::DeleteServiceNetworkResourceAssociationResponse
Deletes the association between a service network and a resource configuration.
1963 1964 1965 1966 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1963 def delete_service_network_resource_association(params = {}, = {}) req = build_request(:delete_service_network_resource_association, params) req.send_request() end |
#delete_service_network_service_association(params = {}) ⇒ Types::DeleteServiceNetworkServiceAssociationResponse
Deletes the association between a service and a service network. This operation fails if an association is still in progress.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 1996 def delete_service_network_service_association(params = {}, = {}) req = build_request(:delete_service_network_service_association, params) req.send_request() end |
#delete_service_network_vpc_association(params = {}) ⇒ Types::DeleteServiceNetworkVpcAssociationResponse
Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.
2030 2031 2032 2033 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2030 def delete_service_network_vpc_association(params = {}, = {}) req = build_request(:delete_service_network_vpc_association, params) req.send_request() end |
#delete_target_group(params = {}) ⇒ Types::DeleteTargetGroupResponse
Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2063 def delete_target_group(params = {}, = {}) req = build_request(:delete_target_group, params) req.send_request() end |
#deregister_targets(params = {}) ⇒ Types::DeregisterTargetsResponse
Deregisters the specified targets from the specified target group.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2108 def deregister_targets(params = {}, = {}) req = build_request(:deregister_targets, params) req.send_request() end |
#get_access_log_subscription(params = {}) ⇒ Types::GetAccessLogSubscriptionResponse
Retrieves information about the specified access log subscription.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2150 def get_access_log_subscription(params = {}, = {}) req = build_request(:get_access_log_subscription, params) req.send_request() end |
#get_auth_policy(params = {}) ⇒ Types::GetAuthPolicyResponse
Retrieves information about the auth policy for the specified service or service network.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2185 def get_auth_policy(params = {}, = {}) req = build_request(:get_auth_policy, params) req.send_request() end |
#get_listener(params = {}) ⇒ Types::GetListenerResponse
Retrieves information about the specified listener for the specified service.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2239 def get_listener(params = {}, = {}) req = build_request(:get_listener, params) req.send_request() end |
#get_resource_configuration(params = {}) ⇒ Types::GetResourceConfigurationResponse
Retrieves information about the specified resource configuration.
2301 2302 2303 2304 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2301 def get_resource_configuration(params = {}, = {}) req = build_request(:get_resource_configuration, params) req.send_request() end |
#get_resource_gateway(params = {}) ⇒ Types::GetResourceGatewayResponse
Retrieves information about the specified resource gateway.
2349 2350 2351 2352 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2349 def get_resource_gateway(params = {}, = {}) req = build_request(:get_resource_gateway, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.
2379 2380 2381 2382 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2379 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_rule(params = {}) ⇒ Types::GetRuleResponse
Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.
2450 2451 2452 2453 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2450 def get_rule(params = {}, = {}) req = build_request(:get_rule, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceResponse
Retrieves information about the specified service.
2501 2502 2503 2504 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2501 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#get_service_network(params = {}) ⇒ Types::GetServiceNetworkResponse
Retrieves information about the specified service network.
2545 2546 2547 2548 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2545 def get_service_network(params = {}, = {}) req = build_request(:get_service_network, params) req.send_request() end |
#get_service_network_resource_association(params = {}) ⇒ Types::GetServiceNetworkResourceAssociationResponse
Retrieves information about the specified association between a service network and a resource configuration.
2608 2609 2610 2611 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2608 def get_service_network_resource_association(params = {}, = {}) req = build_request(:get_service_network_resource_association, params) req.send_request() end |
#get_service_network_service_association(params = {}) ⇒ Types::GetServiceNetworkServiceAssociationResponse
Retrieves information about the specified association between a service network and a service.
2666 2667 2668 2669 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2666 def get_service_network_service_association(params = {}, = {}) req = build_request(:get_service_network_service_association, params) req.send_request() end |
#get_service_network_vpc_association(params = {}) ⇒ Types::GetServiceNetworkVpcAssociationResponse
Retrieves information about the specified association between a service network and a VPC.
2720 2721 2722 2723 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2720 def get_service_network_vpc_association(params = {}, = {}) req = build_request(:get_service_network_vpc_association, params) req.send_request() end |
#get_target_group(params = {}) ⇒ Types::GetTargetGroupResponse
Retrieves information about the specified target group.
2784 2785 2786 2787 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2784 def get_target_group(params = {}, = {}) req = build_request(:get_target_group, params) req.send_request() end |
#list_access_log_subscriptions(params = {}) ⇒ Types::ListAccessLogSubscriptionsResponse
Lists the access log subscriptions for the specified service network or service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2833 def list_access_log_subscriptions(params = {}, = {}) req = build_request(:list_access_log_subscriptions, params) req.send_request() end |
#list_listeners(params = {}) ⇒ Types::ListListenersResponse
Lists the listeners for the specified service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2880 2881 2882 2883 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2880 def list_listeners(params = {}, = {}) req = build_request(:list_listeners, params) req.send_request() end |
#list_resource_configurations(params = {}) ⇒ Types::ListResourceConfigurationsResponse
Lists the resource configurations owned by or shared with this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2935 def list_resource_configurations(params = {}, = {}) req = build_request(:list_resource_configurations, params) req.send_request() end |
#list_resource_endpoint_associations(params = {}) ⇒ Types::ListResourceEndpointAssociationsResponse
Lists the associations for the specified VPC endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2997 2998 2999 3000 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 2997 def list_resource_endpoint_associations(params = {}, = {}) req = build_request(:list_resource_endpoint_associations, params) req.send_request() end |
#list_resource_gateways(params = {}) ⇒ Types::ListResourceGatewaysResponse
Lists the resource gateways that you own or that were shared with you.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3046 3047 3048 3049 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3046 def list_resource_gateways(params = {}, = {}) req = build_request(:list_resource_gateways, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists the rules for the specified listener.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3097 3098 3099 3100 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3097 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_service_network_resource_associations(params = {}) ⇒ Types::ListServiceNetworkResourceAssociationsResponse
Lists the associations between a service network and a resource configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3160 3161 3162 3163 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3160 def list_service_network_resource_associations(params = {}, = {}) req = build_request(:list_service_network_resource_associations, params) req.send_request() end |
#list_service_network_service_associations(params = {}) ⇒ Types::ListServiceNetworkServiceAssociationsResponse
Lists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.
Every association in Amazon VPC Lattice has a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource is shared with another account, the association includes the local account ID as the prefix in the ARN.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3227 def list_service_network_service_associations(params = {}, = {}) req = build_request(:list_service_network_service_associations, params) req.send_request() end |
#list_service_network_vpc_associations(params = {}) ⇒ Types::ListServiceNetworkVpcAssociationsResponse
Lists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3283 3284 3285 3286 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3283 def list_service_network_vpc_associations(params = {}, = {}) req = build_request(:list_service_network_vpc_associations, params) req.send_request() end |
#list_service_network_vpc_endpoint_associations(params = {}) ⇒ Types::ListServiceNetworkVpcEndpointAssociationsResponse
Lists the associations between a service network and a VPC endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3331 3332 3333 3334 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3331 def list_service_network_vpc_endpoint_associations(params = {}, = {}) req = build_request(:list_service_network_vpc_endpoint_associations, params) req.send_request() end |
#list_service_networks(params = {}) ⇒ Types::ListServiceNetworksResponse
Lists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3376 3377 3378 3379 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3376 def list_service_networks(params = {}, = {}) req = build_request(:list_service_networks, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services owned by the caller account or shared with the caller account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3422 3423 3424 3425 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3422 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
3451 3452 3453 3454 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3451 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_target_groups(params = {}) ⇒ Types::ListTargetGroupsResponse
Lists your target groups. You can narrow your search by using the filters below in your request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3510 3511 3512 3513 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3510 def list_target_groups(params = {}, = {}) req = build_request(:list_target_groups, params) req.send_request() end |
#list_targets(params = {}) ⇒ Types::ListTargetsResponse
Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3565 3566 3567 3568 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3565 def list_targets(params = {}, = {}) req = build_request(:list_targets, params) req.send_request() end |
#put_auth_policy(params = {}) ⇒ Types::PutAuthPolicyResponse
Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.
For more information, see Auth policies in the Amazon VPC Lattice User Guide.
3609 3610 3611 3612 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3609 def put_auth_policy(params = {}, = {}) req = build_request(:put_auth_policy, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Struct
Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.
3640 3641 3642 3643 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3640 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#register_targets(params = {}) ⇒ Types::RegisterTargetsResponse
Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.
3686 3687 3688 3689 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3686 def register_targets(params = {}, = {}) req = build_request(:register_targets, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
3714 3715 3716 3717 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3714 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
3740 3741 3742 3743 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3740 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_log_subscription(params = {}) ⇒ Types::UpdateAccessLogSubscriptionResponse
Updates the specified access log subscription.
3780 3781 3782 3783 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3780 def update_access_log_subscription(params = {}, = {}) req = build_request(:update_access_log_subscription, params) req.send_request() end |
#update_listener(params = {}) ⇒ Types::UpdateListenerResponse
Updates the specified listener for the specified service.
3845 3846 3847 3848 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3845 def update_listener(params = {}, = {}) req = build_request(:update_listener, params) req.send_request() end |
#update_resource_configuration(params = {}) ⇒ Types::UpdateResourceConfigurationResponse
Updates the specified resource configuration.
3923 3924 3925 3926 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3923 def update_resource_configuration(params = {}, = {}) req = build_request(:update_resource_configuration, params) req.send_request() end |
#update_resource_gateway(params = {}) ⇒ Types::UpdateResourceGatewayResponse
Updates the specified resource gateway.
3971 3972 3973 3974 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 3971 def update_resource_gateway(params = {}, = {}) req = build_request(:update_resource_gateway, params) req.send_request() end |
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
Updates a specified rule for the listener. You can't modify a default
listener rule. To modify a default listener rule, use
UpdateListener
.
4080 4081 4082 4083 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 4080 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Updates the specified service.
4132 4133 4134 4135 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 4132 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |
#update_service_network(params = {}) ⇒ Types::UpdateServiceNetworkResponse
Updates the specified service network.
4176 4177 4178 4179 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 4176 def update_service_network(params = {}, = {}) req = build_request(:update_service_network, params) req.send_request() end |
#update_service_network_vpc_association(params = {}) ⇒ Types::UpdateServiceNetworkVpcAssociationResponse
Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and then recreate it without security groups.
4222 4223 4224 4225 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 4222 def update_service_network_vpc_association(params = {}, = {}) req = build_request(:update_service_network_vpc_association, params) req.send_request() end |
#update_target_group(params = {}) ⇒ Types::UpdateTargetGroupResponse
Updates the specified target group.
4292 4293 4294 4295 |
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/client.rb', line 4292 def update_target_group(params = {}, = {}) req = build_request(:update_target_group, params) req.send_request() end |