Proton / Client / create_environment_account_connection

create_environment_account_connection#

Proton.Client.create_environment_account_connection(**kwargs)#

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User guide.

See also: AWS API Documentation

Request Syntax

response = client.create_environment_account_connection(
    clientToken='string',
    codebuildRoleArn='string',
    componentRoleArn='string',
    environmentName='string',
    managementAccountId='string',
    roleArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • clientToken (string) –

    When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.

    This field is autopopulated if not provided.

  • codebuildRoleArn (string) – The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

  • componentRoleArn (string) –

    The Amazon Resource Name (ARN) of the IAM service role that 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.

    You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

    For more information about components, see Proton components in the Proton User Guide.

  • environmentName (string) –

    [REQUIRED]

    The name of the Proton environment that’s created in the associated management account.

  • managementAccountId (string) –

    [REQUIRED]

    The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

  • roleArn (string) – The Amazon Resource Name (ARN) of the IAM service role that’s created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.

  • tags (list) –

    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.

    • (dict) –

      A description of a resource tag.

      • key (string) – [REQUIRED]

        The key of the resource tag.

      • value (string) – [REQUIRED]

        The value of the resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'codebuildRoleArn': 'string',
        'componentRoleArn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

  • (dict) –

    • environmentAccountConnection (dict) –

      The environment account connection detail data that’s returned by Proton.

      • arn (string) –

        The Amazon Resource Name (ARN) of the environment account connection.

      • codebuildRoleArn (string) –

        The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

      • componentRoleArn (string) –

        The Amazon Resource Name (ARN) of the IAM service role that 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.

        The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

        For more information about components, see Proton components in the Proton User Guide.

      • environmentAccountId (string) –

        The environment account that’s connected to the environment account connection.

      • environmentName (string) –

        The name of the environment that’s associated with the environment account connection.

      • id (string) –

        The ID of the environment account connection.

      • lastModifiedAt (datetime) –

        The time when the environment account connection was last modified.

      • managementAccountId (string) –

        The ID of the management account that’s connected to the environment account connection.

      • requestedAt (datetime) –

        The time when the environment account connection request was made.

      • roleArn (string) –

        The IAM service role that’s associated with the environment account connection.

      • status (string) –

        The status of the environment account connection.

Exceptions