Client

route53profiles

R Documentation

Route 53 Profiles¶

Description¶

With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts

Usage¶

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

associate_profile: Associates a Route 53 Profiles profile with a VPC
associate_resource_to_profile: Associates a DNS reource configuration to a Route 53 Profile
create_profile: Creates an empty Route 53 Profile
delete_profile: Deletes the specified Route 53 Profile
disassociate_profile: Dissociates a specified Route 53 Profile from the specified VPC
disassociate_resource_from_profile: Dissoaciated a specified resource, from the Route 53 Profile
get_profile: Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile
get_profile_association: Retrieves a Route 53 Profile association for a VPC
get_profile_resource_association: Returns information about a specified Route 53 Profile resource association
list_profile_associations: Lists all the VPCs that the specified Route 53 Profile is associated with
list_profile_resource_associations: Lists all the resource associations for the specified Route 53 Profile
list_profiles: Lists all the Route 53 Profiles associated with your Amazon Web Services account
list_tags_for_resource: Lists the tags that you associated with the specified resource
tag_resource: Adds one or more tags to a specified resource
untag_resource: Removes one or more tags from a specified resource
update_profile_resource_association: Updates the specified Route 53 Profile resourse association

Examples¶

## Not run: 
svc <- route53profiles()
svc$associate_profile(
  Foo = 123
)

## End(Not run)