vpclattice function

Amazon VPC Lattice

Amazon VPC Lattice

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide

vpclattice( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- vpclattice(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

batch_update_ruleUpdates the listener rules in a batch
create_access_log_subscriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose
create_listenerCreates a listener for a service
create_resource_configurationCreates a resource configuration
create_resource_gatewayCreates a resource gateway
create_ruleCreates a listener rule
create_serviceCreates a service
create_service_networkCreates a service network
create_service_network_resource_associationAssociates the specified service network with the specified resource configuration
create_service_network_service_associationAssociates the specified service with the specified service network
create_service_network_vpc_associationAssociates a VPC with a service network
create_target_groupCreates a target group
delete_access_log_subscriptionDeletes the specified access log subscription
delete_auth_policyDeletes the specified auth policy
delete_listenerDeletes the specified listener
delete_resource_configurationDeletes the specified resource configuration
delete_resource_endpoint_associationDisassociates the resource configuration from the resource VPC endpoint
delete_resource_gatewayDeletes the specified resource gateway
delete_resource_policyDeletes the specified resource policy
delete_ruleDeletes a listener rule
delete_serviceDeletes a service
delete_service_networkDeletes a service network
delete_service_network_resource_associationDeletes the association between a service network and a resource configuration
delete_service_network_service_associationDeletes the association between a service and a service network
delete_service_network_vpc_associationDisassociates the VPC from the service network
delete_target_groupDeletes a target group
deregister_targetsDeregisters the specified targets from the specified target group
get_access_log_subscriptionRetrieves information about the specified access log subscription
get_auth_policyRetrieves information about the auth policy for the specified service or service network
get_listenerRetrieves information about the specified listener for the specified service
get_resource_configurationRetrieves information about the specified resource configuration
get_resource_gatewayRetrieves information about the specified resource gateway
get_resource_policyRetrieves information about the specified resource policy
get_ruleRetrieves information about the specified listener rules
get_serviceRetrieves information about the specified service
get_service_networkRetrieves information about the specified service network
get_service_network_resource_associationRetrieves information about the specified association between a service network and a resource configuration
get_service_network_service_associationRetrieves information about the specified association between a service network and a service
get_service_network_vpc_associationRetrieves information about the specified association between a service network and a VPC
get_target_groupRetrieves information about the specified target group
list_access_log_subscriptionsLists the access log subscriptions for the specified service network or service
list_listenersLists the listeners for the specified service
list_resource_configurationsLists the resource configurations owned by or shared with this account
list_resource_endpoint_associationsLists the associations for the specified VPC endpoint
list_resource_gatewaysLists the resource gateways that you own or that were shared with you
list_rulesLists the rules for the specified listener
list_service_network_resource_associationsLists the associations between a service network and a resource configuration
list_service_networksLists the service networks owned by or shared with this account
list_service_network_service_associationsLists the associations between a service network and a service
list_service_network_vpc_associationsLists the associations between a service network and a VPC
list_service_network_vpc_endpoint_associationsLists the associations between a service network and a VPC endpoint
list_servicesLists the services owned by the caller account or shared with the caller account
list_tags_for_resourceLists the tags for the specified resource
list_target_groupsLists your target groups
list_targetsLists the targets for the target group
put_auth_policyCreates or updates the auth policy
put_resource_policyAttaches a resource-based permission policy to a service or service network
register_targetsRegisters the targets with the target group
tag_resourceAdds the specified tags to the specified resource
untag_resourceRemoves the specified tags from the specified resource
update_access_log_subscriptionUpdates the specified access log subscription
update_listenerUpdates the specified listener for the specified service
update_resource_configurationUpdates the specified resource configuration
update_resource_gatewayUpdates the specified resource gateway
update_ruleUpdates a specified rule for the listener
update_serviceUpdates the specified service
update_service_networkUpdates the specified service network
update_service_network_vpc_associationUpdates the service network and VPC association
update_target_groupUpdates the specified target group

Examples

## Not run: svc <- vpclattice() svc$batch_update_rule( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17