Client

directconnect

R Documentation

AWS Direct Connect¶

Description¶

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

Usage¶

directconnect(
  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 <- directconnect(
  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¶

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway
allocate_connection_on_interconnect: Deprecated
allocate_hosted_connection: Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects
allocate_private_virtual_interface: Provisions a private virtual interface to be owned by the specified Amazon Web Services account
allocate_public_virtual_interface: Provisions a public virtual interface to be owned by the specified Amazon Web Services account
allocate_transit_virtual_interface: Provisions a transit virtual interface to be owned by the specified Amazon Web Services account
associate_connection_with_lag: Associates an existing connection with a link aggregation group (LAG)
associate_hosted_connection: Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect
associate_mac_sec_key: Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection
associate_virtual_interface: Associates a virtual interface with a specified link aggregation group (LAG) or connection
confirm_connection: Confirms the creation of the specified hosted connection on an interconnect
confirm_customer_agreement: The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG)
confirm_private_virtual_interface: Accepts ownership of a private virtual interface created by another Amazon Web Services account
confirm_public_virtual_interface: Accepts ownership of a public virtual interface created by another Amazon Web Services account
confirm_transit_virtual_interface: Accepts ownership of a transit virtual interface created by another Amazon Web Services account
create_bgp_peer: Creates a BGP peer on the specified virtual interface
create_connection: Creates a connection between a customer network and a specific Direct Connect location
create_direct_connect_gateway: Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways; Creates an association between a Direct Connect gateway and a virtual private gateway; Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway
create_interconnect: Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location
create_lag: Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location
create_private_virtual_interface: Creates a private virtual interface
create_public_virtual_interface: Creates a public virtual interface
create_transit_virtual_interface: Creates a transit virtual interface
delete_bgp_peer: Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN
delete_connection: Deletes the specified connection
delete_direct_connect_gateway: Deletes the specified Direct Connect gateway; Deletes the association between the specified Direct Connect gateway and virtual private gateway; Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway
delete_interconnect: Deletes the specified interconnect
delete_lag: Deletes the specified link aggregation group (LAG)
delete_virtual_interface: Deletes a virtual interface
describe_connection_loa: Deprecated
describe_connections: Displays the specified connection or all connections in this Region
describe_connections_on_interconnect: Deprecated
describe_customer_metadata: Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner; Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway; Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways; Lists the attachments between your Direct Connect gateways and virtual interfaces
describe_direct_connect_gateways: Lists all your Direct Connect gateways or only the specified Direct Connect gateway
describe_hosted_connections: Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG)
describe_interconnect_loa: Deprecated
describe_interconnects: Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect
describe_lags: Describes all your link aggregation groups (LAG) or the specified LAG
describe_loa: Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG)
describe_locations: Lists the Direct Connect locations in the current Amazon Web Services Region
describe_router_configuration: Details about the router
describe_tags: Describes the tags associated with the specified Direct Connect resources
describe_virtual_gateways: Lists the virtual private gateways owned by the Amazon Web Services account
describe_virtual_interfaces: Displays all virtual interfaces for an Amazon Web Services account
disassociate_connection_from_lag: Disassociates a connection from a link aggregation group (LAG)
disassociate_mac_sec_key: Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection
list_virtual_interface_test_history: Lists the virtual interface failover test history
start_bgp_failover_test: Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state
stop_bgp_failover_test: Stops the virtual interface failover test
tag_resource: Adds the specified tags to the specified Direct Connect resource
untag_resource: Removes one or more tags from the specified Direct Connect resource
update_connection: Updates the Direct Connect dedicated connection configuration
update_direct_connect_gateway: Updates the name of a current Direct Connect gateway; Updates the specified attributes of the Direct Connect gateway association
update_lag: Updates the attributes of the specified link aggregation group (LAG)
update_virtual_interface_attributes: Updates the specified attributes of the specified virtual private interface

Examples¶

## Not run: 
svc <- directconnect()
svc$accept_direct_connect_gateway_association_proposal(
  Foo = 123
)

## End(Not run)