account_settings

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

Overview

Name	account_settings
Type	Resource
Id	aws.proton.account_settings

Fields

The following fields are returned by SELECT queries:

get_account_settings

Name	Datatype	Description
pipeline_codebuild_role_arn	string	The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning. (pattern: <code>(^$)|(^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$)</code>)
pipeline_provisioning_repository	object	The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
pipeline_service_role_arn	string	The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning. (pattern: <code>(^$)|(^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_settings	select	region		Get detail data for Proton account-wide settings.
update_account_settings	update	region		Update Proton settings that are used for multiple services in the Amazon Web Services account.

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_account_settings

Get detail data for Proton account-wide settings.

SELECT
pipeline_codebuild_role_arn,
pipeline_provisioning_repository,
pipeline_service_role_arn
FROM aws.proton.account_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_settings

Update Proton settings that are used for multiple services in the Amazon Web Services account.

UPDATE aws.proton.account_settings
SET 
deletePipelineProvisioningRepository = {{ deletePipelineProvisioningRepository }},
pipelineCodebuildRoleArn = '{{ pipelineCodebuildRoleArn }}',
pipelineProvisioningRepository = '{{ pipelineProvisioningRepository }}',
pipelineServiceRoleArn = '{{ pipelineServiceRoleArn }}'
WHERE 
region = '{{ region }}' --required
RETURNING
account_settings;