Client

codestarconnections

R Documentation

AWS CodeStar connections¶

Description¶

AWS CodeStar Connections

This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the Amazon Web Services CodeStar Connections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect Amazon Web Services resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

create_connection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.
delete_connection, which deletes the specified connection.
get_connection, which returns information about the connection, including the connection status.
list_connections, which lists the connections associated with your account.

You can work with hosts by calling:

create_host, which creates a host that represents the infrastructure where your provider is installed.
delete_host, which deletes the specified host.
get_host, which returns information about the host, including the setup status.
list_hosts, which lists the hosts associated with your account.

You can work with tags in Amazon Web Services CodeStar Connections by calling the following:

list_tags_for_resource, which gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections.
tag_resource, which adds or updates tags for a resource in Amazon Web Services CodeStar Connections.
untag_resource, which removes tags for a resource in Amazon Web Services CodeStar Connections.

For information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User Guide.

Usage¶

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

create_connection: Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories
create_host: Creates a resource that represents the infrastructure where a third-party provider is installed
create_repository_link: Creates a link to a specified external Git repository
create_sync_configuration: Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource
delete_connection: The connection to be deleted
delete_host: The host to be deleted
delete_repository_link: Deletes the association between your connection and a specified external Git repository
delete_sync_configuration: Deletes the sync configuration for a specified repository and connection
get_connection: Returns the connection ARN and details such as status, owner, and provider type
get_host: Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration
get_repository_link: Returns details about a repository link
get_repository_sync_status: Returns details about the sync status for a repository
get_resource_sync_status: Returns the status of the sync with the Git repository for a specific Amazon Web Services resource
get_sync_blocker_summary: Returns a list of the most recent sync blockers
get_sync_configuration: Returns details about a sync configuration, including the sync type and resource name
list_connections: Lists the connections associated with your account
list_hosts: Lists the hosts associated with your account
list_repository_links: Lists the repository links created for connections in your account
list_repository_sync_definitions: Lists the repository sync definitions for repository links in your account
list_sync_configurations: Returns a list of sync configurations for a specified repository
list_tags_for_resource: Gets the set of key-value pairs (metadata) that are used to manage the resource
tag_resource: Adds to or modifies the tags of the given resource
untag_resource: Removes tags from an Amazon Web Services resource
update_host: Updates a specified host with the provided configurations
update_repository_link: Updates the association between your connection and a specified external Git repository
update_sync_blocker: Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue
update_sync_configuration: Updates the sync configuration for your connection and a specified external Git repository

Examples¶

## Not run: 
svc <- codestarconnections()
svc$create_connection(
  Foo = 123
)

## End(Not run)