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 . apprunner ]



Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--connection-name (string)

A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

--provider-type (string)

The source repository provider.

Possible values:


--tags (list)

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.


Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--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.


To create a GitHub connection

The following create-connection example creates a connection to a private GitHub code repository. The connection status after a successful call is PENDING_HANDSHAKE. This is because an authentication handshake with the provider still hasn't happened. Complete the handshake using the App Runner console.

aws apprunner create-connection \
    --cli-input-json file://input.json

Contents of input.json:

    "ConnectionName": "my-github-connection",
    "ProviderType": "GITHUB"


    "Connection": {
        "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection",
        "ConnectionName": "my-github-connection",
        "Status": "PENDING_HANDSHAKE",
        "CreatedAt": "2020-11-03T00:32:51Z",
        "ProviderType": "GITHUB"

For more information, see Managing App Runner connections in the AWS App Runner Developer Guide.


Connection -> (structure)

A description of the App Runner connection that's created by this request.

ConnectionName -> (string)

The customer-provided connection name.

ConnectionArn -> (string)

The Amazon Resource Name (ARN) of this connection.

ProviderType -> (string)

The source repository provider.

Status -> (string)

The current state of the App Runner connection. When the state is AVAILABLE , you can use the connection to create an App Runner service.

CreatedAt -> (timestamp)

The App Runner connection creation time, expressed as a Unix time stamp.