environment_account_connections

Creates, updates, deletes or gets an environment_account_connection resource or lists environment_account_connections in a region

Overview

Name	environment_account_connections
Type	Resource
Description	Resource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id	aws.proton.environment_account_connections

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the environment account connection.
codebuild_role_arn	string	The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
component_role_arn	string	The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
environment_account_id	string	The environment account that's connected to the environment account connection.
environment_name	string	The name of the AWS Proton environment that's created in the associated management account.
id	string	The ID of the environment account connection.
management_account_id	string	The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
role_arn	string	The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
status	string	The status of the environment account connection.
tags	array	An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair. For more information, see Proton resources and tagging in the Proton User Guide.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all environment_account_connections in a region.

SELECT
region,
arn,
codebuild_role_arn,
component_role_arn,
environment_account_id,
environment_name,
id,
management_account_id,
role_arn,
status,
tags
FROM aws.proton.environment_account_connections
WHERE region = 'us-east-1';

Gets all properties from an individual environment_account_connection.

SELECT
region,
arn,
codebuild_role_arn,
component_role_arn,
environment_account_id,
environment_name,
id,
management_account_id,
role_arn,
status,
tags
FROM aws.proton.environment_account_connections
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new environment_account_connection resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.proton.environment_account_connections (
 CodebuildRoleArn,
 ComponentRoleArn,
 EnvironmentAccountId,
 EnvironmentName,
 ManagementAccountId,
 RoleArn,
 Tags,
 region
)
SELECT 
'{{ CodebuildRoleArn }}',
 '{{ ComponentRoleArn }}',
 '{{ EnvironmentAccountId }}',
 '{{ EnvironmentName }}',
 '{{ ManagementAccountId }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.proton.environment_account_connections (
 CodebuildRoleArn,
 ComponentRoleArn,
 EnvironmentAccountId,
 EnvironmentName,
 ManagementAccountId,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ CodebuildRoleArn }}',
 '{{ ComponentRoleArn }}',
 '{{ EnvironmentAccountId }}',
 '{{ EnvironmentName }}',
 '{{ ManagementAccountId }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment_account_connection
    props:
      - name: CodebuildRoleArn
        value: '{{ CodebuildRoleArn }}'
      - name: ComponentRoleArn
        value: '{{ ComponentRoleArn }}'
      - name: EnvironmentAccountId
        value: '{{ EnvironmentAccountId }}'
      - name: EnvironmentName
        value: '{{ EnvironmentName }}'
      - name: ManagementAccountId
        value: '{{ ManagementAccountId }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.proton.environment_account_connections
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the environment_account_connections resource, the following permissions are required:

Create

proton:CreateEnvironmentAccountConnection,
proton:TagResource,
iam:PassRole,
proton:ListTagsForResource,
proton:GetEnvironmentAccountConnection

Read

proton:GetEnvironmentAccountConnection,
proton:ListTagsForResource,
iam:PassRole,
proton:GetEnvironmentAccountConnection

Update

proton:CreateEnvironmentAccountConnection,
proton:ListTagsForResource,
proton:TagResource,
proton:UntagResource,
proton:UpdateEnvironmentAccountConnection,
iam:PassRole,
proton:GetEnvironmentAccountConnection

Delete

proton:DeleteEnvironmentAccountConnection,
proton:UntagResource,
iam:PassRole,
proton:ListTagsForResource,
proton:GetEnvironmentAccountConnection

List

proton:ListEnvironmentAccountConnections