connection_preferences

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

Overview

Name	connection_preferences
Type	Resource
Id	aws.partnercentral_account.connection_preferences

Fields

The following fields are returned by SELECT queries:

get_connection_preferences

Name	Datatype	Description
access_type	string	The access type setting for connections (e.g., open, restricted, invitation-only). (ALLOW_ALL, DENY_ALL, ALLOW_BY_DEFAULT_DENY_SOME)
arn	string	The Amazon Resource Name (ARN) of the connection preferences. (pattern: <code>arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9-]*:[0-9]{12}:catalog/[a-zA-Z]+/connection-preferences</code>)
catalog	string	The catalog identifier for the partner account. (pattern: <code>[a-zA-Z0-9-]+</code>)
excluded_participant_ids	array	A list of participant IDs that are excluded from connection requests or interactions.
revision	integer (int64)	The revision number of the connection preferences for optimistic locking.
updated_at	string (date-time)	The timestamp when the connection preferences were last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection_preferences	select	region		Retrieves the connection preferences for a partner account, including access settings and exclusions.
update_connection_preferences	update	region, AccessType		Updates the connection preferences for a partner account, modifying access settings and exclusions.

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

get_connection_preferences

Retrieves the connection preferences for a partner account, including access settings and exclusions.

SELECT
access_type,
arn,
catalog,
excluded_participant_ids,
revision,
updated_at
FROM aws.partnercentral_account.connection_preferences
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_connection_preferences

Updates the connection preferences for a partner account, modifying access settings and exclusions.

UPDATE aws.partnercentral_account.connection_preferences
SET 
Catalog = '{{ Catalog }}',
Revision = {{ Revision }},
AccessType = '{{ AccessType }}',
ExcludedParticipantIdentifiers = '{{ ExcludedParticipantIdentifiers }}'
WHERE 
region = '{{ region }}' --required
AND AccessType = '{{ AccessType }}' --required
RETURNING
access_type,
arn,
catalog,
excluded_participant_ids,
revision,
updated_at;