Client

vpclattice

R Documentation

Amazon VPC Lattice¶

Description¶

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

Usage¶

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.

Value¶

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_rule: Updates the listener rules in a batch
create_access_log_subscription: Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose
create_listener: Creates a listener for a service
create_rule: Creates a listener rule
create_service: Creates a service
create_service_network: Creates a service network; Associates a service with a service network; Associates a VPC with a service network
create_target_group: Creates a target group
delete_access_log_subscription: Deletes the specified access log subscription
delete_auth_policy: Deletes the specified auth policy
delete_listener: Deletes the specified listener
delete_resource_policy: Deletes the specified resource policy
delete_rule: Deletes a listener rule
delete_service: Deletes a service
delete_service_network: Deletes a service network; Deletes the association between a specified service and the specific service network; Disassociates the VPC from the service network
delete_target_group: Deletes a target group
deregister_targets: Deregisters the specified targets from the specified target group
get_access_log_subscription: Retrieves information about the specified access log subscription
get_auth_policy: Retrieves information about the auth policy for the specified service or service network
get_listener: Retrieves information about the specified listener for the specified service
get_resource_policy: Retrieves information about the resource policy
get_rule: Retrieves information about listener rules
get_service: Retrieves information about the specified service
get_service_network: Retrieves information about the specified service network; Retrieves information about the specified association between a service network and a service
get_service_network_vpc_association: Retrieves information about the association between a service network and a VPC
get_target_group: Retrieves information about the specified target group
list_access_log_subscriptions: Lists all access log subscriptions for the specified service network or service
list_listeners: Lists the listeners for the specified service
list_rules: Lists the rules for the listener
list_service_networks: Lists the service networks owned by the caller account or shared with the caller account; Lists the associations between the service network and the service
list_service_network_vpc_associations: Lists the service network and VPC associations
list_services: Lists the services owned by the caller account or shared with the caller account
list_tags_for_resource: Lists the tags for the specified resource
list_target_groups: Lists your target groups
list_targets: Lists the targets for the target group
put_auth_policy: Creates or updates the auth policy
put_resource_policy: Attaches a resource-based permission policy to a service or service network
register_targets: Registers the targets with the target group
tag_resource: Adds the specified tags to the specified resource
untag_resource: Removes the specified tags from the specified resource
update_access_log_subscription: Updates the specified access log subscription
update_listener: Updates the specified listener for the specified service
update_rule: Updates a rule for the listener
update_service: Updates the specified service
update_service_network: Updates the specified service network; Updates the service network and VPC association
update_target_group: Updates the specified target group

Examples¶

## Not run: 
svc <- vpclattice()
svc$batch_update_rule(
  Foo = 123
)

## End(Not run)