external_connections

Creates, updates, deletes, gets or lists an external_connections resource.

Overview

Name	external_connections
Type	Resource
Id	aws.codeartifact.external_connections

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
associate_external_connection	update	domain, repository, external-connection, region	domain-owner	Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection.
disassociate_external_connection	exec	domain, repository, external-connection, region	domain-owner	Removes an existing external connection from a repository.

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
domain	string	The name of the domain that contains the repository from which to remove the external repository.
external-connection	string	The name of the external connection to be removed from the repository.
region	string	AWS region (default: us-east-1)
repository	string	The name of the repository from which the external connection will be removed.
domain-owner	string	The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

UPDATE examples

associate_external_connection

Adds an existing external connection to a repository. One external connection is allowed per repository. A repository can have one or more upstream repositories, or an external connection.

UPDATE aws.codeartifact.external_connections
SET 
-- No updatable properties
WHERE 
domain = '{{ domain }}' --required
AND repository = '{{ repository }}' --required
AND `external-connection` = '{{ external-connection }}' --required
AND region = '{{ region }}' --required
AND `domain-owner` = '{{ domain-owner}}'
RETURNING
repository;

Lifecycle Methods

disassociate_external_connection

Removes an existing external connection from a repository.

EXEC aws.codeartifact.external_connections.disassociate_external_connection 
@domain='{{ domain }}' --required, 
@repository='{{ repository }}' --required, 
@external-connection='{{ external-connection }}' --required, 
@region='{{ region }}' --required, 
@domain-owner='{{ domain-owner }}'
;