connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	aws.apprunner.connections

Fields

The following fields are returned by SELECT queries:

list_connections

Name	Datatype	Description
connection_summary_list	array	A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each call.
next_token	string	The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connections	select	region		Returns a list of App Runner connections that are associated with your Amazon Web Services account.
create_connection	insert	region, ConnectionName, ProviderType		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 and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.
delete_connection	delete	region		Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_connections

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

SELECT
connection_summary_list,
next_token
FROM aws.apprunner.connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connection

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 and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.

INSERT INTO aws.apprunner.connections (
ConnectionName,
ProviderType,
Tags,
region
)
SELECT 
'{{ ConnectionName }}' /* required */,
'{{ ProviderType }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
connection
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connections resource.
  - name: ConnectionName
    value: "{{ ConnectionName }}"
    description: |
      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.
  - name: ProviderType
    value: "{{ ProviderType }}"
    description: |
      The source repository provider.
    valid_values: ['GITHUB', 'BITBUCKET']
  - name: Tags
    description: |
      A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_connection

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

DELETE FROM aws.apprunner.connections
WHERE region = '{{ region }}' --required
;