Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codestar-connections ]

create-connection

Description

Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-connection
[--provider-type <value>]
--connection-name <value>
[--tags <value>]
[--host-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--provider-type (string)

The name of the external provider where your third-party code repository is configured.

Possible values:

  • Bitbucket
  • GitHub
  • GitHubEnterpriseServer

--connection-name (string)

The name of the connection to be created. The name must be unique in the calling AWS account.

--tags (list)

The key-value pair to use when tagging the resource.

(structure)

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by AWS services that support tags.

Key -> (string)

The tag's key.

Value -> (string)

The tag's value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--host-arn (string)

The Amazon Resource Name (ARN) of the host associated with the connection to be created.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a connection

The following create-connection example shows how to create a connection to a third-party repository. This example creates a connection where the third-party provider is Bitbucket.

A connection created through the AWS CLI or AWS CloudFormation is in Pending status by default. After you create a connection with the CLI or AWS CloudFormation, use the console to edit the connection to make its status Available.

aws codestar-connections create-connection \
    --provider-type Bitbucket \
    --connection-name MyConnection

Output:

{
    "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}

For more information, see Create a connection in the Developer Tools console User Guide.

Output

ConnectionArn -> (string)

The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services.

Note

The ARN is never reused if the connection is deleted.

Tags -> (list)

Specifies the tags applied to the resource.

(structure)

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by AWS services that support tags.

Key -> (string)

The tag's key.

Value -> (string)

The tag's value.