[ aws . proton ]

create-environment-account-connection

Description

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 AWS Proton Administrator guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-environment-account-connection
[--client-token <value>]
--environment-name <value>
--management-account-id <value>
--role-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

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

--environment-name (string)

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

--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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

environmentAccountConnection -> (structure)

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

arn -> (string)

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

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 -> (timestamp)

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 -> (timestamp)

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.